From 6d1683b43012f61bf6733beb5f43a2bde5033467 Mon Sep 17 00:00:00 2001 From: philip-ellis-sp Date: Fri, 26 Jun 2026 16:15:35 -0400 Subject: [PATCH 1/2] added docs to generation --- Makefile | 2 +- package.json | 3 +- .../.openapi-generator/FILES | 42 +++++ sdk-output/access_model_metadata/README.md | 46 ------ .../access_profiles/.openapi-generator/FILES | 42 +++++ sdk-output/access_profiles/README.md | 46 ------ .../.openapi-generator/FILES | 41 +++++ sdk-output/access_request_approvals/README.md | 46 ------ .../.openapi-generator/FILES | 9 ++ .../access_request_identity_metrics/README.md | 46 ------ .../access_requests/.openapi-generator/FILES | 81 ++++++++++ sdk-output/access_requests/README.md | 46 ------ .../.openapi-generator/FILES | 20 +++ sdk-output/account_activities/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/account_aggregations/README.md | 46 ------ .../.openapi-generator/FILES | 24 +++ .../account_deletion_requests/README.md | 46 ------ .../account_usages/.openapi-generator/FILES | 10 ++ sdk-output/account_usages/README.md | 46 ------ sdk-output/accounts/.openapi-generator/FILES | 35 ++++ sdk-output/accounts/README.md | 46 ------ sdk-output/api_usage/.openapi-generator/FILES | 10 ++ sdk-output/api_usage/README.md | 46 ------ .../.openapi-generator/FILES | 26 +++ sdk-output/application_discovery/README.md | 46 ------ sdk-output/approvals/.openapi-generator/FILES | 42 +++++ sdk-output/approvals/README.md | 46 ------ sdk-output/apps/.openapi-generator/FILES | 33 ++++ sdk-output/apps/README.md | 46 ------ .../auth_profile/.openapi-generator/FILES | 14 ++ sdk-output/auth_profile/README.md | 46 ------ .../auth_users/.openapi-generator/FILES | 13 ++ sdk-output/auth_users/README.md | 46 ------ sdk-output/branding/.openapi-generator/FILES | 11 ++ sdk-output/branding/README.md | 46 ------ .../.openapi-generator/FILES | 14 ++ .../certification_campaign_filters/README.md | 46 ------ .../.openapi-generator/FILES | 46 ++++++ sdk-output/certification_campaigns/README.md | 46 ------ .../.openapi-generator/FILES | 25 +++ sdk-output/certification_summaries/README.md | 46 ------ .../certifications/.openapi-generator/FILES | 39 +++++ sdk-output/certifications/README.md | 46 ------ .../classify_source/.openapi-generator/FILES | 12 ++ sdk-output/classify_source/README.md | 46 ------ .../.openapi-generator/FILES | 35 ++++ sdk-output/configuration_hub/README.md | 46 ------ .../.openapi-generator/FILES | 15 ++ sdk-output/connector_customizers/README.md | 46 ------ .../.openapi-generator/FILES | 17 ++ .../connector_rule_management/README.md | 46 ------ .../connectors/.openapi-generator/FILES | 19 +++ sdk-output/connectors/README.md | 46 ------ .../custom_forms/.openapi-generator/FILES | 43 +++++ sdk-output/custom_forms/README.md | 46 ------ .../.openapi-generator/FILES | 8 + .../custom_password_instructions/README.md | 46 ------ .../.openapi-generator/FILES | 25 +++ sdk-output/custom_user_levels/README.md | 46 ------ .../.openapi-generator/FILES | 35 ++++ sdk-output/data_access_security/README.md | 46 ------ .../.openapi-generator/FILES | 21 +++ sdk-output/data_segmentation/README.md | 46 ------ .../.openapi-generator/FILES | 9 ++ sdk-output/declassify_source/README.md | 46 ------ .../dimensions/.openapi-generator/FILES | 47 ++++++ sdk-output/dimensions/README.md | 46 ------ .../.openapi-generator/FILES | 19 +++ sdk-output/entitlement_connections/README.md | 46 ------ .../entitlements/.openapi-generator/FILES | 34 ++++ sdk-output/entitlements/README.md | 46 ------ .../.openapi-generator/FILES | 21 +++ .../global_tenant_security_settings/README.md | 46 ------ .../.openapi-generator/FILES | 25 +++ sdk-output/governance_groups/README.md | 46 ------ .../.openapi-generator/FILES | 18 +++ .../README.md | 46 ------ .../.openapi-generator/FILES | 16 ++ sdk-output/iai_common_access/README.md | 46 ------ .../iai_outliers/.openapi-generator/FILES | 19 +++ sdk-output/iai_outliers/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ .../iai_peer_group_strategies/README.md | 46 ------ .../.openapi-generator/FILES | 19 +++ sdk-output/iai_recommendations/README.md | 46 ------ .../iai_role_mining/.openapi-generator/FILES | 45 ++++++ sdk-output/iai_role_mining/README.md | 46 ------ sdk-output/icons/.openapi-generator/FILES | 11 ++ sdk-output/icons/README.md | 46 ------ .../identities/.openapi-generator/FILES | 48 ++++++ sdk-output/identities/README.md | 46 ------ .../.openapi-generator/FILES | 12 ++ sdk-output/identity_attributes/README.md | 46 ------ .../identity_history/.openapi-generator/FILES | 39 +++++ sdk-output/identity_history/README.md | 46 ------ .../.openapi-generator/FILES | 30 ++++ sdk-output/identity_profiles/README.md | 46 ------ .../jit_access/.openapi-generator/FILES | 12 ++ sdk-output/jit_access/README.md | 46 ------ .../jit_activations/.openapi-generator/FILES | 16 ++ sdk-output/jit_activations/README.md | 46 ------ sdk-output/launchers/.openapi-generator/FILES | 16 ++ sdk-output/launchers/README.md | 46 ------ .../lifecycle_states/.openapi-generator/FILES | 20 +++ sdk-output/lifecycle_states/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/machine_account_classify/README.md | 46 ------ .../.openapi-generator/FILES | 19 +++ .../README.md | 46 ------ .../.openapi-generator/FILES | 15 ++ sdk-output/machine_account_mappings/README.md | 46 ------ .../.openapi-generator/FILES | 19 +++ sdk-output/machine_account_subtypes/README.md | 46 ------ .../machine_accounts/.openapi-generator/FILES | 13 ++ sdk-output/machine_accounts/README.md | 46 ------ .../.openapi-generator/FILES | 14 ++ .../machine_classification_config/README.md | 46 ------ .../.openapi-generator/FILES | 29 ++++ sdk-output/machine_identities/README.md | 46 ------ .../managed_clients/.openapi-generator/FILES | 22 +++ sdk-output/managed_clients/README.md | 46 ------ .../.openapi-generator/FILES | 14 ++ sdk-output/managed_cluster_types/README.md | 46 ------ .../managed_clusters/.openapi-generator/FILES | 35 ++++ sdk-output/managed_clusters/README.md | 46 ------ .../.openapi-generator/FILES | 15 ++ sdk-output/mfa_configuration/README.md | 46 ------ .../.openapi-generator/FILES | 36 +++++ sdk-output/multi_host_integration/README.md | 46 ------ .../.openapi-generator/FILES | 41 +++++ .../README.md | 46 ------ .../notifications/.openapi-generator/FILES | 32 ++++ sdk-output/notifications/README.md | 46 ------ .../oauth_clients/.openapi-generator/FILES | 18 +++ sdk-output/oauth_clients/README.md | 46 ------ .../org_config/.openapi-generator/FILES | 14 ++ sdk-output/org_config/README.md | 46 ------ .../.openapi-generator/FILES | 16 ++ sdk-output/parameter_storage/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/password_configuration/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/password_dictionary/README.md | 46 ------ .../.openapi-generator/FILES | 17 ++ sdk-output/password_management/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/password_policies/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ sdk-output/password_sync_groups/README.md | 46 ------ .../.openapi-generator/FILES | 16 ++ sdk-output/personal_access_tokens/README.md | 46 ------ .../.openapi-generator/FILES | 15 ++ sdk-output/privilege_criteria/README.md | 46 ------ .../.openapi-generator/FILES | 10 ++ .../README.md | 46 ------ .../prompt_insights/.openapi-generator/FILES | 11 ++ sdk-output/prompt_insights/README.md | 46 ------ .../.openapi-generator/FILES | 13 ++ sdk-output/public_identities/README.md | 46 ------ .../.openapi-generator/FILES | 13 ++ sdk-output/public_identities_config/README.md | 46 ------ .../.openapi-generator/FILES | 23 +++ sdk-output/reports_data_extraction/README.md | 46 ------ .../.openapi-generator/FILES | 13 ++ sdk-output/requestable_objects/README.md | 46 ------ .../role_insights/.openapi-generator/FILES | 17 ++ sdk-output/role_insights/README.md | 46 ------ .../role_propagation/.openapi-generator/FILES | 17 ++ sdk-output/role_propagation/README.md | 46 ------ sdk-output/roles/.openapi-generator/FILES | 58 +++++++ sdk-output/roles/README.md | 46 ------ .../saved_search/.openapi-generator/FILES | 23 +++ sdk-output/saved_search/README.md | 46 ------ .../scheduled_search/.openapi-generator/FILES | 24 +++ sdk-output/scheduled_search/README.md | 46 ------ sdk-output/search/.openapi-generator/FILES | 33 ++++ sdk-output/search/README.md | 46 ------ .../.openapi-generator/FILES | 13 ++ .../search_attribute_configuration/README.md | 46 ------ sdk-output/segments/.openapi-generator/FILES | 16 ++ sdk-output/segments/README.md | 46 ------ .../.openapi-generator/FILES | 23 +++ sdk-output/service_desk_integration/README.md | 46 ------ .../.openapi-generator/FILES | 26 +++ .../shared_signals_framework_ssf/README.md | 46 ------ .../sim_integrations/.openapi-generator/FILES | 24 +++ sdk-output/sim_integrations/README.md | 46 ------ .../sod_policies/.openapi-generator/FILES | 32 ++++ sdk-output/sod_policies/README.md | 46 ------ .../sod_violations/.openapi-generator/FILES | 21 +++ sdk-output/sod_violations/README.md | 46 ------ .../source_usages/.openapi-generator/FILES | 11 ++ sdk-output/source_usages/README.md | 46 ------ sdk-output/sources/.openapi-generator/FILES | 89 ++++++++++ sdk-output/sources/README.md | 46 ------ sdk-output/sp_config/.openapi-generator/FILES | 29 ++++ sdk-output/sp_config/README.md | 46 ------ .../.openapi-generator/FILES | 46 ++++++ .../README.md | 46 ------ .../tagged_objects/.openapi-generator/FILES | 14 ++ sdk-output/tagged_objects/README.md | 46 ------ sdk-output/tags/.openapi-generator/FILES | 11 ++ sdk-output/tags/README.md | 46 ------ .../task_management/.openapi-generator/FILES | 19 +++ sdk-output/task_management/README.md | 46 ------ sdk-output/tenant/.openapi-generator/FILES | 12 ++ sdk-output/tenant/README.md | 46 ------ .../tenant_context/.openapi-generator/FILES | 13 ++ sdk-output/tenant_context/README.md | 46 ------ .../transforms/.openapi-generator/FILES | 11 ++ sdk-output/transforms/README.md | 46 ------ sdk-output/triggers/.openapi-generator/FILES | 153 ++++++++++++++++++ sdk-output/triggers/README.md | 46 ------ .../ui_metadata/.openapi-generator/FILES | 11 ++ sdk-output/ui_metadata/README.md | 46 ------ .../work_items/.openapi-generator/FILES | 22 +++ sdk-output/work_items/README.md | 46 ------ .../.openapi-generator/FILES | 24 +++ sdk-output/work_reassignment/README.md | 46 ------ sdk-output/workflows/.openapi-generator/FILES | 36 +++++ sdk-output/workflows/README.md | 46 ------ sdk-resources/build-versioned-sdk.js | 19 ++- sdk-resources/postscript.js | 87 +++++++++- 224 files changed, 2767 insertions(+), 5068 deletions(-) delete mode 100644 sdk-output/access_model_metadata/README.md delete mode 100644 sdk-output/access_profiles/README.md delete mode 100644 sdk-output/access_request_approvals/README.md delete mode 100644 sdk-output/access_request_identity_metrics/README.md delete mode 100644 sdk-output/access_requests/README.md delete mode 100644 sdk-output/account_activities/README.md delete mode 100644 sdk-output/account_aggregations/README.md delete mode 100644 sdk-output/account_deletion_requests/README.md delete mode 100644 sdk-output/account_usages/README.md delete mode 100644 sdk-output/accounts/README.md delete mode 100644 sdk-output/api_usage/README.md delete mode 100644 sdk-output/application_discovery/README.md delete mode 100644 sdk-output/approvals/README.md delete mode 100644 sdk-output/apps/README.md delete mode 100644 sdk-output/auth_profile/README.md delete mode 100644 sdk-output/auth_users/README.md delete mode 100644 sdk-output/branding/README.md delete mode 100644 sdk-output/certification_campaign_filters/README.md delete mode 100644 sdk-output/certification_campaigns/README.md delete mode 100644 sdk-output/certification_summaries/README.md delete mode 100644 sdk-output/certifications/README.md delete mode 100644 sdk-output/classify_source/README.md delete mode 100644 sdk-output/configuration_hub/README.md delete mode 100644 sdk-output/connector_customizers/README.md delete mode 100644 sdk-output/connector_rule_management/README.md delete mode 100644 sdk-output/connectors/README.md delete mode 100644 sdk-output/custom_forms/README.md delete mode 100644 sdk-output/custom_password_instructions/README.md delete mode 100644 sdk-output/custom_user_levels/README.md delete mode 100644 sdk-output/data_access_security/README.md delete mode 100644 sdk-output/data_segmentation/README.md delete mode 100644 sdk-output/declassify_source/README.md delete mode 100644 sdk-output/dimensions/README.md delete mode 100644 sdk-output/entitlement_connections/README.md delete mode 100644 sdk-output/entitlements/README.md delete mode 100644 sdk-output/global_tenant_security_settings/README.md delete mode 100644 sdk-output/governance_groups/README.md delete mode 100644 sdk-output/iai_access_request_recommendations/README.md delete mode 100644 sdk-output/iai_common_access/README.md delete mode 100644 sdk-output/iai_outliers/README.md delete mode 100644 sdk-output/iai_peer_group_strategies/README.md delete mode 100644 sdk-output/iai_recommendations/README.md delete mode 100644 sdk-output/iai_role_mining/README.md delete mode 100644 sdk-output/icons/README.md delete mode 100644 sdk-output/identities/README.md delete mode 100644 sdk-output/identity_attributes/README.md delete mode 100644 sdk-output/identity_history/README.md delete mode 100644 sdk-output/identity_profiles/README.md delete mode 100644 sdk-output/jit_access/README.md delete mode 100644 sdk-output/jit_activations/README.md delete mode 100644 sdk-output/launchers/README.md delete mode 100644 sdk-output/lifecycle_states/README.md delete mode 100644 sdk-output/machine_account_classify/README.md delete mode 100644 sdk-output/machine_account_creation_request/README.md delete mode 100644 sdk-output/machine_account_mappings/README.md delete mode 100644 sdk-output/machine_account_subtypes/README.md delete mode 100644 sdk-output/machine_accounts/README.md delete mode 100644 sdk-output/machine_classification_config/README.md delete mode 100644 sdk-output/machine_identities/README.md delete mode 100644 sdk-output/managed_clients/README.md delete mode 100644 sdk-output/managed_cluster_types/README.md delete mode 100644 sdk-output/managed_clusters/README.md delete mode 100644 sdk-output/mfa_configuration/README.md delete mode 100644 sdk-output/multi_host_integration/README.md delete mode 100644 sdk-output/non_employee_lifecycle_management/README.md delete mode 100644 sdk-output/notifications/README.md delete mode 100644 sdk-output/oauth_clients/README.md delete mode 100644 sdk-output/org_config/README.md delete mode 100644 sdk-output/parameter_storage/README.md delete mode 100644 sdk-output/password_configuration/README.md delete mode 100644 sdk-output/password_dictionary/README.md delete mode 100644 sdk-output/password_management/README.md delete mode 100644 sdk-output/password_policies/README.md delete mode 100644 sdk-output/password_sync_groups/README.md delete mode 100644 sdk-output/personal_access_tokens/README.md delete mode 100644 sdk-output/privilege_criteria/README.md delete mode 100644 sdk-output/privilege_criteria_configuration/README.md delete mode 100644 sdk-output/prompt_insights/README.md delete mode 100644 sdk-output/public_identities/README.md delete mode 100644 sdk-output/public_identities_config/README.md delete mode 100644 sdk-output/reports_data_extraction/README.md delete mode 100644 sdk-output/requestable_objects/README.md delete mode 100644 sdk-output/role_insights/README.md delete mode 100644 sdk-output/role_propagation/README.md delete mode 100644 sdk-output/roles/README.md delete mode 100644 sdk-output/saved_search/README.md delete mode 100644 sdk-output/scheduled_search/README.md delete mode 100644 sdk-output/search/README.md delete mode 100644 sdk-output/search_attribute_configuration/README.md delete mode 100644 sdk-output/segments/README.md delete mode 100644 sdk-output/service_desk_integration/README.md delete mode 100644 sdk-output/shared_signals_framework_ssf/README.md delete mode 100644 sdk-output/sim_integrations/README.md delete mode 100644 sdk-output/sod_policies/README.md delete mode 100644 sdk-output/sod_violations/README.md delete mode 100644 sdk-output/source_usages/README.md delete mode 100644 sdk-output/sources/README.md delete mode 100644 sdk-output/sp_config/README.md delete mode 100644 sdk-output/suggested_entitlement_description/README.md delete mode 100644 sdk-output/tagged_objects/README.md delete mode 100644 sdk-output/tags/README.md delete mode 100644 sdk-output/task_management/README.md delete mode 100644 sdk-output/tenant/README.md delete mode 100644 sdk-output/tenant_context/README.md delete mode 100644 sdk-output/transforms/README.md delete mode 100644 sdk-output/triggers/README.md delete mode 100644 sdk-output/ui_metadata/README.md delete mode 100644 sdk-output/work_items/README.md delete mode 100644 sdk-output/work_reassignment/README.md delete mode 100644 sdk-output/workflows/README.md diff --git a/Makefile b/Makefile index ce08692a..45c43c54 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ specs: clean-specs: rm -rf ./api-specs -APIS_DIR ?= api-specs/src/main/yaml/apis +APIS_DIR ?= api-specs/idn/apis .PHONY: build build: diff --git a/package.json b/package.json index 73826364..a8678469 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,8 @@ "private": true, "description": "Build tooling for the SailPoint Typescript SDK", "scripts": { - "build": "node sdk-resources/build-versioned-sdk.js" + "build": "node sdk-resources/build-versioned-sdk.js api-specs/idn/apis", + "build:partition": "node sdk-resources/build-versioned-sdk.js api-specs/idn/apis --partition" }, "dependencies": { "@redocly/cli": "^2.32.2" diff --git a/sdk-output/access_model_metadata/.openapi-generator/FILES b/sdk-output/access_model_metadata/.openapi-generator/FILES index 70c4a1c1..d5615c4c 100644 --- a/sdk-output/access_model_metadata/.openapi-generator/FILES +++ b/sdk-output/access_model_metadata/.openapi-generator/FILES @@ -1,11 +1,53 @@ .gitignore .npmignore .openapi-generator-ignore +AccessModelMetadataV1Api.md +AccessModelMetadataV1ApideveloperSite_code_examples.yaml +Accessmodelmetadatabulkupdateresponse.md +Aggregations.md +Aggregationtype.md +ArrayInner.md +Attributedto.md +Attributevaluedto.md +Bound.md +Bucketaggregation.md +Buckettype.md +BulkupdateammkeyvalueInner.md +Entitlementattributebulkupdatefilterrequest.md +Entitlementattributebulkupdateidsrequest.md +Entitlementattributebulkupdatequeryrequest.md +Errormessagedto.md +Errorresponsedto.md +Filter.md +Filteraggregation.md +Filtertype.md +Index.md +Index.md +Innerhit.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListAccessModelMetadataAttributeV1401Response.md +ListAccessModelMetadataAttributeV1429Response.md +Localeorigin.md +Metricaggregation.md +Metrictype.md +Nestedaggregation.md +Query.md +Queryresultfilter.md +Querytype.md README.md +Range.md +Search.md +Searchaggregationspecification.md +Searchfiltertype.md +Subsearchaggregationspecification.md +Textquery.md +Typeaheadquery.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/access_model_metadata/README.md b/sdk-output/access_model_metadata/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/access_model_metadata/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/access_profiles/.openapi-generator/FILES b/sdk-output/access_profiles/.openapi-generator/FILES index 70c4a1c1..3becd925 100644 --- a/sdk-output/access_profiles/.openapi-generator/FILES +++ b/sdk-output/access_profiles/.openapi-generator/FILES @@ -1,11 +1,53 @@ .gitignore .npmignore .openapi-generator-ignore +AccessProfilesV1Api.md +AccessProfilesV1ApideveloperSite_code_examples.yaml +Accessduration.md +Accessmodelmetadata.md +AccessmodelmetadataValuesInner.md +Accessprofile.md +Accessprofileapprovalscheme.md +Accessprofilebulkdeleterequest.md +Accessprofilebulkdeleteresponse.md +AccessprofilebulkupdaterequestInner.md +Accessprofilesourceref.md +Accessprofileupdateitem.md +Accessprofileusage.md +AccessprofileusageUsedByInner.md +Additionalownerref.md +ArrayInner.md +Attributedto.md +Attributedtolist.md +Attributevaluedto.md +Entitlement.md +EntitlementAccessModelMetadata.md +EntitlementOwner.md +EntitlementSource.md +Entitlementref.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListAccessProfilesV1401Response.md +ListAccessProfilesV1429Response.md +Localeorigin.md +Ownerreference.md +Permissiondto.md +Provisioningcriterialevel1.md +Provisioningcriterialevel2.md +Provisioningcriterialevel3.md +Provisioningcriteriaoperation.md README.md +Requestability.md +Revocability.md +UpdateAccessProfilesInBulkV1412Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/access_profiles/README.md b/sdk-output/access_profiles/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/access_profiles/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/access_request_approvals/.openapi-generator/FILES b/sdk-output/access_request_approvals/.openapi-generator/FILES index 70c4a1c1..ba658ef3 100644 --- a/sdk-output/access_request_approvals/.openapi-generator/FILES +++ b/sdk-output/access_request_approvals/.openapi-generator/FILES @@ -1,11 +1,52 @@ .gitignore .npmignore .openapi-generator-ignore +AccessRequestApprovalsV1Api.md +AccessRequestApprovalsV1ApideveloperSite_code_examples.yaml +Accessitemrequestedfor.md +Accessitemrequester.md +Accessitemreviewedby.md +Accessrequestapproverslistresponse.md +Accessrequesttype.md +Approvalforwardhistory.md +Approvalsummary.md +Commentdto.md +CommentdtoAuthor.md +Completedapproval.md +CompletedapprovalPreApprovalTriggerResult.md +CompletedapprovalRequestedFor.md +CompletedapprovalRequesterComment.md +CompletedapprovalReviewerComment.md +Completedapprovalstate.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Forwardapprovaldto.md +Index.md +ListPendingApprovalsV1401Response.md +ListPendingApprovalsV1429Response.md +Localeorigin.md +Ownerdto.md +Pendingapproval.md +PendingapprovalMaxPermittedAccessDuration.md +PendingapprovalOwner.md +Pendingapprovalaction.md README.md +Reassignmenttype.md +Requestableobjectreference.md +Requestedaccountref.md +Sodexemptcriteria.md +Sodpolicydto.md +Sodviolationcheckresult.md +Sodviolationcontext.md +SodviolationcontextConflictingAccessCriteria.md +SodviolationcontextConflictingAccessCriteriaLeftCriteria.md +Sodviolationcontextcheckcompleted.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/access_request_approvals/README.md b/sdk-output/access_request_approvals/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/access_request_approvals/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/access_request_identity_metrics/.openapi-generator/FILES b/sdk-output/access_request_identity_metrics/.openapi-generator/FILES index 70c4a1c1..7550a247 100644 --- a/sdk-output/access_request_identity_metrics/.openapi-generator/FILES +++ b/sdk-output/access_request_identity_metrics/.openapi-generator/FILES @@ -1,11 +1,20 @@ .gitignore .npmignore .openapi-generator-ignore +AccessRequestIdentityMetricsV1Api.md +AccessRequestIdentityMetricsV1ApideveloperSite_code_examples.yaml +Errormessagedto.md +Errorresponsedto.md +GetAccessRequestIdentityMetricsV1401Response.md +GetAccessRequestIdentityMetricsV1429Response.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/access_request_identity_metrics/README.md b/sdk-output/access_request_identity_metrics/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/access_request_identity_metrics/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/access_requests/.openapi-generator/FILES b/sdk-output/access_requests/.openapi-generator/FILES index 70c4a1c1..6f0fcac4 100644 --- a/sdk-output/access_requests/.openapi-generator/FILES +++ b/sdk-output/access_requests/.openapi-generator/FILES @@ -1,11 +1,92 @@ .gitignore .npmignore .openapi-generator-ignore +AccessRequestsV1Api.md +AccessRequestsV1ApideveloperSite_code_examples.yaml +Accessitemrequester.md +Accessitemreviewedby.md +Accessrequest.md +Accessrequestadminitemstatus.md +Accessrequestconfig.md +Accessrequestconfigv2.md +Accessrequestitem.md +Accessrequestphases.md +Accessrequestresponse.md +Accessrequesttracking.md +Accessrequesttype.md +Accountinforef.md +Accountitemref.md +Accountsselectionrequest.md +Accountsselectionresponse.md +Approvalforwardhistory.md +Approvalreminderandescalationconfig.md +Approvalscheme.md +Approvalstatusdto.md +ApprovalstatusdtoCurrentOwner.md +ApprovalstatusdtoOriginalOwner.md +Bulkapproveaccessrequest.md +Bulkcancelaccessrequest.md +Cancelaccessrequest.md +Cancelledrequestdetails.md +Closeaccessrequest.md +Commentdto.md +CommentdtoAuthor.md +Dtotype.md +Entitlementaccessrequestconfig.md +EntitlementaccessrequestconfigMaxPermittedAccessDuration.md +Entitlementapprovalscheme.md +Entitlementrequestconfig.md +Entitlementrequestconfigv2.md +Entitlementrevocationrequestconfig.md +Errormessagedto.md +Errorresponsedto.md +GetAccessRequestConfigV1401Response.md +GetAccessRequestConfigV1429Response.md +Identityaccountselections.md +Identityentitlementdetails.md +Identityentitlementdetailsaccounttarget.md +Identityentitlementdetailsentitlementdto.md +Identityreferencewithnameandemail.md +Index.md +Localeorigin.md +Manualworkitemdetails.md +ManualworkitemdetailsCurrentOwner.md +ManualworkitemdetailsOriginalOwner.md +Manualworkitemstate.md +Ownerdto.md +Preapprovaltriggerdetails.md +Provisioningdetails.md README.md +Reassignmenttype.md +Requestedaccountref.md +Requestedfordtoref.md +Requesteditemaccountselections.md +Requesteditemdetails.md +Requesteditemdtoref.md +Requesteditemstatus.md +RequesteditemstatusCancelledRequestDetails.md +RequesteditemstatusPreApprovalTriggerDetails.md +RequesteditemstatusProvisioningDetails.md +RequesteditemstatusRequestedFor.md +RequesteditemstatusRequesterComment.md +RequesteditemstatusSodViolationContext.md +Requesteditemstatusrequeststate.md +Requestonbehalfofconfig.md +Requestonbehalfofconfigv2.md +Sodexemptcriteria.md +Sodpolicydto.md +Sodviolationcheckresult.md +Sodviolationcontext.md +SodviolationcontextConflictingAccessCriteria.md +SodviolationcontextConflictingAccessCriteriaLeftCriteria.md +Sodviolationcontextcheckcompleted.md +Sourceaccountselections.md +Sourceitemref.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/access_requests/README.md b/sdk-output/access_requests/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/access_requests/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/account_activities/.openapi-generator/FILES b/sdk-output/account_activities/.openapi-generator/FILES index 70c4a1c1..39d23e0a 100644 --- a/sdk-output/account_activities/.openapi-generator/FILES +++ b/sdk-output/account_activities/.openapi-generator/FILES @@ -1,11 +1,31 @@ .gitignore .npmignore .openapi-generator-ignore +AccountActivitiesV1Api.md +AccountActivitiesV1ApideveloperSite_code_examples.yaml +Accountactivity.md +Accountactivityapprovalstatus.md +Accountactivityitem.md +Accountactivityitemoperation.md +Accountrequestinfo.md +Comment.md +Completionstatus.md +Errormessagedto.md +Errorresponsedto.md +Executionstatus.md +Identitysummary.md +Index.md +ListAccountActivitiesV1401Response.md +ListAccountActivitiesV1429Response.md +Localeorigin.md +Provisioningstate.md README.md +Requestableobjecttype.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/account_activities/README.md b/sdk-output/account_activities/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/account_activities/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/account_aggregations/.openapi-generator/FILES b/sdk-output/account_aggregations/.openapi-generator/FILES index 70c4a1c1..c12d4b0d 100644 --- a/sdk-output/account_aggregations/.openapi-generator/FILES +++ b/sdk-output/account_aggregations/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +AccountAggregationsV1Api.md +AccountAggregationsV1ApideveloperSite_code_examples.yaml +Accountaggregationstatus.md +Errormessagedto.md +Errorresponsedto.md +GetAccountAggregationStatusV1400Response.md +GetAccountAggregationStatusV1429Response.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/account_aggregations/README.md b/sdk-output/account_aggregations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/account_aggregations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/account_deletion_requests/.openapi-generator/FILES b/sdk-output/account_deletion_requests/.openapi-generator/FILES index 70c4a1c1..f6008d63 100644 --- a/sdk-output/account_deletion_requests/.openapi-generator/FILES +++ b/sdk-output/account_deletion_requests/.openapi-generator/FILES @@ -1,11 +1,35 @@ .gitignore .npmignore .openapi-generator-ignore +AccountDeletionRequestsV1Api.md +AccountDeletionRequestsV1ApideveloperSite_code_examples.yaml +Accountactionrequestdto.md +AccountactionrequestdtoAccountDetails.md +AccountactionrequestdtoCorrelatedIdentity.md +AccountactionrequestdtoRequester.md +Accountdeleterequestinput.md +Accountdetails.md +Accountrequestasyncresult.md +Accountrequestphase.md +Accountrequestphasestate.md +Approvaldetails.md +Approverdto.md +Approverreference.md +Basereferencedto.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetAccountDeletionRequestsV1401Response.md +GetAccountDeletionRequestsV1429Response.md +Identityreference.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/account_deletion_requests/README.md b/sdk-output/account_deletion_requests/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/account_deletion_requests/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/account_usages/.openapi-generator/FILES b/sdk-output/account_usages/.openapi-generator/FILES index 70c4a1c1..9b8c737a 100644 --- a/sdk-output/account_usages/.openapi-generator/FILES +++ b/sdk-output/account_usages/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +AccountUsagesV1Api.md +AccountUsagesV1ApideveloperSite_code_examples.yaml +Accountusage.md +Errormessagedto.md +Errorresponsedto.md +GetUsagesByAccountIdV1401Response.md +GetUsagesByAccountIdV1429Response.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/account_usages/README.md b/sdk-output/account_usages/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/account_usages/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/accounts/.openapi-generator/FILES b/sdk-output/accounts/.openapi-generator/FILES index 70c4a1c1..0e8315b4 100644 --- a/sdk-output/accounts/.openapi-generator/FILES +++ b/sdk-output/accounts/.openapi-generator/FILES @@ -1,11 +1,46 @@ .gitignore .npmignore .openapi-generator-ignore +Accessmodelmetadata.md +AccessmodelmetadataValuesInner.md +Account.md +AccountAllOfIdentity.md +AccountAllOfOwnerIdentity.md +AccountAllOfRecommendation.md +AccountAllOfSourceOwner.md +Accountattributes.md +Accountattributescreate.md +AccountattributescreateAttributes.md +AccountsV1Api.md +AccountsV1ApideveloperSite_code_examples.yaml +Accountsasyncresult.md +Accounttogglerequest.md +Accountunlockrequest.md +Additionalownerref.md +Basecommondto.md +Basereferencedto.md +Bulkidentitiesaccountsresponse.md +Dtotype.md +Entitlement.md +EntitlementAccessModelMetadata.md +EntitlementOwner.md +EntitlementSource.md +Errormessagedto.md +Errorresponsedto.md +Identitiesaccountsbulkrequest.md +Index.md +ListAccountsV1401Response.md +ListAccountsV1429Response.md +Localeorigin.md +Permissiondto.md README.md +Recommendation.md +Taskresultdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/accounts/README.md b/sdk-output/accounts/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/accounts/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/api_usage/.openapi-generator/FILES b/sdk-output/api_usage/.openapi-generator/FILES index 70c4a1c1..868ee5f9 100644 --- a/sdk-output/api_usage/.openapi-generator/FILES +++ b/sdk-output/api_usage/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +ApiUsageV1Api.md +ApiUsageV1ApideveloperSite_code_examples.yaml +Errormessagedto.md +Errorresponsedto.md +GetTotalCountV1401Response.md +GetTotalCountV1429Response.md +Index.md +Localeorigin.md README.md +Summaryresponse.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/api_usage/README.md b/sdk-output/api_usage/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/api_usage/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/application_discovery/.openapi-generator/FILES b/sdk-output/application_discovery/.openapi-generator/FILES index 70c4a1c1..f76b5461 100644 --- a/sdk-output/application_discovery/.openapi-generator/FILES +++ b/sdk-output/application_discovery/.openapi-generator/FILES @@ -1,11 +1,37 @@ .gitignore .npmignore .openapi-generator-ignore +ApplicationDiscoveryV1Api.md +ApplicationDiscoveryV1ApideveloperSite_code_examples.yaml +Applicationdiscoveryrequest.md +Applicationdiscoveryresponse.md +ApplicationdiscoveryresponseTarget.md +Basereferencedto.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Fulldiscoveredapplications.md +GetDiscoveredApplicationsV1200ResponseInner.md +Index.md +Localeorigin.md +Localizedmessage.md +Manualdiscoverapplications.md +Manualdiscoverapplicationstemplate.md README.md +Slimdiscoveredapplications.md +StartApplicationDiscoveryV1401Response.md +StartApplicationDiscoveryV1403Response.md +StartApplicationDiscoveryV1403ResponseOneOf.md +StartApplicationDiscoveryV1429Response.md +Taskdefinitionsummary.md +Taskreturndetails.md +Taskstatusmessage.md +TaskstatusmessageParametersInner.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/application_discovery/README.md b/sdk-output/application_discovery/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/application_discovery/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/approvals/.openapi-generator/FILES b/sdk-output/approvals/.openapi-generator/FILES index 70c4a1c1..dbf3d372 100644 --- a/sdk-output/approvals/.openapi-generator/FILES +++ b/sdk-output/approvals/.openapi-generator/FILES @@ -1,11 +1,53 @@ .gitignore .npmignore .openapi-generator-ignore +Approval2.md +Approval2ApprovalCriteria.md +Approval2ApprovalCriteriaApproval.md +Approval2ApprovalCriteriaRejection.md +Approvalapproverequest.md +Approvalattributesrequest.md +Approvalbatch.md +Approvalcancelrequest.md +Approvalcomment3.md +Approvalcommentsrequest.md +Approvalconfig.md +ApprovalconfigCronTimezone.md +ApprovalconfigEscalationConfig.md +ApprovalconfigEscalationConfigEscalationChainInner.md +ApprovalconfigFallbackApprover.md +ApprovalconfigReminderConfig.md +ApprovalconfigSerialChainInner.md +ApprovalconfigTimeoutConfig.md +Approvaldescription.md +Approvalidentity.md +ApprovalidentityMembersInner.md +ApprovalidentityOwnerOfInner.md +Approvalidentityrecord.md +Approvalname.md +Approvalreassignmenthistory.md +Approvalreassignrequest.md +Approvalreference.md +Approvalrejectrequest.md +Approvalrequestedtarget.md +ApprovalsV1Api.md +ApprovalsV1ApideveloperSite_code_examples.yaml +Bulkapproverequestdto.md +Bulkcancelrequestdto.md +Bulkreassignrequestdto.md +Bulkrejectrequestdto.md +Errormessagedto.md +Errorresponsedto.md +GetApprovalsV1401Response.md +GetApprovalsV1429Response.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/approvals/README.md b/sdk-output/approvals/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/approvals/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/apps/.openapi-generator/FILES b/sdk-output/apps/.openapi-generator/FILES index 70c4a1c1..d4757543 100644 --- a/sdk-output/apps/.openapi-generator/FILES +++ b/sdk-output/apps/.openapi-generator/FILES @@ -1,11 +1,44 @@ .gitignore .npmignore .openapi-generator-ignore +Accessprofiledetails.md +AccessprofiledetailsAccountSelector.md +Appaccessprofileselector.md +AppaccessprofileselectorAccountMatchConfig.md +AppaccessprofileselectorAccountMatchConfigMatchExpression.md +Appaccountdetails.md +AppaccountdetailsSourceAccount.md +AppsV1Api.md +AppsV1ApideveloperSite_code_examples.yaml +ArrayInner.md +Basereferencedto.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetSourceAppV1401Response.md +GetSourceAppV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Matchterm.md README.md +Sourceapp.md +SourceappAccountSource.md +Sourceappbulkupdaterequest.md +Sourceappcreatedto.md +SourceappcreatedtoAccountSource.md +Sourceapppatchdto.md +Userapp.md +UserappAccount.md +UserappOwner.md +UserappSource.md +UserappSourceApp.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/apps/README.md b/sdk-output/apps/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/apps/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/auth_profile/.openapi-generator/FILES b/sdk-output/auth_profile/.openapi-generator/FILES index 70c4a1c1..1658e5ce 100644 --- a/sdk-output/auth_profile/.openapi-generator/FILES +++ b/sdk-output/auth_profile/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +AuthProfileV1Api.md +AuthProfileV1ApideveloperSite_code_examples.yaml +Authprofile.md +Authprofilesummary.md +Errormessagedto.md +Errorresponsedto.md +GetProfileConfigListV1401Response.md +GetProfileConfigListV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/auth_profile/README.md b/sdk-output/auth_profile/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/auth_profile/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/auth_users/.openapi-generator/FILES b/sdk-output/auth_users/.openapi-generator/FILES index 70c4a1c1..ec18b6fb 100644 --- a/sdk-output/auth_users/.openapi-generator/FILES +++ b/sdk-output/auth_users/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +AuthUsersV1Api.md +AuthUsersV1ApideveloperSite_code_examples.yaml +Authuser.md +Errormessagedto.md +Errorresponsedto.md +GetAuthUserV1401Response.md +GetAuthUserV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/auth_users/README.md b/sdk-output/auth_users/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/auth_users/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/branding/.openapi-generator/FILES b/sdk-output/branding/.openapi-generator/FILES index 70c4a1c1..121579d5 100644 --- a/sdk-output/branding/.openapi-generator/FILES +++ b/sdk-output/branding/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +BrandingV1Api.md +BrandingV1ApideveloperSite_code_examples.yaml +Brandingitem.md +Brandingitemcreate.md +Errormessagedto.md +Errorresponsedto.md +GetBrandingListV1401Response.md +GetBrandingListV1429Response.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/branding/README.md b/sdk-output/branding/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/branding/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/certification_campaign_filters/.openapi-generator/FILES b/sdk-output/certification_campaign_filters/.openapi-generator/FILES index 70c4a1c1..2a9c6f5b 100644 --- a/sdk-output/certification_campaign_filters/.openapi-generator/FILES +++ b/sdk-output/certification_campaign_filters/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +Campaignfilterdetails.md +CampaignfilterdetailsCriteriaListInner.md +CertificationCampaignFiltersV1Api.md +CertificationCampaignFiltersV1ApideveloperSite_code_examples.yaml +Criteriatype.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListCampaignFiltersV1200Response.md +ListCampaignFiltersV1401Response.md +ListCampaignFiltersV1429Response.md +Localeorigin.md +Operation.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/certification_campaign_filters/README.md b/sdk-output/certification_campaign_filters/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/certification_campaign_filters/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/certification_campaigns/.openapi-generator/FILES b/sdk-output/certification_campaigns/.openapi-generator/FILES index 70c4a1c1..611865ef 100644 --- a/sdk-output/certification_campaigns/.openapi-generator/FILES +++ b/sdk-output/certification_campaigns/.openapi-generator/FILES @@ -1,11 +1,57 @@ .gitignore .npmignore .openapi-generator-ignore +Accessconstraint.md +Activatecampaignoptions.md +Adminreviewreassign.md +AdminreviewreassignReassignTo.md +ArrayInner.md +Campaign2.md +Campaign2AllOfFilter.md +Campaign2AllOfMachineAccountCampaignInfo.md +Campaign2AllOfRoleCompositionCampaignInfo.md +Campaign2AllOfRoleCompositionCampaignInfoRemediatorRef.md +Campaign2AllOfRoleCompositionCampaignInfoReviewer.md +Campaign2AllOfSearchCampaignInfo.md +Campaign2AllOfSearchCampaignInfoReviewer.md +Campaign2AllOfSourceOwnerCampaignInfo.md +Campaign2AllOfSourcesWithOrphanEntitlements.md +Campaignalert.md +Campaigncompleteoptions.md +Campaignreference.md +Campaignreport.md +Campaignreportsconfig.md +Campaignsdeleterequest.md +Campaigntemplate.md +CampaigntemplateOwnerRef.md +CertificationCampaignsV1Api.md +CertificationCampaignsV1ApideveloperSite_code_examples.yaml +Certificationtask.md +Errormessagedto.md +Errorresponsedto.md +GetActiveCampaignsV1200ResponseInner.md +GetActiveCampaignsV1401Response.md +GetActiveCampaignsV1429Response.md +GetCampaignV1200Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md README.md +Reassignmenttraildto.md +Reportresultreference.md +Reporttype.md +Schedule2.md +Schedule2Days.md +Schedule2Hours.md +Schedule2Months.md +Slimcampaign.md +Sodreportresultdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/certification_campaigns/README.md b/sdk-output/certification_campaigns/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/certification_campaigns/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/certification_summaries/.openapi-generator/FILES b/sdk-output/certification_summaries/.openapi-generator/FILES index 70c4a1c1..3d981dc2 100644 --- a/sdk-output/certification_summaries/.openapi-generator/FILES +++ b/sdk-output/certification_summaries/.openapi-generator/FILES @@ -1,11 +1,36 @@ .gitignore .npmignore .openapi-generator-ignore +Accesssummary.md +AccesssummaryAccess.md +Activityinsights.md +CertificationSummariesV1Api.md +CertificationSummariesV1ApideveloperSite_code_examples.yaml +Certificationidentitysummary.md +Dataaccess.md +DataaccessCategoriesInner.md +DataaccessImpactScore.md +DataaccessPoliciesInner.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetIdentityDecisionSummaryV1401Response.md +GetIdentityDecisionSummaryV1429Response.md +Identitycertdecisionsummary.md +Identityreferencewithnameandemail.md +Index.md +Localeorigin.md README.md +Reviewableaccessprofile.md +Reviewableentitlement.md +ReviewableentitlementAccount.md +ReviewableentitlementAccountOwner.md +Reviewablerole.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/certification_summaries/README.md b/sdk-output/certification_summaries/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/certification_summaries/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/certifications/.openapi-generator/FILES b/sdk-output/certifications/.openapi-generator/FILES index 70c4a1c1..b670ae43 100644 --- a/sdk-output/certifications/.openapi-generator/FILES +++ b/sdk-output/certifications/.openapi-generator/FILES @@ -1,11 +1,50 @@ .gitignore .npmignore .openapi-generator-ignore +Accessreviewitem.md +Accesssummary.md +AccesssummaryAccess.md +Activityinsights.md +Campaignreference.md +Certificationdecision.md +Certificationidentitysummary.md +Certificationphase.md +Certificationreference.md +CertificationsV1Api.md +CertificationsV1ApideveloperSite_code_examples.yaml +Certificationtask.md +Dataaccess.md +DataaccessCategoriesInner.md +DataaccessImpactScore.md +DataaccessPoliciesInner.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Identitycertificationdto.md +Identityreferencewithnameandemail.md +Index.md +ListIdentityCertificationsV1401Response.md +ListIdentityCertificationsV1429Response.md +Localeorigin.md +Permissiondto.md README.md +Reassignment.md +Reassignmenttraildto.md +Reassignreference.md +Reviewableaccessprofile.md +Reviewableentitlement.md +ReviewableentitlementAccount.md +ReviewableentitlementAccountOwner.md +Reviewablerole.md +Reviewdecision.md +Reviewer.md +Reviewreassign.md +Reviewrecommendation.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/certifications/README.md b/sdk-output/certifications/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/certifications/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/classify_source/.openapi-generator/FILES b/sdk-output/classify_source/.openapi-generator/FILES index 70c4a1c1..bbb02f06 100644 --- a/sdk-output/classify_source/.openapi-generator/FILES +++ b/sdk-output/classify_source/.openapi-generator/FILES @@ -1,11 +1,23 @@ .gitignore .npmignore .openapi-generator-ignore +ClassifySourceV1Api.md +ClassifySourceV1ApideveloperSite_code_examples.yaml +Errormessagedto.md +Errorresponsedto.md +GetClassifyMachineAccountFromSourceStatusV1401Response.md +GetClassifyMachineAccountFromSourceStatusV1429Response.md +Index.md +Localeorigin.md README.md +SendClassifyMachineAccountFromSourceV1200Response.md +Sourceclassificationstatus.md +SourceclassificationstatusAllOfCounts.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/classify_source/README.md b/sdk-output/classify_source/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/classify_source/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/configuration_hub/.openapi-generator/FILES b/sdk-output/configuration_hub/.openapi-generator/FILES index 70c4a1c1..b65036d6 100644 --- a/sdk-output/configuration_hub/.openapi-generator/FILES +++ b/sdk-output/configuration_hub/.openapi-generator/FILES @@ -1,11 +1,46 @@ .gitignore .npmignore .openapi-generator-ignore +Approvalcomment.md +ArrayInner.md +Backupoptions.md +Backupresponse.md +ConfigurationHubV1Api.md +ConfigurationHubV1ApideveloperSite_code_examples.yaml +CreateUploadedConfigurationV1Request.md +Deployrequest.md +Deployresponse.md +Draftresponse.md +Errormessagedto.md +Errorresponsedto.md +GetObjectMappingsV1401Response.md +GetObjectMappingsV1429Response.md +Index.md +Jsonpatch.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListDeploysV1200Response.md +Localeorigin.md +Objectexportimportnames.md +Objectmappingbulkcreaterequest.md +Objectmappingbulkcreateresponse.md +Objectmappingbulkpatchrequest.md +Objectmappingbulkpatchresponse.md +Objectmappingrequest.md +Objectmappingresponse.md README.md +Scheduledactionpayload.md +ScheduledactionpayloadContent.md +ScheduledactionpayloadContentBackupOptions.md +Scheduledactionresponse.md +ScheduledactionresponseContent.md +ScheduledactionresponseContentBackupOptions.md +ScheduledactionresponseContentBackupOptionsObjectOptionsValue.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/configuration_hub/README.md b/sdk-output/configuration_hub/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/configuration_hub/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/connector_customizers/.openapi-generator/FILES b/sdk-output/connector_customizers/.openapi-generator/FILES index 70c4a1c1..fdc18493 100644 --- a/sdk-output/connector_customizers/.openapi-generator/FILES +++ b/sdk-output/connector_customizers/.openapi-generator/FILES @@ -1,11 +1,26 @@ .gitignore .npmignore .openapi-generator-ignore +ConnectorCustomizersV1Api.md +ConnectorCustomizersV1ApideveloperSite_code_examples.yaml +Connectorcustomizercreaterequest.md +Connectorcustomizercreateresponse.md +Connectorcustomizersresponse.md +Connectorcustomizerupdaterequest.md +Connectorcustomizerupdateresponse.md +Connectorcustomizerversioncreateresponse.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListConnectorCustomizersV1401Response.md +ListConnectorCustomizersV1429Response.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/connector_customizers/README.md b/sdk-output/connector_customizers/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/connector_customizers/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/connector_rule_management/.openapi-generator/FILES b/sdk-output/connector_rule_management/.openapi-generator/FILES index 70c4a1c1..4451f342 100644 --- a/sdk-output/connector_rule_management/.openapi-generator/FILES +++ b/sdk-output/connector_rule_management/.openapi-generator/FILES @@ -1,11 +1,28 @@ .gitignore .npmignore .openapi-generator-ignore +Argument.md +ConnectorRuleManagementV1Api.md +ConnectorRuleManagementV1ApideveloperSite_code_examples.yaml +Connectorrulecreaterequest.md +ConnectorrulecreaterequestSignature.md +Connectorruleresponse.md +Connectorruleupdaterequest.md +Connectorrulevalidationresponse.md +ConnectorrulevalidationresponseDetailsInner.md +Errormessagedto.md +Errorresponsedto.md +GetConnectorRuleListV1401Response.md +GetConnectorRuleListV1429Response.md +Index.md +Localeorigin.md README.md +Sourcecode.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/connector_rule_management/README.md b/sdk-output/connector_rule_management/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/connector_rule_management/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/connectors/.openapi-generator/FILES b/sdk-output/connectors/.openapi-generator/FILES index 70c4a1c1..c39d413f 100644 --- a/sdk-output/connectors/.openapi-generator/FILES +++ b/sdk-output/connectors/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Connectordetail.md +ConnectorsV1Api.md +ConnectorsV1ApideveloperSite_code_examples.yaml +Errormessagedto.md +Errorresponsedto.md +GetConnectorV1401Response.md +GetConnectorV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +PutConnectorCorrelationConfigV1Request.md +PutConnectorSourceConfigV1Request.md +PutConnectorSourceTemplateV1Request.md README.md +Updatedetail.md +V3connectordto.md +V3createconnectordto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/connectors/README.md b/sdk-output/connectors/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/connectors/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/custom_forms/.openapi-generator/FILES b/sdk-output/custom_forms/.openapi-generator/FILES index 70c4a1c1..f246edaf 100644 --- a/sdk-output/custom_forms/.openapi-generator/FILES +++ b/sdk-output/custom_forms/.openapi-generator/FILES @@ -1,11 +1,54 @@ .gitignore .npmignore .openapi-generator-ignore +Conditioneffect.md +ConditioneffectConfig.md +Conditionrule.md +CreateFormDefinitionFileRequestV1Request.md +Createformdefinitionrequest.md +Createforminstancerequest.md +CustomFormsV1Api.md +CustomFormsV1ApideveloperSite_code_examples.yaml +Error.md +Errormessage.md +ExportFormDefinitionsByTenantV1200ResponseInner.md +ExportFormDefinitionsByTenantV1200ResponseInnerSelf.md +Formcondition.md +Formdefinitiondynamicschemarequest.md +FormdefinitiondynamicschemarequestAttributes.md +Formdefinitiondynamicschemaresponse.md +Formdefinitionfileuploadresponse.md +Formdefinitioninput.md +Formdefinitionresponse.md +Formdefinitionselfimportexportdto.md +Formelement.md +Formelementdatasourceconfigoptions.md +Formelementdynamicdatasource.md +Formelementdynamicdatasourceconfig.md +Formelementpreviewrequest.md +Formelementvalidationsset.md +Formerror.md +Forminstancecreatedby.md +Forminstancerecipient.md +Forminstanceresponse.md +Formowner.md +Formusedby.md +ImportFormDefinitionsV1202Response.md +ImportFormDefinitionsV1202ResponseErrorsInner.md +ImportFormDefinitionsV1RequestInner.md +Index.md +Listformdefinitionsbytenantresponse.md +Listformelementdatabyelementidresponse.md +Listforminstancesbytenantresponse.md +Listpredefinedselectoptionsresponse.md +Previewdatasourceresponse.md README.md +SearchFormDefinitionsByTenantV1400Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/custom_forms/README.md b/sdk-output/custom_forms/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/custom_forms/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/custom_password_instructions/.openapi-generator/FILES b/sdk-output/custom_password_instructions/.openapi-generator/FILES index 70c4a1c1..410412fd 100644 --- a/sdk-output/custom_password_instructions/.openapi-generator/FILES +++ b/sdk-output/custom_password_instructions/.openapi-generator/FILES @@ -1,11 +1,19 @@ .gitignore .npmignore .openapi-generator-ignore +CustomPasswordInstructionsV1Api.md +CustomPasswordInstructionsV1ApideveloperSite_code_examples.yaml +Custompasswordinstruction.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/custom_password_instructions/README.md b/sdk-output/custom_password_instructions/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/custom_password_instructions/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/custom_user_levels/.openapi-generator/FILES b/sdk-output/custom_user_levels/.openapi-generator/FILES index 70c4a1c1..c2e88b2c 100644 --- a/sdk-output/custom_user_levels/.openapi-generator/FILES +++ b/sdk-output/custom_user_levels/.openapi-generator/FILES @@ -1,11 +1,36 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Authuserlevelsidentitycount.md +Authuserslimresponse.md +CustomUserLevelsV1Api.md +CustomUserLevelsV1ApideveloperSite_code_examples.yaml +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Hierarchicalrightset.md +Identityreference.md +Index.md +Jsonpatch.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListUserLevelsV1401Response.md +ListUserLevelsV1429Response.md +Localeorigin.md +Nestedconfig.md +Publicidentity.md +PublicidentityAttributesInner.md README.md +Rightsetdto.md +Userlevelpublishsummary.md +Userlevelrequest.md +Userlevelsummarydto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/custom_user_levels/README.md b/sdk-output/custom_user_levels/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/custom_user_levels/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/data_access_security/.openapi-generator/FILES b/sdk-output/data_access_security/.openapi-generator/FILES index 70c4a1c1..39fef3c8 100644 --- a/sdk-output/data_access_security/.openapi-generator/FILES +++ b/sdk-output/data_access_security/.openapi-generator/FILES @@ -1,11 +1,46 @@ .gitignore .npmignore .openapi-generator-ignore +Activityconfigurationsettings.md +Applicationcrawlersettings.md +Applicationitem.md +Applicationtype.md +Assignresourceownerrequest.md +Basecreateapplicationrequest.md +Basesettings.md +Businessservicetype.md +Crawlresourcessizesoptions.md +CreateIdentityCollectorV1200Response.md +Createidentitycollectorrequest.md +Createschedulerequest.md +DataAccessSecurityV1Api.md +DataAccessSecurityV1ApideveloperSite_code_examples.yaml +Dataclassificationsettings.md +Dataownermodel.md +Errormessagedto.md +Errorresponsedto.md +GetTasksV1401Response.md +GetTasksV1429Response.md +Identitycollectorlistitem.md +Index.md +Int64stringkeyvaluepair.md +Localeorigin.md +Permissioncollectorsettings.md +PutIdentityCollectorV1409Response.md +PutIdentityCollectorV1409ResponseMessagesInner.md README.md +Reelectrequest.md +Resourcemodel.md +Scheduleinfo.md +Tag.md +Taskinfo.md +Updateidentitycollectorrequest.md +Updateschedulerequest.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/data_access_security/README.md b/sdk-output/data_access_security/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/data_access_security/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/data_segmentation/.openapi-generator/FILES b/sdk-output/data_segmentation/.openapi-generator/FILES index 70c4a1c1..1d4454ae 100644 --- a/sdk-output/data_segmentation/.openapi-generator/FILES +++ b/sdk-output/data_segmentation/.openapi-generator/FILES @@ -1,11 +1,32 @@ .gitignore .npmignore .openapi-generator-ignore +DataSegment.md +DataSegmentationV1Api.md +DataSegmentationV1ApideveloperSite_code_examples.yaml +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Expression.md +ExpressionChildrenInner.md +GetDataSegmentIdentityMembershipV1401Response.md +GetDataSegmentIdentityMembershipV1429Response.md +Index.md +Localeorigin.md +Membershiptype.md README.md +Ref.md +Scope.md +Scopetype.md +Scopevisibilitytype.md +Segmentmembership.md +Value.md +Visibilitycriteria.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/data_segmentation/README.md b/sdk-output/data_segmentation/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/data_segmentation/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/declassify_source/.openapi-generator/FILES b/sdk-output/declassify_source/.openapi-generator/FILES index 70c4a1c1..769b33f9 100644 --- a/sdk-output/declassify_source/.openapi-generator/FILES +++ b/sdk-output/declassify_source/.openapi-generator/FILES @@ -1,11 +1,20 @@ .gitignore .npmignore .openapi-generator-ignore +DeclassifySourceV1Api.md +DeclassifySourceV1ApideveloperSite_code_examples.yaml +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md README.md +SendDeclassifyMachineAccountFromSourceV1401Response.md +SendDeclassifyMachineAccountFromSourceV1429Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/declassify_source/README.md b/sdk-output/declassify_source/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/declassify_source/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/dimensions/.openapi-generator/FILES b/sdk-output/dimensions/.openapi-generator/FILES index 70c4a1c1..2e3cda47 100644 --- a/sdk-output/dimensions/.openapi-generator/FILES +++ b/sdk-output/dimensions/.openapi-generator/FILES @@ -1,11 +1,58 @@ .gitignore .npmignore .openapi-generator-ignore +Accessduration.md +Accessmodelmetadata.md +AccessmodelmetadataValuesInner.md +Accessprofile.md +Accessprofileapprovalscheme.md +Accessprofileref.md +Accessprofilesourceref.md +Additionalownerref.md +ArrayInner.md +Attributedto.md +Attributedtolist.md +Attributevaluedto.md +Dimension.md +Dimensionbulkdeleterequest.md +Dimensioncriteriakey.md +Dimensioncriteriakeytype.md +Dimensioncriterialevel1.md +Dimensioncriterialevel2.md +Dimensioncriterialevel3.md +Dimensioncriteriaoperation.md +Dimensionmembershipselector.md +Dimensionmembershipselectortype.md +DimensionsV1Api.md +DimensionsV1ApideveloperSite_code_examples.yaml +Entitlement.md +EntitlementAccessModelMetadata.md +EntitlementOwner.md +EntitlementSource.md +Entitlementref.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListDimensionsV1401Response.md +ListDimensionsV1429Response.md +Localeorigin.md +Ownerreference.md +Permissiondto.md +Provisioningcriterialevel1.md +Provisioningcriterialevel2.md +Provisioningcriterialevel3.md +Provisioningcriteriaoperation.md README.md +Requestability.md +Revocability.md +Taskresultdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/dimensions/README.md b/sdk-output/dimensions/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/dimensions/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/entitlement_connections/.openapi-generator/FILES b/sdk-output/entitlement_connections/.openapi-generator/FILES index 70c4a1c1..1724e026 100644 --- a/sdk-output/entitlement_connections/.openapi-generator/FILES +++ b/sdk-output/entitlement_connections/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +EntitlementConnectionsV1Api.md +EntitlementConnectionsV1ApideveloperSite_code_examples.yaml +Entitlementconnection.md +Entitlementconnectionbulkupdateitem.md +Entitlementconnectionbulkupdateresultitem.md +Entitlementconnectionsearchhit.md +Entitlementconnectionsearchhitentitlement.md +EntitlementconnectionsearchhitentitlementPrivilegeLevel.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListEntitlementConnectionsV1401Response.md +ListEntitlementConnectionsV1412Response.md +ListEntitlementConnectionsV1429Response.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/entitlement_connections/README.md b/sdk-output/entitlement_connections/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/entitlement_connections/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/entitlements/.openapi-generator/FILES b/sdk-output/entitlements/.openapi-generator/FILES index 70c4a1c1..5523dc42 100644 --- a/sdk-output/entitlements/.openapi-generator/FILES +++ b/sdk-output/entitlements/.openapi-generator/FILES @@ -1,11 +1,45 @@ .gitignore .npmignore .openapi-generator-ignore +Accessmodelmetadata.md +AccessmodelmetadataValuesInner.md +Additionalownerref.md +ArrayInner.md +Entitlement.md +EntitlementSource.md +Entitlementaccessrequestconfig.md +EntitlementaccessrequestconfigMaxPermittedAccessDuration.md +Entitlementapprovalscheme.md +Entitlementbulkupdaterequest.md +Entitlementprivilegelevel.md +Entitlementrequestconfig.md +Entitlementrevocationrequestconfig.md +EntitlementsV1Api.md +EntitlementsV1ApideveloperSite_code_examples.yaml +Entitlementsourceresetbasereferencedto.md +Entitlementv2.md +Entitlementv2AccessModelMetadata.md +Entitlementv2Owner.md +Entitlementv2PrivilegeLevel.md +Entitlementv2Source.md +Errormessagedto.md +Errorresponsedto.md +ImportEntitlementsBySourceV1Request.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListEntitlementsV1401Response.md +ListEntitlementsV1429Response.md +Loadentitlementtask.md +LoadentitlementtaskReturnsInner.md +Localeorigin.md +Permissiondto.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/entitlements/README.md b/sdk-output/entitlements/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/entitlements/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/global_tenant_security_settings/.openapi-generator/FILES b/sdk-output/global_tenant_security_settings/.openapi-generator/FILES index 70c4a1c1..4ada48e3 100644 --- a/sdk-output/global_tenant_security_settings/.openapi-generator/FILES +++ b/sdk-output/global_tenant_security_settings/.openapi-generator/FILES @@ -1,11 +1,32 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +Federationprotocoldetails.md +GetAuthOrgNetworkConfigV1401Response.md +GetAuthOrgNetworkConfigV1429Response.md +GlobalTenantSecuritySettingsV1Api.md +GlobalTenantSecuritySettingsV1ApideveloperSite_code_examples.yaml +Idpdetails.md +Index.md +Jitconfiguration.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Lockoutconfiguration.md +Networkconfiguration.md README.md +Serviceproviderconfiguration.md +ServiceproviderconfigurationFederationProtocolDetailsInner.md +Sessionconfiguration.md +Spdetails.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/global_tenant_security_settings/README.md b/sdk-output/global_tenant_security_settings/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/global_tenant_security_settings/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/governance_groups/.openapi-generator/FILES b/sdk-output/governance_groups/.openapi-generator/FILES index 70c4a1c1..c98e8fa4 100644 --- a/sdk-output/governance_groups/.openapi-generator/FILES +++ b/sdk-output/governance_groups/.openapi-generator/FILES @@ -1,11 +1,36 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +BulkworkgroupmembersrequestInner.md +Connectedobject.md +Connectedobjecttype.md +Errormessagedto.md +Errorresponsedto.md +GovernanceGroupsV1Api.md +GovernanceGroupsV1ApideveloperSite_code_examples.yaml +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListWorkgroupMembersV1200ResponseInner.md +ListWorkgroupsV1401Response.md +ListWorkgroupsV1429Response.md +Localeorigin.md +Ownerdto.md README.md +Workgroupbulkdeleterequest.md +Workgroupconnectiondto.md +WorkgroupconnectiondtoObject.md +Workgroupdeleteitem.md +Workgroupdto.md +WorkgroupdtoOwner.md +Workgroupmemberadditem.md +Workgroupmemberdeleteitem.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/governance_groups/README.md b/sdk-output/governance_groups/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/governance_groups/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES b/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES index 70c4a1c1..d88c4c29 100644 --- a/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES +++ b/sdk-output/iai_access_request_recommendations/.openapi-generator/FILES @@ -1,11 +1,29 @@ .gitignore .npmignore .openapi-generator-ignore +Accessrecommendationmessage.md +Accessrequestrecommendationactionitemdto.md +Accessrequestrecommendationactionitemresponsedto.md +Accessrequestrecommendationconfigdto.md +Accessrequestrecommendationitem.md +Accessrequestrecommendationitemdetail.md +AccessrequestrecommendationitemdetailAccess.md +Accessrequestrecommendationitemtype.md +Errormessagedto.md +Errorresponsedto.md +GetAccessRequestRecommendationsV1401Response.md +GetAccessRequestRecommendationsV1429Response.md +IAIAccessRequestRecommendationsV1Api.md +IAIAccessRequestRecommendationsV1ApideveloperSite_code_examples.yaml +Index.md +Localeorigin.md README.md +Translationmessage.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_access_request_recommendations/README.md b/sdk-output/iai_access_request_recommendations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_access_request_recommendations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_common_access/.openapi-generator/FILES b/sdk-output/iai_common_access/.openapi-generator/FILES index 70c4a1c1..a842961a 100644 --- a/sdk-output/iai_common_access/.openapi-generator/FILES +++ b/sdk-output/iai_common_access/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +Commonaccessidstatus.md +Commonaccessitemaccess.md +Commonaccessitemrequest.md +Commonaccessitemresponse.md +Commonaccessitemstate.md +Commonaccessresponse.md +Commonaccesstype.md +CreateCommonAccessV1429Response.md +Errormessagedto.md +Errorresponsedto.md +GetCommonAccessV1401Response.md +IAICommonAccessV1Api.md +IAICommonAccessV1ApideveloperSite_code_examples.yaml +Index.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_common_access/README.md b/sdk-output/iai_common_access/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_common_access/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_outliers/.openapi-generator/FILES b/sdk-output/iai_outliers/.openapi-generator/FILES index 70c4a1c1..c2613d32 100644 --- a/sdk-output/iai_outliers/.openapi-generator/FILES +++ b/sdk-output/iai_outliers/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetIdentityOutlierSnapshotsV1401Response.md +GetIdentityOutlierSnapshotsV1429Response.md +IAIOutliersV1Api.md +IAIOutliersV1ApideveloperSite_code_examples.yaml +Index.md +Latestoutliersummary.md +Localeorigin.md +Outlier.md +Outliercontributingfeature.md +Outlierfeaturesummary.md +OutlierfeaturesummaryOutlierFeatureDisplayValuesInner.md +Outlierfeaturetranslation.md +Outlierscontributingfeatureaccessitems.md +Outliersummary.md +Outliervaluetype.md README.md +Translationmessage.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_outliers/README.md b/sdk-output/iai_outliers/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_outliers/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES b/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES index 70c4a1c1..9e9b1aaf 100644 --- a/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES +++ b/sdk-output/iai_peer_group_strategies/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPeerGroupOutliersV1401Response.md +GetPeerGroupOutliersV1429Response.md +IAIPeerGroupStrategiesV1Api.md +IAIPeerGroupStrategiesV1ApideveloperSite_code_examples.yaml +Index.md +Localeorigin.md +Peergroupmember.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_peer_group_strategies/README.md b/sdk-output/iai_peer_group_strategies/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_peer_group_strategies/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_recommendations/.openapi-generator/FILES b/sdk-output/iai_recommendations/.openapi-generator/FILES index 70c4a1c1..5b1b3a8e 100644 --- a/sdk-output/iai_recommendations/.openapi-generator/FILES +++ b/sdk-output/iai_recommendations/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +Accessitemref.md +Errormessagedto.md +Errorresponsedto.md +Featurevaluedto.md +GetRecommendationsV1401Response.md +GetRecommendationsV1429Response.md +IAIRecommendationsV1Api.md +IAIRecommendationsV1ApideveloperSite_code_examples.yaml +Index.md +Localeorigin.md README.md +Recommendationconfigdto.md +Recommendationrequest.md +Recommendationrequestdto.md +Recommendationresponse.md +Recommendationresponsedto.md +Recommendercalculations.md +RecommendercalculationsIdentityAttributesValue.md +Translationmessage.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_recommendations/README.md b/sdk-output/iai_recommendations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_recommendations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/iai_role_mining/.openapi-generator/FILES b/sdk-output/iai_role_mining/.openapi-generator/FILES index 70c4a1c1..6e4c0f54 100644 --- a/sdk-output/iai_role_mining/.openapi-generator/FILES +++ b/sdk-output/iai_role_mining/.openapi-generator/FILES @@ -1,11 +1,56 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +ArrayInner1.md +Entitycreatedbydto.md +Errormessagedto.md +Errorresponsedto.md +GetRoleMiningSessionsV1401Response.md +GetRoleMiningSessionsV1429Response.md +IAIRoleMiningV1Api.md +IAIRoleMiningV1ApideveloperSite_code_examples.yaml +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Jsonpatchoperationrolemining.md +JsonpatchoperationroleminingValue.md +Localeorigin.md README.md +Roleminingentitlement.md +Roleminingentitlementref.md +Roleminingidentity.md +Roleminingidentitydistribution.md +RoleminingidentitydistributionDistributionInner.md +Roleminingpotentialrole.md +RoleminingpotentialrolePotentialRoleRef.md +Roleminingpotentialroleapplication.md +Roleminingpotentialroleeditentitlements.md +Roleminingpotentialroleentitlements.md +Roleminingpotentialroleexportrequest.md +Roleminingpotentialroleexportresponse.md +Roleminingpotentialroleexportstate.md +Roleminingpotentialroleprovisionrequest.md +Roleminingpotentialroleprovisionstate.md +Roleminingpotentialroleref.md +Roleminingpotentialrolesourceusage.md +Roleminingpotentialrolesummary.md +RoleminingpotentialrolesummaryCreatedBy.md +Roleminingroletype.md +Roleminingsessiondraftroledto.md +Roleminingsessiondto.md +Roleminingsessionparametersdto.md +Roleminingsessionresponse.md +RoleminingsessionresponseCreatedBy.md +Roleminingsessionscope.md +Roleminingsessionscopingmethod.md +Roleminingsessionstate.md +Roleminingsessionstatus.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/iai_role_mining/README.md b/sdk-output/iai_role_mining/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/iai_role_mining/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/icons/.openapi-generator/FILES b/sdk-output/icons/.openapi-generator/FILES index 70c4a1c1..f9b920dc 100644 --- a/sdk-output/icons/.openapi-generator/FILES +++ b/sdk-output/icons/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +IconsV1Api.md +IconsV1ApideveloperSite_code_examples.yaml +Index.md +Localeorigin.md README.md +SetIconV1200Response.md +SetIconV1401Response.md +SetIconV1429Response.md +SetIconV1Request.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/icons/README.md b/sdk-output/icons/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/icons/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/identities/.openapi-generator/FILES b/sdk-output/identities/.openapi-generator/FILES index 70c4a1c1..c3c79ac2 100644 --- a/sdk-output/identities/.openapi-generator/FILES +++ b/sdk-output/identities/.openapi-generator/FILES @@ -1,11 +1,59 @@ .gitignore .npmignore .openapi-generator-ignore +Accessrequestcontext.md +Accountinfodto.md +Assignmentcontextdto.md +Basereferencedto.md +Contextattributedto.md +ContextattributedtoValue.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetRoleAssignmentsV1200ResponseInner.md +IdentitiesV1Api.md +IdentitiesV1ApideveloperSite_code_examples.yaml +Identity.md +IdentityLifecycleState.md +IdentityManagerRef.md +Identityassociationdetails.md +IdentityassociationdetailsAssociationDetailsInner.md +Identityentities.md +IdentityentitiesIdentityEntity.md +Identityentitlements.md +Identityownershipassociationdetails.md +IdentityownershipassociationdetailsAssociationDetailsInner.md +Identitysyncjob.md +Identitysyncpayload.md +Index.md +Inviteidentitiesrequest.md +Lifecyclestatedto.md +ListIdentitiesV1401Response.md +ListIdentitiesV1429Response.md +Localeorigin.md +Localizedmessage.md +Processidentitiesrequest.md README.md +Roleassignmentdto.md +RoleassignmentdtoAssigner.md +RoleassignmentdtoAssignmentContext.md +Roleassignmentref.md +Rolematchdto.md +Roletargetdto.md +Sendaccountverificationrequest.md +Taggedobjectdto.md +Target.md +Taskdefinitionsummary.md +Taskresultresponse.md +Taskreturndetails.md +Taskstatus.md +Taskstatusmessage.md +TaskstatusmessageParametersInner.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/identities/README.md b/sdk-output/identities/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/identities/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/identity_attributes/.openapi-generator/FILES b/sdk-output/identity_attributes/.openapi-generator/FILES index 70c4a1c1..6fa1d1f6 100644 --- a/sdk-output/identity_attributes/.openapi-generator/FILES +++ b/sdk-output/identity_attributes/.openapi-generator/FILES @@ -1,11 +1,23 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +IdentityAttributesV1Api.md +IdentityAttributesV1ApideveloperSite_code_examples.yaml +Identityattribute2.md +Identityattributenames.md +Index.md +ListIdentityAttributesV1401Response.md +ListIdentityAttributesV1429Response.md +Localeorigin.md README.md +Source2.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/identity_attributes/README.md b/sdk-output/identity_attributes/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/identity_attributes/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/identity_history/.openapi-generator/FILES b/sdk-output/identity_history/.openapi-generator/FILES index 70c4a1c1..60c9c497 100644 --- a/sdk-output/identity_history/.openapi-generator/FILES +++ b/sdk-output/identity_history/.openapi-generator/FILES @@ -1,11 +1,50 @@ .gitignore .npmignore .openapi-generator-ignore +Accessitemaccessprofileresponse.md +AccessitemaccessprofileresponseAppRefsInner.md +Accessitemaccountresponse.md +Accessitemappresponse.md +Accessitemassociated.md +AccessitemassociatedAccessItem.md +Accessitemdiff.md +Accessitementitlementresponse.md +Accessitemremoved.md +Accessitemroleresponse.md +Accessrequested.md +Accessrequestitemresponse.md +Accessrequestresponse2.md +Accountstatuschanged.md +AccountstatuschangedAccount.md +AccountstatuschangedStatusChange.md +Approvalinforesponse.md +Attributechange.md +Attributeschanged.md +Certifierresponse.md +Correlatedgovernanceevent.md +Errormessagedto.md +Errorresponsedto.md +GetHistoricalIdentityEventsV1200ResponseInner.md +IdentityHistoryV1Api.md +IdentityHistoryV1ApideveloperSite_code_examples.yaml +Identitycertified.md +Identitycompareresponse.md +Identityhistoryresponse.md +Identitylistitem.md +Identitysnapshotsummaryresponse.md +Index.md +ListHistoricalIdentitiesV1401Response.md +ListHistoricalIdentitiesV1429Response.md +ListIdentityAccessItemsV1200ResponseInner.md +ListIdentitySnapshotAccessItemsV1200ResponseInner.md +Localeorigin.md +Metricresponse.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/identity_history/README.md b/sdk-output/identity_history/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/identity_history/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/identity_profiles/.openapi-generator/FILES b/sdk-output/identity_profiles/.openapi-generator/FILES index 70c4a1c1..d5f52d1a 100644 --- a/sdk-output/identity_profiles/.openapi-generator/FILES +++ b/sdk-output/identity_profiles/.openapi-generator/FILES @@ -1,11 +1,41 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Basecommondto.md +Errormessagedto.md +Errorresponsedto.md +IdentityProfilesV1Api.md +IdentityProfilesV1ApideveloperSite_code_examples.yaml +Identityattributeconfig.md +Identityattributepreview.md +Identityattributetransform.md +Identityexceptionreportreference.md +Identitypreviewrequest.md +Identitypreviewresponse.md +IdentitypreviewresponseIdentity.md +Identityprofile.md +IdentityprofileAllOfAuthoritativeSource.md +IdentityprofileAllOfOwner.md +Identityprofileexportedobject.md +IdentityprofileexportedobjectSelf.md +Importobject.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListIdentityProfilesV1401Response.md +ListIdentityProfilesV1429Response.md +Localeorigin.md +Objectimportresult.md README.md +Spconfigmessage.md +Taskresultsimplified.md +Transformdefinition.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/identity_profiles/README.md b/sdk-output/identity_profiles/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/identity_profiles/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/jit_access/.openapi-generator/FILES b/sdk-output/jit_access/.openapi-generator/FILES index 70c4a1c1..6a70f368 100644 --- a/sdk-output/jit_access/.openapi-generator/FILES +++ b/sdk-output/jit_access/.openapi-generator/FILES @@ -1,11 +1,23 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetJitActivationConfigV1401Response.md +GetJitActivationConfigV1429Response.md +Index.md +JITAccessV1Api.md +JITAccessV1ApideveloperSite_code_examples.yaml +Jitaccessoperationrequest.md +JitaccessoperationrequestValue.md +Jitactivationconfigresponse.md +Localeorigin.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/jit_access/README.md b/sdk-output/jit_access/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/jit_access/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/jit_activations/.openapi-generator/FILES b/sdk-output/jit_activations/.openapi-generator/FILES index 70c4a1c1..9c498189 100644 --- a/sdk-output/jit_activations/.openapi-generator/FILES +++ b/sdk-output/jit_activations/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +Activationworkflowstatus.md +Errormessagedto.md +Errorresponsedto.md +Index.md +JITActivationsV1Api.md +JITActivationsV1ApideveloperSite_code_examples.yaml +Jitactivationactivaterequest.md +Jitactivationactivateresponse.md +Jitactivationdeactivaterequest.md +Jitactivationdeactivateresponse.md +Jitactivationextendrequest.md +Jitactivationextendresponse.md +Localeorigin.md README.md +StartActivateWorkflowV1401Response.md +StartActivateWorkflowV1429Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/jit_activations/README.md b/sdk-output/jit_activations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/jit_activations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/launchers/.openapi-generator/FILES b/sdk-output/launchers/.openapi-generator/FILES index 70c4a1c1..2b1f416c 100644 --- a/sdk-output/launchers/.openapi-generator/FILES +++ b/sdk-output/launchers/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetLaunchersV1200Response.md +GetLaunchersV1401Response.md +GetLaunchersV1429Response.md +Index.md +Launcher.md +LauncherOwner.md +LauncherReference.md +Launcherrequest.md +LauncherrequestReference.md +LaunchersV1Api.md +LaunchersV1ApideveloperSite_code_examples.yaml +Localeorigin.md README.md +StartLauncherV1200Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/launchers/README.md b/sdk-output/launchers/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/launchers/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/lifecycle_states/.openapi-generator/FILES b/sdk-output/lifecycle_states/.openapi-generator/FILES index 70c4a1c1..08819c7f 100644 --- a/sdk-output/lifecycle_states/.openapi-generator/FILES +++ b/sdk-output/lifecycle_states/.openapi-generator/FILES @@ -1,11 +1,31 @@ .gitignore .npmignore .openapi-generator-ignore +Accessactionconfiguration.md +Accountaction.md +ArrayInner.md +Basecommondto.md +Emailnotificationoption.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +LifecycleStatesV1Api.md +LifecycleStatesV1ApideveloperSite_code_examples.yaml +Lifecyclestate.md +Lifecyclestatedeleted.md +Localeorigin.md README.md +SetLifecycleStateV1200Response.md +SetLifecycleStateV1401Response.md +SetLifecycleStateV1429Response.md +SetLifecycleStateV1Request.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/lifecycle_states/README.md b/sdk-output/lifecycle_states/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/lifecycle_states/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_account_classify/.openapi-generator/FILES b/sdk-output/machine_account_classify/.openapi-generator/FILES index 70c4a1c1..2bf35ec5 100644 --- a/sdk-output/machine_account_classify/.openapi-generator/FILES +++ b/sdk-output/machine_account_classify/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md +MachineAccountClassifyV1Api.md +MachineAccountClassifyV1ApideveloperSite_code_examples.yaml README.md +SendClassifyMachineAccountV1200Response.md +SendClassifyMachineAccountV1401Response.md +SendClassifyMachineAccountV1429Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_account_classify/README.md b/sdk-output/machine_account_classify/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_account_classify/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_account_creation_request/.openapi-generator/FILES b/sdk-output/machine_account_creation_request/.openapi-generator/FILES index 70c4a1c1..1a2689b1 100644 --- a/sdk-output/machine_account_creation_request/.openapi-generator/FILES +++ b/sdk-output/machine_account_creation_request/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +Accountrequestasyncresult.md +Accountrequestdetailsdto.md +AccountrequestdetailsdtoRequester.md +Accountrequestphase.md +Accountrequestphasestate.md +Basereferencedto.md +CreateMachineAccountRequestV1401Response.md +CreateMachineAccountRequestV1429Response.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md +MachineAccountCreationRequestV1Api.md +MachineAccountCreationRequestV1ApideveloperSite_code_examples.yaml +Machineaccountcreateaccessdto.md +MachineaccountcreateaccessdtoSubtypesInner.md +Machineaccountcreaterequestinput.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_account_creation_request/README.md b/sdk-output/machine_account_creation_request/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_account_creation_request/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_account_mappings/.openapi-generator/FILES b/sdk-output/machine_account_mappings/.openapi-generator/FILES index 70c4a1c1..35363f62 100644 --- a/sdk-output/machine_account_mappings/.openapi-generator/FILES +++ b/sdk-output/machine_account_mappings/.openapi-generator/FILES @@ -1,11 +1,26 @@ .gitignore .npmignore .openapi-generator-ignore +Attributemappings.md +AttributemappingsAllOfTarget.md +AttributemappingsAllOfTransformDefinition.md +AttributemappingsAllOfTransformDefinitionAttributes.md +AttributemappingsAllOfTransformDefinitionAttributesInput.md +AttributemappingsAllOfTransformDefinitionAttributesInputAttributes.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListMachineAccountMappingsV1401Response.md +ListMachineAccountMappingsV1429Response.md +Localeorigin.md +MachineAccountMappingsV1Api.md +MachineAccountMappingsV1ApideveloperSite_code_examples.yaml README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_account_mappings/README.md b/sdk-output/machine_account_mappings/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_account_mappings/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_account_subtypes/.openapi-generator/FILES b/sdk-output/machine_account_subtypes/.openapi-generator/FILES index 70c4a1c1..751c6d4d 100644 --- a/sdk-output/machine_account_subtypes/.openapi-generator/FILES +++ b/sdk-output/machine_account_subtypes/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +CreateSourceSubtypeV1Request.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +LoadBulkSourceSubtypesV1401Response.md +LoadBulkSourceSubtypesV1429Response.md +Localeorigin.md +MachineAccountSubtypesV1Api.md +MachineAccountSubtypesV1ApideveloperSite_code_examples.yaml +Machineaccountsubtypeconfigdto.md +MachineaccountsubtypeconfigdtoMachineAccountCreate.md +MachineaccountsubtypeconfigdtoMachineAccountDelete.md +Machinesubtypeapprovalconfig.md README.md +Sourcesubtypewithsource.md +SourcesubtypewithsourceSource.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_account_subtypes/README.md b/sdk-output/machine_account_subtypes/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_account_subtypes/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_accounts/.openapi-generator/FILES b/sdk-output/machine_accounts/.openapi-generator/FILES index 70c4a1c1..e7fd3b75 100644 --- a/sdk-output/machine_accounts/.openapi-generator/FILES +++ b/sdk-output/machine_accounts/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +Basecommondto.md +CreateMachineAccountSubtypeV1Request.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListMachineAccountsV1401Response.md +ListMachineAccountsV1429Response.md +Localeorigin.md +MachineAccountsV1Api.md +MachineAccountsV1ApideveloperSite_code_examples.yaml +Machineaccount.md README.md +Sourcesubtype.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_accounts/README.md b/sdk-output/machine_accounts/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_accounts/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_classification_config/.openapi-generator/FILES b/sdk-output/machine_classification_config/.openapi-generator/FILES index 70c4a1c1..d7509daa 100644 --- a/sdk-output/machine_classification_config/.openapi-generator/FILES +++ b/sdk-output/machine_classification_config/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetMachineClassificationConfigV1401Response.md +GetMachineClassificationConfigV1429Response.md +Index.md +Localeorigin.md +MachineClassificationConfigV1Api.md +MachineClassificationConfigV1ApideveloperSite_code_examples.yaml +Machineclassificationconfig.md +Machineclassificationcriterialevel1.md +Machineclassificationcriterialevel2.md +Machineclassificationcriterialevel3.md +Machineclassificationcriteriaoperation.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_classification_config/README.md b/sdk-output/machine_classification_config/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_classification_config/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/machine_identities/.openapi-generator/FILES b/sdk-output/machine_identities/.openapi-generator/FILES index 70c4a1c1..4af72bf6 100644 --- a/sdk-output/machine_identities/.openapi-generator/FILES +++ b/sdk-output/machine_identities/.openapi-generator/FILES @@ -1,11 +1,40 @@ .gitignore .npmignore .openapi-generator-ignore +Basecommondto.md +Basereferencedto.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListMachineIdentitiesV1401Response.md +ListMachineIdentitiesV1429Response.md +Localeorigin.md +Localizedmessage.md +MachineIdentitiesV1Api.md +MachineIdentitiesV1ApideveloperSite_code_examples.yaml +MachineIdentityDtoOwners.md +MachineIdentityRequestUserEntitlements.md +MachineIdentityResponseUserEntitlements.md +Machineidentity.md +Machineidentityaggregationrequest.md +Machineidentityaggregationresponse.md +MachineidentityaggregationresponseTarget.md +Machineidentityrequest.md +Machineidentityresponse.md +Machineidentityuserentitlementresponse.md +MachineidentityuserentitlementresponseEntitlement.md +MachineidentityuserentitlementresponseSource.md README.md +Taskdefinitionsummary.md +Taskreturndetails.md +Taskstatusmessage.md +TaskstatusmessageParametersInner.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/machine_identities/README.md b/sdk-output/machine_identities/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/machine_identities/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/managed_clients/.openapi-generator/FILES b/sdk-output/managed_clients/.openapi-generator/FILES index 70c4a1c1..5b00939c 100644 --- a/sdk-output/managed_clients/.openapi-generator/FILES +++ b/sdk-output/managed_clients/.openapi-generator/FILES @@ -1,11 +1,33 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetManagedClientsV1401Response.md +GetManagedClientsV1429Response.md +Healthevent.md +Healthindicatorcategory.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +ManagedClientsV1Api.md +ManagedClientsV1ApideveloperSite_code_examples.yaml +Managedclient.md +Managedclienthealthindicators.md +ManagedclienthealthindicatorsBody.md +ManagedclienthealthindicatorsBodyHealthIndicators.md +Managedclientrequest.md +Managedclientstatus.md +Managedclientstatuscode.md +Managedclienttype.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/managed_clients/README.md b/sdk-output/managed_clients/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/managed_clients/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/managed_cluster_types/.openapi-generator/FILES b/sdk-output/managed_cluster_types/.openapi-generator/FILES index 70c4a1c1..73fbb0a6 100644 --- a/sdk-output/managed_cluster_types/.openapi-generator/FILES +++ b/sdk-output/managed_cluster_types/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetManagedClusterTypesV1401Response.md +GetManagedClusterTypesV1429Response.md +Index.md +Jsonpatch.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +ManagedClusterTypesV1Api.md +ManagedClusterTypesV1ApideveloperSite_code_examples.yaml +Managedclustertype.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/managed_cluster_types/README.md b/sdk-output/managed_cluster_types/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/managed_cluster_types/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/managed_clusters/.openapi-generator/FILES b/sdk-output/managed_clusters/.openapi-generator/FILES index 70c4a1c1..edcee4ce 100644 --- a/sdk-output/managed_clusters/.openapi-generator/FILES +++ b/sdk-output/managed_clusters/.openapi-generator/FILES @@ -1,11 +1,46 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Clientlogconfiguration.md +Clientlogconfigurationdurationminutes.md +Clientlogconfigurationexpiration.md +Clustermanualupgrade.md +ClustermanualupgradeJobsInner.md +ClustermanualupgradeJobsInnerManagedProcessConfiguration.md +ClustermanualupgradeJobsInnerManagedProcessConfigurationCcg.md +ClustermanualupgradeJobsInnerManagedProcessConfigurationCharon.md +ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgent.md +ClustermanualupgradeJobsInnerManagedProcessConfigurationRelay.md +ClustermanualupgradeJobsInnerManagedProcessConfigurationToolbox.md +Errormessagedto.md +Errorresponsedto.md +GetManagedClustersV1401Response.md +GetManagedClustersV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +ManagedClustersV1Api.md +ManagedClustersV1ApideveloperSite_code_examples.yaml +Managedclienttype.md +Managedcluster.md +ManagedclusterUpdatePreferences.md +Managedclusterattributes.md +Managedclusterencryptionconfig.md +Managedclusterkeypair.md +Managedclusterqueue.md +Managedclusterredis.md +Managedclusterrequest.md +Managedclustertypes.md +PutClientLogConfigurationV1Request.md README.md +Standardlevel.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/managed_clusters/README.md b/sdk-output/managed_clusters/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/managed_clusters/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/mfa_configuration/.openapi-generator/FILES b/sdk-output/mfa_configuration/.openapi-generator/FILES index 70c4a1c1..2552ff8d 100644 --- a/sdk-output/mfa_configuration/.openapi-generator/FILES +++ b/sdk-output/mfa_configuration/.openapi-generator/FILES @@ -1,11 +1,26 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetMFAOktaConfigV1401Response.md +GetMFAOktaConfigV1429Response.md +Index.md +Kbaanswerrequestitem.md +Kbaanswerresponseitem.md +Kbaquestion.md +Localeorigin.md +MFAConfigurationV1Api.md +MFAConfigurationV1ApideveloperSite_code_examples.yaml +Mfaconfigtestresponse.md +Mfaduoconfig.md +Mfaoktaconfig.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/mfa_configuration/README.md b/sdk-output/mfa_configuration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/mfa_configuration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/multi_host_integration/.openapi-generator/FILES b/sdk-output/multi_host_integration/.openapi-generator/FILES index 70c4a1c1..45eeeef7 100644 --- a/sdk-output/multi_host_integration/.openapi-generator/FILES +++ b/sdk-output/multi_host_integration/.openapi-generator/FILES @@ -1,11 +1,47 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetMultiHostIntegrationsListV1401Response.md +GetMultiHostIntegrationsListV1429Response.md +Index.md +Localeorigin.md +Managercorrelationmapping.md +MultiHostIntegrationV1Api.md +MultiHostIntegrationV1ApideveloperSite_code_examples.yaml +Multihostintegrations.md +MultihostintegrationsAccountCorrelationConfig.md +MultihostintegrationsAccountCorrelationRule.md +MultihostintegrationsAccountsFile.md +MultihostintegrationsBeforeProvisioningRule.md +MultihostintegrationsCluster.md +MultihostintegrationsConnectorAttributes.md +MultihostintegrationsConnectorAttributesConnectorFileUploadHistory.md +MultihostintegrationsConnectorAttributesMultiHostAttributes.md +MultihostintegrationsManagementWorkgroup.md +MultihostintegrationsManagerCorrelationMapping.md +MultihostintegrationsManagerCorrelationRule.md +MultihostintegrationsOwner.md +MultihostintegrationsPasswordPoliciesInner.md +MultihostintegrationsSchemasInner.md +Multihostintegrationsaggscheduleupdate.md +Multihostintegrationscreate.md +Multihostintegrationscreatesources.md +Multihostintegrationtemplatetype.md +Multihostsources.md +MultihostsourcesBeforeProvisioningRule.md README.md +Sourcecreationerrors.md +TestSourceConnectionMultihostV1200Response.md +UpdateMultiHostSourcesV1RequestInner.md +UpdateMultiHostSourcesV1RequestInnerValue.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/multi_host_integration/README.md b/sdk-output/multi_host_integration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/multi_host_integration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES b/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES index 70c4a1c1..ff128884 100644 --- a/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES +++ b/sdk-output/non_employee_lifecycle_management/.openapi-generator/FILES @@ -1,11 +1,52 @@ .gitignore .npmignore .openapi-generator-ignore +Approvalstatus.md +ArrayInner.md +DeleteNonEmployeeRecordsInBulkV1Request.md +Errormessagedto.md +Errorresponsedto.md +ImportNonEmployeeRecordsInBulkV1Request.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListNonEmployeeRecordsV1401Response.md +ListNonEmployeeRecordsV1429Response.md +Localeorigin.md +NonEmployeeLifecycleManagementV1Api.md +NonEmployeeLifecycleManagementV1ApideveloperSite_code_examples.yaml +Nonemployeeapprovaldecision.md +Nonemployeeapprovalitem.md +Nonemployeeapprovalitembase.md +Nonemployeeapprovalitemdetail.md +Nonemployeeapprovalsummary.md +Nonemployeebulkuploadjob.md +Nonemployeebulkuploadstatus.md +Nonemployeeidentitydtotype.md +Nonemployeeidentityreferencewithid.md +Nonemployeeidnuserrequest.md +Nonemployeerecord.md +Nonemployeerejectapprovaldecision.md +Nonemployeerequest.md +Nonemployeerequestbody.md +Nonemployeerequestlite.md +Nonemployeerequestsummary.md +Nonemployeerequestwithoutapprovalitem.md +Nonemployeeschemaattribute.md +Nonemployeeschemaattributebody.md +Nonemployeeschemaattributetype.md +Nonemployeesource.md +Nonemployeesourcelite.md +Nonemployeesourcelitewithschemaattributes.md +Nonemployeesourcerequestbody.md +Nonemployeesourcewithcloudexternalid.md +Nonemployeesourcewithnecount.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/non_employee_lifecycle_management/README.md b/sdk-output/non_employee_lifecycle_management/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/non_employee_lifecycle_management/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/notifications/.openapi-generator/FILES b/sdk-output/notifications/.openapi-generator/FILES index 70c4a1c1..6225ff7e 100644 --- a/sdk-output/notifications/.openapi-generator/FILES +++ b/sdk-output/notifications/.openapi-generator/FILES @@ -1,11 +1,43 @@ .gitignore .npmignore .openapi-generator-ignore +CreateDomainDkimV1405Response.md +Dkimattributes.md +Domainaddress.md +Domainstatusdto.md +Emailstatusdto.md +Errormessagedto.md +Errorresponsedto.md +GetNotificationTemplateVariablesV1401Response.md +GetNotificationTemplateVariablesV1429Response.md +Index.md +Localeorigin.md +Mailfromattributes.md +Mailfromattributesdto.md +Medium.md +NotificationsV1Api.md +NotificationsV1ApideveloperSite_code_examples.yaml +Notificationtemplatecontext.md +Preferencesdto.md README.md +Sendtestnotificationrequestdto.md +Templatebulkdeletedto.md +Templatedto.md +TemplatedtoSlackTemplate.md +TemplatedtoTeamsTemplate.md +Templatedtodefault.md +Templatemediumdto.md +Templateslack.md +TemplateslackAutoApprovalData.md +TemplateslackCustomFields.md +Templateteams.md +Templatevariable.md +Templatevariablesdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/notifications/README.md b/sdk-output/notifications/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/notifications/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/oauth_clients/.openapi-generator/FILES b/sdk-output/oauth_clients/.openapi-generator/FILES index 70c4a1c1..a8760432 100644 --- a/sdk-output/oauth_clients/.openapi-generator/FILES +++ b/sdk-output/oauth_clients/.openapi-generator/FILES @@ -1,11 +1,29 @@ .gitignore .npmignore .openapi-generator-ignore +Accesstype.md +ArrayInner.md +Clienttype.md +Createoauthclientrequest.md +Createoauthclientresponse.md +Errormessagedto.md +Errorresponsedto.md +Getoauthclientresponse.md +Granttype.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListOauthClientsV1401Response.md +ListOauthClientsV1429Response.md +Localeorigin.md +OAuthClientsV1Api.md +OAuthClientsV1ApideveloperSite_code_examples.yaml README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/oauth_clients/README.md b/sdk-output/oauth_clients/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/oauth_clients/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/org_config/.openapi-generator/FILES b/sdk-output/org_config/.openapi-generator/FILES index 70c4a1c1..eb947036 100644 --- a/sdk-output/org_config/.openapi-generator/FILES +++ b/sdk-output/org_config/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetOrgConfigV1401Response.md +GetOrgConfigV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +OrgConfigV1Api.md +OrgConfigV1ApideveloperSite_code_examples.yaml +Orgconfig.md README.md +Reportconfigdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/org_config/README.md b/sdk-output/org_config/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/org_config/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/parameter_storage/.openapi-generator/FILES b/sdk-output/parameter_storage/.openapi-generator/FILES index 70c4a1c1..355706ce 100644 --- a/sdk-output/parameter_storage/.openapi-generator/FILES +++ b/sdk-output/parameter_storage/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +DeleteParameterV1409Response.md +Errormessagedto.md +Errorresponsedto.md +GetAttestationDocumentV1401Response.md +GetAttestationDocumentV1429Response.md +Index.md +Localeorigin.md +ParameterStorageV1Api.md +ParameterStorageV1ApideveloperSite_code_examples.yaml +Parameterstorageattestationdocument.md +Parameterstoragejsonpatch.md +Parameterstoragenewparameter.md +Parameterstorageparameter.md +Parameterstoragereference.md +Parameterstorageupdateparameter.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/parameter_storage/README.md b/sdk-output/parameter_storage/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/parameter_storage/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/password_configuration/.openapi-generator/FILES b/sdk-output/password_configuration/.openapi-generator/FILES index 70c4a1c1..87976a8f 100644 --- a/sdk-output/password_configuration/.openapi-generator/FILES +++ b/sdk-output/password_configuration/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPasswordOrgConfigV1401Response.md +GetPasswordOrgConfigV1429Response.md +Index.md +Localeorigin.md +PasswordConfigurationV1Api.md +PasswordConfigurationV1ApideveloperSite_code_examples.yaml +Passwordorgconfig.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/password_configuration/README.md b/sdk-output/password_configuration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/password_configuration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/password_dictionary/.openapi-generator/FILES b/sdk-output/password_dictionary/.openapi-generator/FILES index 70c4a1c1..86065f85 100644 --- a/sdk-output/password_dictionary/.openapi-generator/FILES +++ b/sdk-output/password_dictionary/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPasswordDictionaryV1401Response.md +GetPasswordDictionaryV1429Response.md +Index.md +Localeorigin.md +PasswordDictionaryV1Api.md +PasswordDictionaryV1ApideveloperSite_code_examples.yaml +PutPasswordDictionaryV1Request.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/password_dictionary/README.md b/sdk-output/password_dictionary/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/password_dictionary/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/password_management/.openapi-generator/FILES b/sdk-output/password_management/.openapi-generator/FILES index 70c4a1c1..7283133b 100644 --- a/sdk-output/password_management/.openapi-generator/FILES +++ b/sdk-output/password_management/.openapi-generator/FILES @@ -1,11 +1,28 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md +PasswordManagementV1Api.md +PasswordManagementV1ApideveloperSite_code_examples.yaml +Passwordchangerequest.md +Passwordchangeresponse.md +Passworddigittoken.md +Passworddigittokenreset.md +Passwordinfo.md +Passwordinfoaccount.md +Passwordinfoquerydto.md +Passwordstatus.md +QueryPasswordInfoV1401Response.md +QueryPasswordInfoV1429Response.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/password_management/README.md b/sdk-output/password_management/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/password_management/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/password_policies/.openapi-generator/FILES b/sdk-output/password_policies/.openapi-generator/FILES index 70c4a1c1..2e48cbd9 100644 --- a/sdk-output/password_policies/.openapi-generator/FILES +++ b/sdk-output/password_policies/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPasswordPolicyByIdV1401Response.md +GetPasswordPolicyByIdV1429Response.md +Index.md +Localeorigin.md +PasswordPoliciesV1Api.md +PasswordPoliciesV1ApideveloperSite_code_examples.yaml +Passwordpolicyv3dto.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/password_policies/README.md b/sdk-output/password_policies/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/password_policies/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/password_sync_groups/.openapi-generator/FILES b/sdk-output/password_sync_groups/.openapi-generator/FILES index 70c4a1c1..a95bf10b 100644 --- a/sdk-output/password_sync_groups/.openapi-generator/FILES +++ b/sdk-output/password_sync_groups/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPasswordSyncGroupsV1401Response.md +GetPasswordSyncGroupsV1429Response.md +Index.md +Localeorigin.md +PasswordSyncGroupsV1Api.md +PasswordSyncGroupsV1ApideveloperSite_code_examples.yaml +Passwordsyncgroup.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/password_sync_groups/README.md b/sdk-output/password_sync_groups/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/password_sync_groups/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/personal_access_tokens/.openapi-generator/FILES b/sdk-output/personal_access_tokens/.openapi-generator/FILES index 70c4a1c1..89d2d709 100644 --- a/sdk-output/personal_access_tokens/.openapi-generator/FILES +++ b/sdk-output/personal_access_tokens/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Createpersonalaccesstokenrequest.md +Createpersonalaccesstokenresponse.md +Errormessagedto.md +Errorresponsedto.md +Getpersonalaccesstokenresponse.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListPersonalAccessTokensV1401Response.md +ListPersonalAccessTokensV1429Response.md +Localeorigin.md +Patowner.md +PersonalAccessTokensV1Api.md +PersonalAccessTokensV1ApideveloperSite_code_examples.yaml README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/personal_access_tokens/README.md b/sdk-output/personal_access_tokens/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/personal_access_tokens/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/privilege_criteria/.openapi-generator/FILES b/sdk-output/privilege_criteria/.openapi-generator/FILES index 70c4a1c1..bbb5d4f6 100644 --- a/sdk-output/privilege_criteria/.openapi-generator/FILES +++ b/sdk-output/privilege_criteria/.openapi-generator/FILES @@ -1,11 +1,26 @@ .gitignore .npmignore .openapi-generator-ignore +Createprivilegecriteriarequest.md +CreateprivilegecriteriarequestGroupsInner.md +CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInner.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListPrivilegeCriteriaV1401Response.md +ListPrivilegeCriteriaV1429Response.md +Localeorigin.md +PrivilegeCriteriaV1Api.md +PrivilegeCriteriaV1ApideveloperSite_code_examples.yaml +Privilegecriteriadto.md +PrivilegecriteriadtoGroupsInner.md +PrivilegecriteriadtoGroupsInnerCriteriaItemsInner.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/privilege_criteria/README.md b/sdk-output/privilege_criteria/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/privilege_criteria/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES b/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES index 70c4a1c1..fd959a0d 100644 --- a/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES +++ b/sdk-output/privilege_criteria_configuration/.openapi-generator/FILES @@ -1,11 +1,21 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPrivilegeCriteriaConfigV1401Response.md +GetPrivilegeCriteriaConfigV1429Response.md +Index.md +Localeorigin.md +PrivilegeCriteriaConfigurationV1Api.md +PrivilegeCriteriaConfigurationV1ApideveloperSite_code_examples.yaml +Privilegecriteriaconfigdto.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/privilege_criteria_configuration/README.md b/sdk-output/privilege_criteria_configuration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/privilege_criteria_configuration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/prompt_insights/.openapi-generator/FILES b/sdk-output/prompt_insights/.openapi-generator/FILES index 70c4a1c1..e3c4bbb7 100644 --- a/sdk-output/prompt_insights/.openapi-generator/FILES +++ b/sdk-output/prompt_insights/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetPromptInsightsMetricsV1401Response.md +GetPromptInsightsMetricsV1429Response.md +Index.md +Localeorigin.md +PromptInsightsV1Api.md +PromptInsightsV1ApideveloperSite_code_examples.yaml +Promptinsight.md +Promptinsightsmetrics.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/prompt_insights/README.md b/sdk-output/prompt_insights/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/prompt_insights/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/public_identities/.openapi-generator/FILES b/sdk-output/public_identities/.openapi-generator/FILES index 70c4a1c1..fba72f86 100644 --- a/sdk-output/public_identities/.openapi-generator/FILES +++ b/sdk-output/public_identities/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetPublicIdentitiesV1401Response.md +GetPublicIdentitiesV1429Response.md +Identityreference.md +Index.md +Localeorigin.md +PublicIdentitiesV1Api.md +PublicIdentitiesV1ApideveloperSite_code_examples.yaml +Publicidentity.md +PublicidentityAttributesInner.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/public_identities/README.md b/sdk-output/public_identities/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/public_identities/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/public_identities_config/.openapi-generator/FILES b/sdk-output/public_identities_config/.openapi-generator/FILES index 70c4a1c1..89fdbe3e 100644 --- a/sdk-output/public_identities_config/.openapi-generator/FILES +++ b/sdk-output/public_identities_config/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetPublicIdentityConfigV1401Response.md +GetPublicIdentityConfigV1429Response.md +Identityreference.md +Index.md +Localeorigin.md +PublicIdentitiesConfigV1Api.md +PublicIdentitiesConfigV1ApideveloperSite_code_examples.yaml +Publicidentityattributeconfig.md +Publicidentityconfig.md README.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/public_identities_config/README.md b/sdk-output/public_identities_config/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/public_identities_config/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/reports_data_extraction/.openapi-generator/FILES b/sdk-output/reports_data_extraction/.openapi-generator/FILES index 70c4a1c1..d14a4f46 100644 --- a/sdk-output/reports_data_extraction/.openapi-generator/FILES +++ b/sdk-output/reports_data_extraction/.openapi-generator/FILES @@ -1,11 +1,34 @@ .gitignore .npmignore .openapi-generator-ignore +AccountsExportReportArguments.md +Errormessagedto.md +Errorresponsedto.md +GetReportResultV1401Response.md +GetReportResultV1429Response.md +IdentitiesDetailsReportArguments.md +IdentitiesReportArguments.md +IdentityProfileIdentityErrorReportArguments.md +Index.md +Index.md +Localeorigin.md +OrphanIdentitiesReportArguments.md README.md +Reportdetails.md +ReportdetailsArguments.md +Reportresults.md +ReportsDataExtractionV1Api.md +ReportsDataExtractionV1ApideveloperSite_code_examples.yaml +SearchExportReportArguments.md +Taskresultdetails.md +TaskresultdetailsMessagesInner.md +TaskresultdetailsReturnsInner.md +UncorrelatedAccountsReportArguments.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/reports_data_extraction/README.md b/sdk-output/reports_data_extraction/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/reports_data_extraction/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/requestable_objects/.openapi-generator/FILES b/sdk-output/requestable_objects/.openapi-generator/FILES index 70c4a1c1..44676d9e 100644 --- a/sdk-output/requestable_objects/.openapi-generator/FILES +++ b/sdk-output/requestable_objects/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Identityreferencewithnameandemail.md +Index.md +ListRequestableObjectsV1401Response.md +ListRequestableObjectsV1429Response.md +Localeorigin.md README.md +RequestableObjectsV1Api.md +RequestableObjectsV1ApideveloperSite_code_examples.yaml +Requestableobject.md +Requestableobjectrequeststatus.md +Requestableobjecttype.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/requestable_objects/README.md b/sdk-output/requestable_objects/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/requestable_objects/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/role_insights/.openapi-generator/FILES b/sdk-output/role_insights/.openapi-generator/FILES index 70c4a1c1..f0f333a7 100644 --- a/sdk-output/role_insights/.openapi-generator/FILES +++ b/sdk-output/role_insights/.openapi-generator/FILES @@ -1,11 +1,28 @@ .gitignore .npmignore .openapi-generator-ignore +CreateRoleInsightRequestsV1401Response.md +CreateRoleInsightRequestsV1429Response.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md README.md +RoleInsightsV1Api.md +RoleInsightsV1ApideveloperSite_code_examples.yaml +Roleinsight.md +Roleinsightsentitlement.md +Roleinsightsentitlementchanges.md +Roleinsightsidentities.md +Roleinsightsinsight.md +Roleinsightsresponse.md +Roleinsightsrole.md +Roleinsightssummary.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/role_insights/README.md b/sdk-output/role_insights/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/role_insights/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/role_propagation/.openapi-generator/FILES b/sdk-output/role_propagation/.openapi-generator/FILES index 70c4a1c1..4bd17367 100644 --- a/sdk-output/role_propagation/.openapi-generator/FILES +++ b/sdk-output/role_propagation/.openapi-generator/FILES @@ -1,11 +1,28 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Index.md +Localeorigin.md README.md +RolePropagationConfigInput.md +RolePropagationConfigResponse.md +RolePropagationOngoingResponse.md +RolePropagationOngoingResponseRolePropagationDetails.md +RolePropagationResponse.md +RolePropagationStatusResponse.md +RolePropagationStatusResponseLaunchedBy.md +RolePropagationStatusResponseTerminatedBy.md +RolePropagationV1Api.md +RolePropagationV1ApideveloperSite_code_examples.yaml +StartRolePropagationV1401Response.md +StartRolePropagationV1429Response.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/role_propagation/README.md b/sdk-output/role_propagation/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/role_propagation/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/roles/.openapi-generator/FILES b/sdk-output/roles/.openapi-generator/FILES index 70c4a1c1..c812baf1 100644 --- a/sdk-output/roles/.openapi-generator/FILES +++ b/sdk-output/roles/.openapi-generator/FILES @@ -1,11 +1,69 @@ .gitignore .npmignore .openapi-generator-ignore +Accessduration.md +Accessmodelmetadata.md +AccessmodelmetadataValuesInner.md +Accessprofileref.md +Additionalownerref.md +Approvalschemeforrole.md +ArrayInner.md +Attributedto.md +Attributedtolist.md +Attributevaluedto.md +Dimensionattribute.md +Dimensionref.md +Dimensionschema.md +Dtotype.md +Entitlement.md +EntitlementAccessModelMetadata.md +EntitlementOwner.md +EntitlementSource.md +Entitlementref.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListRolesV1401Response.md +ListRolesV1429Response.md +Localeorigin.md +Ownerreference.md +Permissiondto.md README.md +Requestabilityforrole.md +Revocabilityforrole.md +Role.md +Roleassignmentsourcetype.md +Rolebulkdeleterequest.md +Rolebulkupdateresponse.md +Rolecriteriakey.md +Rolecriteriakeytype.md +Rolecriterialevel1.md +Rolecriterialevel2.md +Rolecriterialevel3.md +Rolecriteriaoperation.md +Rolegetallbulkupdateresponse.md +Roleidentity.md +Rolelistfilterdto.md +RolelistfilterdtoAmmKeyValuesInner.md +Rolemembershipidentity.md +Rolemembershipselector.md +Rolemembershipselectortype.md +Rolemetadatabulkupdatebyfilterrequest.md +RolemetadatabulkupdatebyfilterrequestValuesInner.md +Rolemetadatabulkupdatebyidrequest.md +RolemetadatabulkupdatebyidrequestValuesInner.md +Rolemetadatabulkupdatebyqueryrequest.md +RolemetadatabulkupdatebyqueryrequestValuesInner.md +RolesV1Api.md +RolesV1ApideveloperSite_code_examples.yaml +Taskresultdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/roles/README.md b/sdk-output/roles/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/roles/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/saved_search/.openapi-generator/FILES b/sdk-output/saved_search/.openapi-generator/FILES index 70c4a1c1..2516dbd4 100644 --- a/sdk-output/saved_search/.openapi-generator/FILES +++ b/sdk-output/saved_search/.openapi-generator/FILES @@ -1,11 +1,34 @@ .gitignore .npmignore .openapi-generator-ignore +Bound.md +Column.md +CreateSavedSearchV1Request.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Filter.md +Filtertype.md +Index.md +Index.md +ListSavedSearchesV1401Response.md +ListSavedSearchesV1429Response.md +Localeorigin.md README.md +Range.md +SavedSearchV1Api.md +SavedSearchV1ApideveloperSite_code_examples.yaml +Savedsearch.md +Savedsearchdetail.md +SavedsearchdetailFilters.md +Savedsearchname.md +Searcharguments.md +Typedreference.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/saved_search/README.md b/sdk-output/saved_search/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/saved_search/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/scheduled_search/.openapi-generator/FILES b/sdk-output/scheduled_search/.openapi-generator/FILES index 70c4a1c1..dc86e929 100644 --- a/sdk-output/scheduled_search/.openapi-generator/FILES +++ b/sdk-output/scheduled_search/.openapi-generator/FILES @@ -1,11 +1,35 @@ .gitignore .npmignore .openapi-generator-ignore +CreateScheduledSearchV1Request.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListScheduledSearchV1401Response.md +ListScheduledSearchV1429Response.md +Localeorigin.md README.md +Schedule.md +ScheduleDays.md +ScheduleHours.md +ScheduleMonths.md +ScheduledSearchV1Api.md +ScheduledSearchV1ApideveloperSite_code_examples.yaml +Scheduledsearch.md +ScheduledsearchAllOfOwner.md +Scheduledsearchname.md +Scheduletype.md +Searchschedule.md +SearchscheduleRecipientsInner.md +Selector.md +Selectortype.md +Typedreference.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/scheduled_search/README.md b/sdk-output/scheduled_search/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/scheduled_search/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/search/.openapi-generator/FILES b/sdk-output/search/.openapi-generator/FILES index 70c4a1c1..c0be33f6 100644 --- a/sdk-output/search/.openapi-generator/FILES +++ b/sdk-output/search/.openapi-generator/FILES @@ -1,11 +1,44 @@ .gitignore .npmignore .openapi-generator-ignore +Aggregationresult.md +Aggregations.md +Aggregationtype.md +Bound.md +Bucketaggregation.md +Buckettype.md +Errormessagedto.md +Errorresponsedto.md +Filter.md +Filteraggregation.md +Filtertype.md +Index.md +Index.md +Innerhit.md +Localeorigin.md +Metricaggregation.md +Metrictype.md +Nestedaggregation.md +Query.md +Queryresultfilter.md +Querytype.md README.md +Range.md +Search.md +SearchPostV1401Response.md +SearchPostV1429Response.md +SearchV1Api.md +SearchV1ApideveloperSite_code_examples.yaml +Searchaggregationspecification.md +Searchfiltertype.md +Subsearchaggregationspecification.md +Textquery.md +Typeaheadquery.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/search/README.md b/sdk-output/search/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/search/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/search_attribute_configuration/.openapi-generator/FILES b/sdk-output/search_attribute_configuration/.openapi-generator/FILES index 70c4a1c1..0bfda923 100644 --- a/sdk-output/search_attribute_configuration/.openapi-generator/FILES +++ b/sdk-output/search_attribute_configuration/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetSearchAttributeConfigV1401Response.md +GetSearchAttributeConfigV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md README.md +SearchAttributeConfigurationV1Api.md +SearchAttributeConfigurationV1ApideveloperSite_code_examples.yaml +Searchattributeconfig.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/search_attribute_configuration/README.md b/sdk-output/search_attribute_configuration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/search_attribute_configuration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/segments/.openapi-generator/FILES b/sdk-output/segments/.openapi-generator/FILES index 70c4a1c1..b94dabff 100644 --- a/sdk-output/segments/.openapi-generator/FILES +++ b/sdk-output/segments/.openapi-generator/FILES @@ -1,11 +1,27 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Expression.md +ExpressionChildrenInner.md +Index.md +ListSegmentsV1401Response.md +ListSegmentsV1429Response.md +Localeorigin.md +Ownerreferencesegments.md README.md +Segment.md +SegmentVisibilityCriteria.md +SegmentsV1Api.md +SegmentsV1ApideveloperSite_code_examples.yaml +Value.md +Visibilitycriteria.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/segments/README.md b/sdk-output/segments/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/segments/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/service_desk_integration/.openapi-generator/FILES b/sdk-output/service_desk_integration/.openapi-generator/FILES index 70c4a1c1..a89daa77 100644 --- a/sdk-output/service_desk_integration/.openapi-generator/FILES +++ b/sdk-output/service_desk_integration/.openapi-generator/FILES @@ -1,11 +1,34 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Basecommondto.md +Beforeprovisioningruledto.md +Errormessagedto.md +Errorresponsedto.md +GetServiceDeskIntegrationsV1401Response.md +GetServiceDeskIntegrationsV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Ownerdto.md +Provisioningconfig.md +ProvisioningconfigPlanInitializerScript.md +Queuedcheckconfigdetails.md README.md +ServiceDeskIntegrationV1Api.md +ServiceDeskIntegrationV1ApideveloperSite_code_examples.yaml +Servicedeskintegrationdto.md +Servicedeskintegrationtemplatedto.md +Servicedeskintegrationtemplatetype.md +Servicedesksource.md +Sourceclusterdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/service_desk_integration/README.md b/sdk-output/service_desk_integration/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/service_desk_integration/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES b/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES index 70c4a1c1..d9c5a326 100644 --- a/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES +++ b/sdk-output/shared_signals_framework_ssf/.openapi-generator/FILES @@ -1,11 +1,37 @@ .gitignore .npmignore .openapi-generator-ignore +Authorizationscheme.md +Createstreamdeliveryrequest.md +Createstreamrequest.md +Deliveryrequest.md +Deliveryresponse.md +Errormessagedto.md +Errorresponsedto.md +GetSSFConfigurationV1401Response.md +GetSSFConfigurationV1429Response.md +GetStreamV1200Response.md +Index.md +Jwk.md +Jwks.md +Localeorigin.md README.md +Replacestreamconfigurationrequest.md +ReplacestreamconfigurationrequestDelivery.md +SharedSignalsFrameworkSSFV1Api.md +SharedSignalsFrameworkSSFV1ApideveloperSite_code_examples.yaml +Streamconfigresponse.md +Streamstatusresponse.md +Transmittermetadata.md +Updatestreamconfigresponse.md +Updatestreamconfigurationrequest.md +Updatestreamstatusrequest.md +Verificationrequest.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/shared_signals_framework_ssf/README.md b/sdk-output/shared_signals_framework_ssf/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/shared_signals_framework_ssf/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/sim_integrations/.openapi-generator/FILES b/sdk-output/sim_integrations/.openapi-generator/FILES index 70c4a1c1..ddd80423 100644 --- a/sdk-output/sim_integrations/.openapi-generator/FILES +++ b/sdk-output/sim_integrations/.openapi-generator/FILES @@ -1,11 +1,35 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Basecommondto.md +Beforeprovisioningruledto.md +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +GetSIMIntegrationV1401Response.md +GetSIMIntegrationV1429Response.md +Index.md +Jsonpatch.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Ownerdto.md +Provisioningconfig.md +ProvisioningconfigPlanInitializerScript.md README.md +SIMIntegrationsV1Api.md +SIMIntegrationsV1ApideveloperSite_code_examples.yaml +Servicedeskintegrationdto.md +Servicedesksource.md +Simintegrationdetails.md +SimintegrationdetailsAllOfBeforeProvisioningRule.md +Sourceclusterdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/sim_integrations/README.md b/sdk-output/sim_integrations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/sim_integrations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/sod_policies/.openapi-generator/FILES b/sdk-output/sod_policies/.openapi-generator/FILES index 70c4a1c1..a5a10ff4 100644 --- a/sdk-output/sod_policies/.openapi-generator/FILES +++ b/sdk-output/sod_policies/.openapi-generator/FILES @@ -1,11 +1,43 @@ .gitignore .npmignore .openapi-generator-ignore +Accesscriteria.md +AccesscriteriaCriteriaListInner.md +ArrayInner.md +Conflictingaccesscriteria.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListSodPoliciesV1401Response.md +ListSodPoliciesV1429Response.md +Localeorigin.md +Multipolicyrequest.md README.md +Reportresultreference.md +SODPoliciesV1Api.md +SODPoliciesV1ApideveloperSite_code_examples.yaml +Schedule.md +ScheduleDays.md +ScheduleHours.md +ScheduleMonths.md +Scheduletype.md +Selector.md +Selectortype.md +Sodpolicy.md +SodpolicyConflictingAccessCriteria.md +SodpolicyOwnerRef.md +Sodpolicyschedule.md +Sodrecipient.md +Sodreportresultdto.md +Violationownerassignmentconfig.md +ViolationownerassignmentconfigOwnerRef.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/sod_policies/README.md b/sdk-output/sod_policies/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/sod_policies/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/sod_violations/.openapi-generator/FILES b/sdk-output/sod_violations/.openapi-generator/FILES index 70c4a1c1..27f561e9 100644 --- a/sdk-output/sod_violations/.openapi-generator/FILES +++ b/sdk-output/sod_violations/.openapi-generator/FILES @@ -1,11 +1,32 @@ .gitignore .npmignore .openapi-generator-ignore +Dtotype.md +Errormessagedto.md +Errorresponsedto.md +Exceptionaccesscriteria.md +Exceptioncriteria.md +ExceptioncriteriaCriteriaListInner.md +Exceptioncriteriaaccess.md +Identitywithnewaccess.md +IdentitywithnewaccessAccessRefsInner.md +Index.md +Localeorigin.md README.md +SODViolationsV1Api.md +SODViolationsV1ApideveloperSite_code_examples.yaml +Sodpolicydto2.md +Sodviolationcheck.md +StartPredictSodViolationsV1401Response.md +StartPredictSodViolationsV1429Response.md +Violationcontext.md +ViolationcontextPolicy.md +Violationprediction.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/sod_violations/README.md b/sdk-output/sod_violations/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/sod_violations/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/source_usages/.openapi-generator/FILES b/sdk-output/source_usages/.openapi-generator/FILES index 70c4a1c1..4416ccbb 100644 --- a/sdk-output/source_usages/.openapi-generator/FILES +++ b/sdk-output/source_usages/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetStatusBySourceIdV1401Response.md +GetStatusBySourceIdV1429Response.md +Index.md +Localeorigin.md README.md +SourceUsagesV1Api.md +SourceUsagesV1ApideveloperSite_code_examples.yaml +Sourceusage.md +Sourceusagestatus.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/source_usages/README.md b/sdk-output/source_usages/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/source_usages/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/sources/.openapi-generator/FILES b/sdk-output/sources/.openapi-generator/FILES index 70c4a1c1..97c870c9 100644 --- a/sdk-output/sources/.openapi-generator/FILES +++ b/sdk-output/sources/.openapi-generator/FILES @@ -1,11 +1,100 @@ .gitignore .npmignore .openapi-generator-ignore +Accountdeleteconfigdto.md +Approvalconfig.md +ApprovalconfigCronTimezone.md +ApprovalconfigEscalationConfig.md +ApprovalconfigEscalationConfigEscalationChainInner.md +ApprovalconfigFallbackApprover.md +ApprovalconfigReminderConfig.md +ApprovalconfigSerialChainInner.md +ApprovalconfigTimeoutConfig.md +ArrayInner.md +Attributedefinition.md +AttributedefinitionSchema.md +Attributedefinitiontype.md +Attrsyncsource.md +Attrsyncsourceattributeconfig.md +Attrsyncsourceconfig.md +Basereferencedto.md +Connectordetail.md +Correlationconfig.md +CorrelationconfigAttributeAssignmentsInner.md +DeleteSourceV1202Response.md +Dependantappconnections.md +DependantappconnectionsAccountSource.md +DependantappconnectionsAccountSourcePasswordPoliciesInner.md +Dependantconnectionsmissingdto.md +Dtotype.md +Entitlementaccessrequestconfig.md +EntitlementaccessrequestconfigMaxPermittedAccessDuration.md +Entitlementapprovalscheme.md +Entitlementrevocationrequestconfig.md +Errormessagedto.md +Errorresponsedto.md +Fielddetailsdto.md +Identityprofilesconnections.md +ImportAccountsSchemaV1Request.md +ImportAccountsV1Request.md +ImportEntitlementsV1Request.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListSourcesV1401Response.md +ListSourcesV1429Response.md +Loadaccountstask.md +LoadaccountstaskTask.md +LoadaccountstaskTaskAttributes.md +LoadaccountstaskTaskMessagesInner.md +LoadaccountstaskTaskReturnsInner.md +Loadentitlementtask.md +LoadentitlementtaskReturnsInner.md +Loaduncorrelatedaccountstask.md +LoaduncorrelatedaccountstaskTask.md +LoaduncorrelatedaccountstaskTaskAttributes.md +LoaduncorrelatedaccountstaskTaskMessagesInner.md +Localeorigin.md +Managercorrelationmapping.md +Nativechangedetectionconfig.md +PasswordpolicyholdersdtoInner.md +Passwordpolicyholdersdtoattributes.md +PasswordpolicyholdersdtoattributesIdentityAttrInner.md +Provisioningpolicydto.md README.md +Resourceobject.md +Resourceobjectsrequest.md +Resourceobjectsresponse.md +Schedule3.md +Schema.md +Source.md +SourceAccountCorrelationConfig.md +SourceAccountCorrelationRule.md +SourceBeforeProvisioningRule.md +SourceCluster.md +SourceManagementWorkgroup.md +SourceManagerCorrelationMapping.md +SourceManagerCorrelationRule.md +SourceOwner.md +SourcePasswordPoliciesInner.md +SourceSchemasInner.md +Sourceconnectionsdto.md +Sourceentitlementrequestconfig.md +Sourcehealthdto.md +SourcesV1Api.md +SourcesV1ApideveloperSite_code_examples.yaml +Sourcesyncjob.md +Sourcesyncpayload.md +Statusresponse.md +Taskresultdto.md +Transform.md +Transformread.md +Usagetype.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/sources/README.md b/sdk-output/sources/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/sources/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/sp_config/.openapi-generator/FILES b/sdk-output/sp_config/.openapi-generator/FILES index 70c4a1c1..0a42fccc 100644 --- a/sdk-output/sp_config/.openapi-generator/FILES +++ b/sdk-output/sp_config/.openapi-generator/FILES @@ -1,11 +1,40 @@ .gitignore .npmignore .openapi-generator-ignore +Configobject.md +Errormessagedto.md +Errorresponsedto.md +ExportSpConfigV1401Response.md +ExportSpConfigV1429Response.md +Exportoptions.md +Exportpayload.md +ImportSpConfigV1Request.md +Importobject.md +Importoptions.md +Index.md +Localeorigin.md +Objectexportimportoptions.md +Objectimportresult2.md README.md +SPConfigV1Api.md +SPConfigV1ApideveloperSite_code_examples.yaml +Selfimportexportdto.md +Spconfigexportjob.md +Spconfigexportjobstatus.md +Spconfigexportresults.md +Spconfigimportjobstatus.md +Spconfigimportresults.md +Spconfigjob.md +Spconfigmessage2.md +Spconfigobject.md +Spconfigrule.md +SpconfigruleValue.md +Spconfigrules.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/sp_config/README.md b/sdk-output/sp_config/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/sp_config/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/suggested_entitlement_description/.openapi-generator/FILES b/sdk-output/suggested_entitlement_description/.openapi-generator/FILES index 70c4a1c1..22343a8b 100644 --- a/sdk-output/suggested_entitlement_description/.openapi-generator/FILES +++ b/sdk-output/suggested_entitlement_description/.openapi-generator/FILES @@ -1,11 +1,57 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Autowritesetting.md +Autowritesettingpatch.md +AutowritesettingpatchValue.md +Autowritesettingresponse.md +Bulkapproveentitlementrecommendationitem.md +Bulkapproveentitlementrecommendationrequest.md +Bulkapproveentitlementrecommendationresult.md +CreateAutoWriteSettingsV1409Response.md +Entitlementrecommendationassignee.md +EntitlementrecommendationassigneeOneOf.md +EntitlementrecommendationassigneeOneOf1.md +Entitlementrecommendationassignrequest.md +Entitlementrecommendationassignresult.md +Entitlementrecommendationrecord.md +Errormessagedto.md +Errorresponsedto.md +GetAutoWriteSettingsV1401Response.md +GetAutoWriteSettingsV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Privilegedrecommendationgroup.md +Privilegedrecommendationinstance.md README.md +Searchcriteria.md +SearchcriteriaFiltersValue.md +SearchcriteriaFiltersValueRange.md +SearchcriteriaFiltersValueRangeLower.md +SearchcriteriaFiltersValueRangeUpper.md +SearchcriteriaQuery.md +SearchcriteriaTextQuery.md +Sed.md +Sedapproval.md +Sedapprovalstatus.md +Sedassignee.md +Sedassignment.md +Sedassignmentresponse.md +Sedbatchrecord.md +Sedbatchrequest.md +Sedbatchresponse.md +Sedbatchstats.md +Sedpatch.md +SuggestedEntitlementDescriptionV1Api.md +SuggestedEntitlementDescriptionV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/suggested_entitlement_description/README.md b/sdk-output/suggested_entitlement_description/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/suggested_entitlement_description/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/tagged_objects/.openapi-generator/FILES b/sdk-output/tagged_objects/.openapi-generator/FILES index 70c4a1c1..ade46387 100644 --- a/sdk-output/tagged_objects/.openapi-generator/FILES +++ b/sdk-output/tagged_objects/.openapi-generator/FILES @@ -1,11 +1,25 @@ .gitignore .npmignore .openapi-generator-ignore +Bulkaddtaggedobject.md +Bulkremovetaggedobject.md +Bulktaggedobjectresponse.md +Errormessagedto.md +Errorresponsedto.md +Index.md +ListTaggedObjectsV1401Response.md +ListTaggedObjectsV1429Response.md +Localeorigin.md README.md +TaggedObjectsV1Api.md +TaggedObjectsV1ApideveloperSite_code_examples.yaml +Taggedobject.md +Taggedobjectdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/tagged_objects/README.md b/sdk-output/tagged_objects/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/tagged_objects/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/tags/.openapi-generator/FILES b/sdk-output/tags/.openapi-generator/FILES index 70c4a1c1..084bcf23 100644 --- a/sdk-output/tags/.openapi-generator/FILES +++ b/sdk-output/tags/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Index.md +ListTagsV1401Response.md +ListTagsV1429Response.md +Localeorigin.md README.md +Tag2.md +Tag2TagCategoryRefsInner.md +TagsV1Api.md +TagsV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/tags/README.md b/sdk-output/tags/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/tags/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/task_management/.openapi-generator/FILES b/sdk-output/task_management/.openapi-generator/FILES index 70c4a1c1..438f9c77 100644 --- a/sdk-output/task_management/.openapi-generator/FILES +++ b/sdk-output/task_management/.openapi-generator/FILES @@ -1,11 +1,30 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetTaskStatusV1401Response.md +GetTaskStatusV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md +Localizedmessage.md README.md +Target.md +TaskManagementV1Api.md +TaskManagementV1ApideveloperSite_code_examples.yaml +Taskdefinitionsummary.md +Taskreturndetails.md +Taskstatus.md +Taskstatusmessage.md +TaskstatusmessageParametersInner.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/task_management/README.md b/sdk-output/task_management/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/task_management/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/tenant/.openapi-generator/FILES b/sdk-output/tenant/.openapi-generator/FILES index 70c4a1c1..24ba6bde 100644 --- a/sdk-output/tenant/.openapi-generator/FILES +++ b/sdk-output/tenant/.openapi-generator/FILES @@ -1,11 +1,23 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetTenantV1401Response.md +GetTenantV1429Response.md +Index.md +License.md +Localeorigin.md +Product.md README.md +Tenant.md +TenantV1Api.md +TenantV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/tenant/README.md b/sdk-output/tenant/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/tenant/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/tenant_context/.openapi-generator/FILES b/sdk-output/tenant_context/.openapi-generator/FILES index 70c4a1c1..c5693523 100644 --- a/sdk-output/tenant_context/.openapi-generator/FILES +++ b/sdk-output/tenant_context/.openapi-generator/FILES @@ -1,11 +1,24 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +Errormessagedto.md +Errorresponsedto.md +GetTenantContextV1200ResponseInner.md +GetTenantContextV1401Response.md +GetTenantContextV1429Response.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +Localeorigin.md README.md +TenantContextV1Api.md +TenantContextV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/tenant_context/README.md b/sdk-output/tenant_context/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/tenant_context/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/transforms/.openapi-generator/FILES b/sdk-output/transforms/.openapi-generator/FILES index 70c4a1c1..5a6e7a88 100644 --- a/sdk-output/transforms/.openapi-generator/FILES +++ b/sdk-output/transforms/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +Index.md +ListTransformsV1401Response.md +ListTransformsV1429Response.md +Localeorigin.md README.md +Transform.md +Transformread.md +TransformsV1Api.md +TransformsV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/transforms/README.md b/sdk-output/transforms/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/transforms/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/triggers/.openapi-generator/FILES b/sdk-output/triggers/.openapi-generator/FILES index 70c4a1c1..71126809 100644 --- a/sdk-output/triggers/.openapi-generator/FILES +++ b/sdk-output/triggers/.openapi-generator/FILES @@ -1,11 +1,164 @@ .gitignore .npmignore .openapi-generator-ignore +Accessitemapproverdto.md +Accessitemrequestedfordto.md +Accessitemrequesterdto.md +Accessrequestdynamicapprover.md +Accessrequestdynamicapprover2.md +AccessrequestdynamicapproverRequestedItemsInner.md +Accessrequestpostapproval.md +AccessrequestpostapprovalRequestedItemsStatusInner.md +AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInner.md +AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md +Accessrequestpreapproval.md +Accessrequestpreapproval2.md +AccessrequestpreapprovalRequestedItemsInner.md +Accountaggregationcompleted.md +AccountaggregationcompletedSource.md +AccountaggregationcompletedStats.md +Accountattributeschanged.md +AccountattributeschangedAccount.md +AccountattributeschangedChangesInner.md +AccountattributeschangedChangesInnerNewValue.md +AccountattributeschangedChangesInnerOldValue.md +AccountattributeschangedIdentity.md +AccountattributeschangedSource.md +Accountcorrelated.md +AccountcorrelatedAccount.md +AccountcorrelatedIdentity.md +AccountcorrelatedSource.md +Accountcreated.md +AccountcreatedEvent.md +Accountdeleted.md +AccountdeletedEvent.md +Accountscollectedforaggregation.md +AccountscollectedforaggregationSource.md +AccountscollectedforaggregationStats.md +Accountsourcereference.md +AccountsourcereferenceGovernanceGroup.md +AccountsourcereferenceOwner.md +Accountuncorrelated.md +AccountuncorrelatedAccount.md +AccountuncorrelatedIdentity.md +AccountuncorrelatedSource.md +Accountupdated.md +AccountupdatedEntitlementChangesInner.md +AccountupdatedEntitlementChangesInnerAddedInner.md +AccountupdatedEntitlementChangesInnerAddedInnerOwner.md +AccountupdatedEvent.md +AccountupdatedMultiValueAttributeChangesInner.md +AccountupdatedMultiValueAttributeChangesInnerAddedValuesInner.md +AccountupdatedSingleValueAttributeChangesInner.md +AccountupdatedSingleValueAttributeChangesInnerNewValue.md +AccountupdatedSingleValueAttributeChangesInnerOldValue.md +Accountv2.md +Basicauthconfig.md +Bearertokenauthconfig.md +Campaignactivated.md +CampaignactivatedCampaign.md +CampaignactivatedCampaignCampaignOwner.md +Campaignended.md +CampaignendedCampaign.md +Campaigngenerated.md +CampaigngeneratedCampaign.md +CampaigngeneratedCampaignCampaignOwner.md +Campaignreference.md +Certificationdto.md +Certificationphase.md +Certificationreference.md +Certificationsignedoff.md +CertificationsignedoffCertification.md +Completeinvocation.md +Completeinvocationinput.md +Errormessagedto.md +Errorresponsedto.md +Eventbridgeconfig.md +Httpauthenticationtype.md +Httpconfig.md +Httpdispatchmode.md +Identityattributeschanged.md +IdentityattributeschangedChangesInner.md +IdentityattributeschangedChangesInnerNewValue.md +IdentityattributeschangedChangesInnerOldValue.md +IdentityattributeschangedChangesInnerOldValueOneOfValue.md +IdentityattributeschangedIdentity.md +Identitycreated.md +IdentitycreatedIdentity.md +Identitydeleted.md +IdentitydeletedIdentity.md +Identityreference2.md +Index.md +Invocation.md +Invocationstatus.md +Invocationstatustype.md +ListTriggersV1401Response.md +ListTriggersV1429Response.md +Localeorigin.md +Localizedmessage.md +Machineidentitycreated.md +MachineidentitycreatedMachineIdentity.md +Machineidentitydeleted.md +MachineidentitydeletedMachineIdentity.md +Machineidentityownerreference.md +Machineidentitysourcereference.md +Machineidentityupdated.md +MachineidentityupdatedMachineIdentity.md +MachineidentityupdatedOwnerChanges.md +MachineidentityupdatedSingleValueAttributeChangesInner.md +MachineidentityupdatedSingleValueAttributeChangesInnerNewValue.md +MachineidentityupdatedSingleValueAttributeChangesInnerOldValue.md +MachineidentityupdatedUserEntitlementChanges.md +Machineidentityuserentitlements.md +Provisioningcompleted.md +ProvisioningcompletedAccountRequestsInner.md +ProvisioningcompletedAccountRequestsInnerAttributeRequestsInner.md +ProvisioningcompletedAccountRequestsInnerSource.md +ProvisioningcompletedRecipient.md +ProvisioningcompletedRequester.md README.md +Reassignment.md +Reviewer.md +Savedsearchcomplete.md +SavedsearchcompleteSearchResults.md +SavedsearchcompleteSearchResultsAccount.md +SavedsearchcompleteSearchResultsEntitlement.md +SavedsearchcompleteSearchResultsIdentity.md +Sourceaccountcreated.md +Sourceaccountdeleted.md +Sourceaccountupdated.md +Sourcecreated.md +SourcecreatedActor.md +Sourcedeleted.md +SourcedeletedActor.md +Sourceupdated.md +SourceupdatedActor.md +Startinvocationinput.md +Subscription.md +SubscriptionpatchrequestInner.md +SubscriptionpatchrequestInnerValue.md +SubscriptionpatchrequestInnerValueAnyOfInner.md +Subscriptionpostrequest.md +Subscriptionputrequest.md +Subscriptiontype.md +Testinvocation.md +Trigger.md +TriggerExampleInput.md +TriggerExampleOutput.md +TriggersV1Api.md +TriggersV1ApideveloperSite_code_examples.yaml +Triggertype.md +Vaclusterstatuschangeevent.md +VaclusterstatuschangeeventApplication.md +VaclusterstatuschangeeventHealthCheckResult.md +VaclusterstatuschangeeventPreviousHealthCheckResult.md +Validatefilterinputdto.md +Validatefilteroutputdto.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/triggers/README.md b/sdk-output/triggers/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/triggers/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/ui_metadata/.openapi-generator/FILES b/sdk-output/ui_metadata/.openapi-generator/FILES index 70c4a1c1..31c916d3 100644 --- a/sdk-output/ui_metadata/.openapi-generator/FILES +++ b/sdk-output/ui_metadata/.openapi-generator/FILES @@ -1,11 +1,22 @@ .gitignore .npmignore .openapi-generator-ignore +Errormessagedto.md +Errorresponsedto.md +GetTenantUiMetadataV1401Response.md +GetTenantUiMetadataV1429Response.md +Index.md +Localeorigin.md README.md +Tenantuimetadataitemresponse.md +Tenantuimetadataitemupdaterequest.md +UIMetadataV1Api.md +UIMetadataV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/ui_metadata/README.md b/sdk-output/ui_metadata/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/ui_metadata/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/work_items/.openapi-generator/FILES b/sdk-output/work_items/.openapi-generator/FILES index 70c4a1c1..206cdf12 100644 --- a/sdk-output/work_items/.openapi-generator/FILES +++ b/sdk-output/work_items/.openapi-generator/FILES @@ -1,11 +1,33 @@ .gitignore .npmignore .openapi-generator-ignore +Approvalitemdetails.md +Errormessagedto.md +Errorresponsedto.md +Formdetails.md +Formitemdetails.md +Index.md +ListWorkItemsV1401Response.md +ListWorkItemsV1429Response.md +Localeorigin.md README.md +Remediationitemdetails.md +Sectiondetails.md +WorkItemsV1Api.md +WorkItemsV1ApideveloperSite_code_examples.yaml +Workitemforward.md +Workitems.md +WorkitemsForm.md +Workitemscount.md +Workitemssummary.md +Workitemstate.md +Workitemstatemanualworkitems.md +Workitemtypemanualworkitems.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/work_items/README.md b/sdk-output/work_items/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/work_items/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/work_reassignment/.openapi-generator/FILES b/sdk-output/work_reassignment/.openapi-generator/FILES index 70c4a1c1..e53a5cbe 100644 --- a/sdk-output/work_reassignment/.openapi-generator/FILES +++ b/sdk-output/work_reassignment/.openapi-generator/FILES @@ -1,11 +1,35 @@ .gitignore .npmignore .openapi-generator-ignore +Auditdetails.md +Configtype.md +Configtypeenum.md +Configtypeenumcamel.md +Configurationdetailsresponse.md +Configurationitemrequest.md +Configurationitemresponse.md +Configurationresponse.md +Errormessagedto.md +Errorresponsedto.md +Evaluateresponse.md +GetReassignmentConfigTypesV1401Response.md +GetReassignmentConfigTypesV1429Response.md +Identity2.md +Index.md +Localeorigin.md +Lookupstep.md README.md +Reassignmenttypeenum.md +Tenantconfigurationdetails.md +Tenantconfigurationrequest.md +Tenantconfigurationresponse.md +WorkReassignmentV1Api.md +WorkReassignmentV1ApideveloperSite_code_examples.yaml api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/work_reassignment/README.md b/sdk-output/work_reassignment/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/work_reassignment/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-output/workflows/.openapi-generator/FILES b/sdk-output/workflows/.openapi-generator/FILES index 70c4a1c1..884934c8 100644 --- a/sdk-output/workflows/.openapi-generator/FILES +++ b/sdk-output/workflows/.openapi-generator/FILES @@ -1,11 +1,47 @@ .gitignore .npmignore .openapi-generator-ignore +ArrayInner.md +CreateExternalExecuteWorkflowV1200Response.md +CreateExternalExecuteWorkflowV1Request.md +CreateWorkflowV1Request.md +Errormessagedto.md +Errorresponsedto.md +Index.md +Jsonpatchoperation.md +JsonpatchoperationValue.md +ListCompleteWorkflowLibraryV1200ResponseInner.md +ListWorkflowsV1401Response.md +ListWorkflowsV1429Response.md +Localeorigin.md README.md +TestExternalExecuteWorkflowV1200Response.md +TestExternalExecuteWorkflowV1Request.md +TestWorkflowV1200Response.md +TestWorkflowV1Request.md +Workflow.md +WorkflowAllOfCreator.md +Workflowbody.md +WorkflowbodyOwner.md +Workflowdefinition.md +Workflowexecution.md +Workflowexecutionevent.md +Workflowexecutionhistory.md +Workflowlibraryaction.md +WorkflowlibraryactionExampleOutput.md +Workflowlibraryformfields.md +Workflowlibraryoperator.md +Workflowlibrarytrigger.md +Workflowmodifiedby.md +Workflowoauthclient.md +WorkflowsV1Api.md +WorkflowsV1ApideveloperSite_code_examples.yaml +Workflowtrigger.md api.ts base.ts common.ts configuration.ts +docs/Methods/Index.md git_push.sh index.ts package.json diff --git a/sdk-output/workflows/README.md b/sdk-output/workflows/README.md deleted file mode 100644 index e26f6a53..00000000 --- a/sdk-output/workflows/README.md +++ /dev/null @@ -1,46 +0,0 @@ -## sailpoint-api-client@1.0.0 - -This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: - -Environment -* Node.js -* Webpack -* Browserify - -Language level -* ES5 - you must have a Promises/A+ library installed -* ES6 - -Module system -* CommonJS -* ES6 module system - -It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) - -### Building - -To build and compile the typescript sources to javascript use: -``` -npm install -npm run build -``` - -### Publishing - -First build the package then run `npm publish` - -### Consuming - -navigate to the folder of your consuming project and run one of the following commands. - -_published:_ - -``` -npm install sailpoint-api-client@1.0.0 --save -``` - -_unPublished (not recommended):_ - -``` -npm install PATH_TO_GENERATED_PACKAGE --save -``` diff --git a/sdk-resources/build-versioned-sdk.js b/sdk-resources/build-versioned-sdk.js index f600766b..6d736f75 100644 --- a/sdk-resources/build-versioned-sdk.js +++ b/sdk-resources/build-versioned-sdk.js @@ -205,18 +205,35 @@ function bundlePartition(partitionName, tempApisDir) { // --------------------------------------------------------------------------- function writePartitionConfig(partitionName) { + const packageDir = partitionName.replaceAll("-", "_"); const config = [ `templateDir: ${TEMPLATE_DIR}`, `files:`, ` package.mustache:`, ` templateType: SupportingFiles`, ` destinationFilename: package.json`, + ` developerSite_code_examples.mustache:`, + ` templateType: APIDocs`, + ` destinationFilename: developerSite_code_examples.yaml`, + ` api_doc.mustache:`, + ` templateType: APIDocs`, + ` destinationFilename: .md`, + ` model_doc.mustache:`, + ` templateType: ModelDocs`, + ` destinationFilename: .md`, + ` docs_methods_index.mustache:`, + ` templateType: SupportingFiles`, + ` destinationFilename: docs/Methods/Index.md`, + ` docs_models_index.mustache:`, + ` templateType: SupportingFiles`, + ` destinationFilename: Index.md`, `npmName: ${NPM_NAME}`, `npmRepository: sailpoint.com`, `npmVersion: ${NPM_VERSION}`, `useSingleRequestParameter: true`, `apiVersion: ${API_VERSION}`, `enumNameSuffix: V1`, + `packageName: ${packageDir}`, ].join("\n"); const configPath = path.join(TEMP_DIR, `${partitionName}-config.yaml`); @@ -244,7 +261,7 @@ function generatePartition(partitionName, bundledSpec, configPath) { "-i", bundledSpec, "-g", "typescript-axios", "-o", outputDir, - "--global-property", "skipFormModel=false", + "--global-property", "skipFormModel=false,apiDocs=true,modelDocs=true", "--config", configPath, "--api-name-suffix", "V1Api", "--model-name-suffix", "V1", diff --git a/sdk-resources/postscript.js b/sdk-resources/postscript.js index 75284ee3..29cc1280 100644 --- a/sdk-resources/postscript.js +++ b/sdk-resources/postscript.js @@ -1,7 +1,8 @@ const fs = require("fs"); const path = require("path"); + const getAllFiles = function (dirPath, arrayOfFiles) { - files = fs.readdirSync(dirPath); + const files = fs.readdirSync(dirPath); arrayOfFiles = arrayOfFiles || []; files.forEach(function (file) { if (fs.statSync(dirPath + "/" + file).isDirectory()) { @@ -13,7 +14,6 @@ const getAllFiles = function (dirPath, arrayOfFiles) { return arrayOfFiles; }; - // When an OpenAPI schema name already contains a version suffix (e.g. AccessRequestConfigV2), // the generator lowercases it to "accessrequestconfigv2" and then appends the // --model-name-suffix "V1", producing "Accessrequestconfigv2V1". @@ -32,13 +32,90 @@ const fixFiles = function (myArray) { fs.writeFileSync(file, fixed, "utf8"); } } -} +}; + +// Merge all per-operation developerSite_code_examples.yaml files generated by +// the APIDocs templateType into a single go_code_examples_overlay.yaml, then +// remove the originals so only the merged file remains. +const mergeCodeExampleFiles = function (docsExamplesDir) { + if (!fs.existsSync(docsExamplesDir)) return; + + const files = fs.readdirSync(docsExamplesDir).filter(f => f.endsWith(".yaml") && f !== "typescript_code_examples_overlay.yaml"); + if (files.length === 0) return; + + let merged = ""; + for (const file of files) { + const filePath = path.join(docsExamplesDir, file); + merged += fs.readFileSync(filePath, "utf8"); + fs.unlinkSync(filePath); + } + + fs.writeFileSync(path.join(docsExamplesDir, "typescript_code_examples_overlay.yaml"), merged, "utf8"); + console.log(`Merged ${files.length} code example file(s) into typescript_code_examples_overlay.yaml`); +}; + +// Move generated doc files from the root output dir into docs/Methods and docs/Models, +// then assemble the docs/Examples directory for code samples. +const organiseDocs = function (outputDir) { + const docsMethodsDir = path.join(outputDir, "docs", "Methods"); + const docsModelsDir = path.join(outputDir, "docs", "Models"); + const docsExamplesDir = path.join(outputDir, "docs", "Examples"); + + fs.mkdirSync(docsMethodsDir, { recursive: true }); + fs.mkdirSync(docsModelsDir, { recursive: true }); + fs.mkdirSync(docsExamplesDir, { recursive: true }); + + // APIDocs templates generate files at the root as . + // api_doc.mustache → .md (e.g. AccountsV1Api.md) → Methods + // model_doc.mustache → .md (e.g. AccountV1.md) → Models + // code_examples.mustache→ *.yaml → Examples + // Index.md → docs_models_index output → Models + // README.md → standard generator README → Models + // + // API class names always end with the api-name-suffix "V1Api" (or similar), + // so files ending in "Api.md" are API method docs; everything else is a model doc. + const rootFiles = fs.readdirSync(outputDir); + for (const file of rootFiles) { + const src = path.join(outputDir, file); + if (fs.statSync(src).isDirectory()) continue; + + if (file.endsWith(".yaml")) { + // Code example files (e.g. AccountsV1ApideveloperSite_code_examples.yaml) + fs.renameSync(src, path.join(docsExamplesDir, file)); + } else if (file.endsWith(".md")) { + if (file.endsWith("Api.md")) { + // API method doc — route to Methods + fs.renameSync(src, path.join(docsMethodsDir, file)); + } else { + // Index.md (models index) and all per-model docs — route to Models + fs.renameSync(src, path.join(docsModelsDir, file)); + } + } + } + // Move any remaining .md files from the docs/ subdirectory (e.g. Methods/Index.md + // is already placed directly by the SupportingFiles config, so nothing to do there). + const generatedDocsDir = path.join(outputDir, "docs"); + if (fs.existsSync(generatedDocsDir)) { + for (const file of fs.readdirSync(generatedDocsDir)) { + const src = path.join(generatedDocsDir, file); + if (fs.statSync(src).isDirectory()) continue; + if (file.endsWith(".yaml")) { + fs.renameSync(src, path.join(docsExamplesDir, file)); + } else if (file.endsWith(".md") && file !== "Index.md") { + fs.renameSync(src, path.join(docsMethodsDir, file)); + } + } + } + mergeCodeExampleFiles(docsExamplesDir); +}; +const outputDir = process.argv[2]; let myArray = []; -getAllFiles(process.argv[2], myArray); +getAllFiles(outputDir, myArray); -fixFiles(myArray) \ No newline at end of file +fixFiles(myArray); +organiseDocs(outputDir); \ No newline at end of file From 8e5ddfc5565bc0b7d5100ea3cbe39660b13cd749 Mon Sep 17 00:00:00 2001 From: philip-ellis-sp Date: Fri, 26 Jun 2026 16:20:43 -0400 Subject: [PATCH 2/2] added all the generated docs --- .../typescript_code_examples_overlay.yaml | 175 ++ .../docs/Methods/AccessModelMetadataV1Api.md | 493 ++++ .../docs/Methods/Index.md | 30 + .../Accessmodelmetadatabulkupdateresponse.md | 22 + .../docs/Models/Aggregations.md | 22 + .../docs/Models/Aggregationtype.md | 21 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Attributedto.md | 26 + .../docs/Models/Attributevaluedto.md | 21 + .../docs/Models/Bound.md | 20 + .../docs/Models/Bucketaggregation.md | 23 + .../docs/Models/Buckettype.md | 19 + .../docs/Models/BulkupdateammkeyvalueInner.md | 20 + ...tlementattributebulkupdatefilterrequest.md | 22 + ...ntitlementattributebulkupdateidsrequest.md | 22 + ...itlementattributebulkupdatequeryrequest.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Filter.md | 22 + .../docs/Models/Filteraggregation.md | 22 + .../docs/Models/Filtertype.md | 23 + .../docs/Models/Index.md | 19 + .../docs/Models/Innerhit.md | 20 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + ...cessModelMetadataAttributeV1401Response.md | 19 + ...cessModelMetadataAttributeV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Metricaggregation.md | 21 + .../docs/Models/Metrictype.md | 31 + .../docs/Models/Nestedaggregation.md | 20 + .../docs/Models/Query.md | 22 + .../docs/Models/Queryresultfilter.md | 20 + .../docs/Models/Querytype.md | 25 + .../docs/Models/README.md | 46 + .../docs/Models/Range.md | 20 + .../docs/Models/Search.md | 34 + .../Models/Searchaggregationspecification.md | 23 + .../docs/Models/Searchfiltertype.md | 19 + .../Subsearchaggregationspecification.md | 23 + .../docs/Models/Textquery.md | 22 + .../docs/Models/Typeaheadquery.md | 25 + .../typescript_code_examples_overlay.yaml | 134 + .../docs/Methods/AccessProfilesV1Api.md | 447 +++ .../access_profiles/docs/Methods/Index.md | 30 + .../docs/Models/Accessduration.md | 20 + .../docs/Models/Accessmodelmetadata.md | 26 + .../Models/AccessmodelmetadataValuesInner.md | 21 + .../docs/Models/Accessprofile.md | 34 + .../Models/Accessprofileapprovalscheme.md | 20 + .../Models/Accessprofilebulkdeleterequest.md | 20 + .../Models/Accessprofilebulkdeleteresponse.md | 21 + .../AccessprofilebulkupdaterequestInner.md | 20 + .../docs/Models/Accessprofilesourceref.md | 21 + .../docs/Models/Accessprofileupdateitem.md | 22 + .../docs/Models/Accessprofileusage.md | 20 + .../Models/AccessprofileusageUsedByInner.md | 21 + .../docs/Models/Additionalownerref.md | 21 + .../access_profiles/docs/Models/ArrayInner.md | 18 + .../docs/Models/Attributedto.md | 26 + .../docs/Models/Attributedtolist.md | 19 + .../docs/Models/Attributevaluedto.md | 21 + .../docs/Models/Entitlement.md | 37 + .../Models/EntitlementAccessModelMetadata.md | 19 + .../docs/Models/EntitlementOwner.md | 21 + .../docs/Models/EntitlementSource.md | 21 + .../docs/Models/Entitlementref.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../access_profiles/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListAccessProfilesV1401Response.md | 19 + .../Models/ListAccessProfilesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Ownerreference.md | 21 + .../docs/Models/Permissiondto.md | 20 + .../docs/Models/Provisioningcriterialevel1.md | 22 + .../docs/Models/Provisioningcriterialevel2.md | 22 + .../docs/Models/Provisioningcriterialevel3.md | 22 + .../Models/Provisioningcriteriaoperation.md | 29 + .../access_profiles/docs/Models/README.md | 46 + .../docs/Models/Requestability.md | 24 + .../docs/Models/Revocability.md | 19 + ...UpdateAccessProfilesInBulkV1412Response.md | 19 + .../typescript_code_examples_overlay.yaml | 122 + .../Methods/AccessRequestApprovalsV1Api.md | 344 +++ .../docs/Methods/Index.md | 30 + .../docs/Models/Accessitemrequestedfor.md | 21 + .../docs/Models/Accessitemrequester.md | 21 + .../docs/Models/Accessitemreviewedby.md | 21 + .../Accessrequestapproverslistresponse.md | 23 + .../docs/Models/Accessrequesttype.md | 23 + .../docs/Models/Approvalforwardhistory.md | 24 + .../docs/Models/Approvalsummary.md | 21 + .../docs/Models/Commentdto.md | 21 + .../docs/Models/CommentdtoAuthor.md | 21 + .../docs/Models/Completedapproval.md | 47 + ...mpletedapprovalPreApprovalTriggerResult.md | 22 + .../Models/CompletedapprovalRequestedFor.md | 21 + .../CompletedapprovalRequesterComment.md | 21 + .../CompletedapprovalReviewerComment.md | 21 + .../docs/Models/Completedapprovalstate.md | 21 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Forwardapprovaldto.md | 20 + .../docs/Models/Index.md | 19 + .../ListPendingApprovalsV1401Response.md | 19 + .../ListPendingApprovalsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Ownerdto.md | 21 + .../docs/Models/Pendingapproval.md | 45 + ...ndingapprovalMaxPermittedAccessDuration.md | 20 + .../docs/Models/PendingapprovalOwner.md | 21 + .../docs/Models/Pendingapprovalaction.md | 23 + .../docs/Models/README.md | 46 + .../docs/Models/Reassignmenttype.md | 25 + .../docs/Models/Requestableobjectreference.md | 22 + .../docs/Models/Requestedaccountref.md | 23 + .../docs/Models/Sodexemptcriteria.md | 22 + .../docs/Models/Sodpolicydto.md | 21 + .../docs/Models/Sodviolationcheckresult.md | 22 + .../docs/Models/Sodviolationcontext.md | 20 + ...olationcontextConflictingAccessCriteria.md | 20 + ...xtConflictingAccessCriteriaLeftCriteria.md | 19 + .../Sodviolationcontextcheckcompleted.md | 21 + .../typescript_code_examples_overlay.yaml | 17 + .../AccessRequestIdentityMetricsV1Api.md | 66 + .../docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...cessRequestIdentityMetricsV1401Response.md | 19 + ...cessRequestIdentityMetricsV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 214 ++ .../docs/Methods/AccessRequestsV1Api.md | 641 +++++ .../access_requests/docs/Methods/Index.md | 30 + .../docs/Models/Accessitemrequester.md | 21 + .../docs/Models/Accessitemreviewedby.md | 21 + .../docs/Models/Accessrequest.md | 23 + .../Models/Accessrequestadminitemstatus.md | 44 + .../docs/Models/Accessrequestconfig.md | 24 + .../docs/Models/Accessrequestconfigv2.md | 23 + .../docs/Models/Accessrequestitem.md | 26 + .../docs/Models/Accessrequestphases.md | 24 + .../docs/Models/Accessrequestresponse.md | 20 + .../docs/Models/Accessrequesttracking.md | 22 + .../docs/Models/Accessrequesttype.md | 23 + .../docs/Models/Accountinforef.md | 23 + .../docs/Models/Accountitemref.md | 20 + .../docs/Models/Accountsselectionrequest.md | 22 + .../docs/Models/Accountsselectionresponse.md | 19 + .../docs/Models/Approvalforwardhistory.md | 24 + .../Approvalreminderandescalationconfig.md | 22 + .../docs/Models/Approvalscheme.md | 31 + .../docs/Models/Approvalstatusdto.md | 27 + .../Models/ApprovalstatusdtoCurrentOwner.md | 21 + .../Models/ApprovalstatusdtoOriginalOwner.md | 21 + .../docs/Models/Bulkapproveaccessrequest.md | 20 + .../docs/Models/Bulkcancelaccessrequest.md | 20 + .../docs/Models/Cancelaccessrequest.md | 20 + .../docs/Models/Cancelledrequestdetails.md | 21 + .../docs/Models/Closeaccessrequest.md | 22 + .../access_requests/docs/Models/Commentdto.md | 21 + .../docs/Models/CommentdtoAuthor.md | 21 + .../access_requests/docs/Models/Dtotype.md | 75 + .../Models/Entitlementaccessrequestconfig.md | 24 + ...requestconfigMaxPermittedAccessDuration.md | 20 + .../docs/Models/Entitlementapprovalscheme.md | 20 + .../docs/Models/Entitlementrequestconfig.md | 20 + .../docs/Models/Entitlementrequestconfigv2.md | 20 + .../Entitlementrevocationrequestconfig.md | 19 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetAccessRequestConfigV1401Response.md | 19 + .../GetAccessRequestConfigV1429Response.md | 19 + .../docs/Models/Identityaccountselections.md | 23 + .../docs/Models/Identityentitlementdetails.md | 22 + ...Identityentitlementdetailsaccounttarget.md | 26 + ...dentityentitlementdetailsentitlementdto.md | 29 + .../Identityreferencewithnameandemail.md | 22 + .../access_requests/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Manualworkitemdetails.md | 24 + .../ManualworkitemdetailsCurrentOwner.md | 21 + .../ManualworkitemdetailsOriginalOwner.md | 21 + .../docs/Models/Manualworkitemstate.md | 29 + .../access_requests/docs/Models/Ownerdto.md | 21 + .../docs/Models/Preapprovaltriggerdetails.md | 21 + .../docs/Models/Provisioningdetails.md | 19 + .../access_requests/docs/Models/README.md | 46 + .../docs/Models/Reassignmenttype.md | 25 + .../docs/Models/Requestedaccountref.md | 23 + .../docs/Models/Requestedfordtoref.md | 20 + .../Models/Requesteditemaccountselections.md | 25 + .../docs/Models/Requesteditemdetails.md | 20 + .../docs/Models/Requesteditemdtoref.md | 25 + .../docs/Models/Requesteditemstatus.md | 46 + ...uesteditemstatusCancelledRequestDetails.md | 21 + ...steditemstatusPreApprovalTriggerDetails.md | 21 + .../RequesteditemstatusProvisioningDetails.md | 19 + .../Models/RequesteditemstatusRequestedFor.md | 21 + .../RequesteditemstatusRequesterComment.md | 21 + .../RequesteditemstatusSodViolationContext.md | 21 + .../Models/Requesteditemstatusrequeststate.md | 35 + .../docs/Models/Requestonbehalfofconfig.md | 20 + .../docs/Models/Requestonbehalfofconfigv2.md | 20 + .../docs/Models/Sodexemptcriteria.md | 22 + .../docs/Models/Sodpolicydto.md | 21 + .../docs/Models/Sodviolationcheckresult.md | 22 + .../docs/Models/Sodviolationcontext.md | 20 + ...olationcontextConflictingAccessCriteria.md | 20 + ...xtConflictingAccessCriteriaLeftCriteria.md | 19 + .../Sodviolationcontextcheckcompleted.md | 21 + .../docs/Models/Sourceaccountselections.md | 22 + .../docs/Models/Sourceitemref.md | 20 + .../typescript_code_examples_overlay.yaml | 37 + .../docs/Methods/AccountActivitiesV1Api.md | 144 + .../account_activities/docs/Methods/Index.md | 30 + .../docs/Models/Accountactivity.md | 32 + .../Models/Accountactivityapprovalstatus.md | 29 + .../docs/Models/Accountactivityitem.md | 34 + .../Models/Accountactivityitemoperation.md | 37 + .../docs/Models/Accountrequestinfo.md | 21 + .../account_activities/docs/Models/Comment.md | 22 + .../docs/Models/Completionstatus.md | 25 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Executionstatus.md | 25 + .../docs/Models/Identitysummary.md | 22 + .../account_activities/docs/Models/Index.md | 19 + .../ListAccountActivitiesV1401Response.md | 19 + .../ListAccountActivitiesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Provisioningstate.md | 29 + .../account_activities/docs/Models/README.md | 46 + .../docs/Models/Requestableobjecttype.md | 23 + .../typescript_code_examples_overlay.yaml | 15 + .../docs/Methods/AccountAggregationsV1Api.md | 77 + .../docs/Methods/Index.md | 30 + .../docs/Models/Accountaggregationstatus.md | 26 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...etAccountAggregationStatusV1400Response.md | 19 + ...etAccountAggregationStatusV1429Response.md | 19 + .../account_aggregations/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 34 + .../Methods/AccountDeletionRequestsV1Api.md | 108 + .../docs/Methods/Index.md | 30 + .../docs/Models/Accountactionrequestdto.md | 32 + .../AccountactionrequestdtoAccountDetails.md | 38 + ...countactionrequestdtoCorrelatedIdentity.md | 21 + .../AccountactionrequestdtoRequester.md | 21 + .../docs/Models/Accountdeleterequestinput.md | 19 + .../docs/Models/Accountdetails.md | 38 + .../docs/Models/Accountrequestasyncresult.md | 19 + .../docs/Models/Accountrequestphase.md | 22 + .../docs/Models/Accountrequestphasestate.md | 31 + .../docs/Models/Approvaldetails.md | 23 + .../docs/Models/Approverdto.md | 26 + .../docs/Models/Approverreference.md | 21 + .../docs/Models/Basereferencedto.md | 21 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...GetAccountDeletionRequestsV1401Response.md | 19 + ...GetAccountDeletionRequestsV1429Response.md | 19 + .../docs/Models/Identityreference.md | 21 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 19 + .../docs/Methods/AccountUsagesV1Api.md | 69 + .../account_usages/docs/Methods/Index.md | 30 + .../docs/Models/Accountusage.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetUsagesByAccountIdV1401Response.md | 19 + .../GetUsagesByAccountIdV1429Response.md | 19 + .../account_usages/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../account_usages/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 253 ++ .../accounts/docs/Methods/AccountsV1Api.md | 732 +++++ sdk-output/accounts/docs/Methods/Index.md | 30 + .../docs/Models/Accessmodelmetadata.md | 26 + .../Models/AccessmodelmetadataValuesInner.md | 21 + sdk-output/accounts/docs/Models/Account.md | 46 + .../docs/Models/AccountAllOfIdentity.md | 21 + .../docs/Models/AccountAllOfOwnerIdentity.md | 21 + .../docs/Models/AccountAllOfRecommendation.md | 20 + .../docs/Models/AccountAllOfSourceOwner.md | 21 + .../accounts/docs/Models/Accountattributes.md | 19 + .../docs/Models/Accountattributescreate.md | 19 + .../AccountattributescreateAttributes.md | 19 + .../docs/Models/Accountsasyncresult.md | 19 + .../docs/Models/Accounttogglerequest.md | 20 + .../docs/Models/Accountunlockrequest.md | 21 + .../docs/Models/Additionalownerref.md | 21 + .../accounts/docs/Models/Basecommondto.md | 22 + .../accounts/docs/Models/Basereferencedto.md | 21 + .../Models/Bulkidentitiesaccountsresponse.md | 21 + sdk-output/accounts/docs/Models/Dtotype.md | 75 + .../accounts/docs/Models/Entitlement.md | 37 + .../Models/EntitlementAccessModelMetadata.md | 19 + .../accounts/docs/Models/EntitlementOwner.md | 21 + .../accounts/docs/Models/EntitlementSource.md | 21 + .../accounts/docs/Models/Errormessagedto.md | 21 + .../accounts/docs/Models/Errorresponsedto.md | 22 + .../Models/Identitiesaccountsbulkrequest.md | 19 + sdk-output/accounts/docs/Models/Index.md | 19 + .../docs/Models/ListAccountsV1401Response.md | 19 + .../docs/Models/ListAccountsV1429Response.md | 19 + .../accounts/docs/Models/Localeorigin.md | 21 + .../accounts/docs/Models/Permissiondto.md | 20 + sdk-output/accounts/docs/Models/README.md | 46 + .../accounts/docs/Models/Recommendation.md | 20 + .../accounts/docs/Models/Taskresultdto.md | 21 + .../typescript_code_examples_overlay.yaml | 34 + .../api_usage/docs/Methods/ApiUsageV1Api.md | 113 + sdk-output/api_usage/docs/Methods/Index.md | 30 + .../api_usage/docs/Models/Errormessagedto.md | 21 + .../api_usage/docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetTotalCountV1401Response.md | 19 + .../docs/Models/GetTotalCountV1429Response.md | 19 + sdk-output/api_usage/docs/Models/Index.md | 19 + .../api_usage/docs/Models/Localeorigin.md | 21 + sdk-output/api_usage/docs/Models/README.md | 46 + .../api_usage/docs/Models/Summaryresponse.md | 20 + .../typescript_code_examples_overlay.yaml | 65 + .../docs/Methods/ApplicationDiscoveryV1Api.md | 193 ++ .../docs/Methods/Index.md | 30 + .../Models/Applicationdiscoveryrequest.md | 19 + .../Models/Applicationdiscoveryresponse.md | 36 + .../ApplicationdiscoveryresponseTarget.md | 21 + .../docs/Models/Basereferencedto.md | 21 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Fulldiscoveredapplications.md | 50 + ...iscoveredApplicationsV1200ResponseInner.md | 50 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Localizedmessage.md | 20 + .../docs/Models/Manualdiscoverapplications.md | 19 + .../Manualdiscoverapplicationstemplate.md | 20 + .../docs/Models/README.md | 46 + .../docs/Models/Slimdiscoveredapplications.md | 49 + .../StartApplicationDiscoveryV1401Response.md | 19 + .../StartApplicationDiscoveryV1403Response.md | 23 + ...tApplicationDiscoveryV1403ResponseOneOf.md | 19 + .../StartApplicationDiscoveryV1429Response.md | 19 + .../docs/Models/Taskdefinitionsummary.md | 24 + .../docs/Models/Taskreturndetails.md | 20 + .../docs/Models/Taskstatusmessage.md | 22 + .../TaskstatusmessageParametersInner.md | 18 + .../typescript_code_examples_overlay.yaml | 246 ++ .../approvals/docs/Methods/ApprovalsV1Api.md | 667 +++++ sdk-output/approvals/docs/Methods/Index.md | 30 + sdk-output/approvals/docs/Models/Approval2.md | 47 + .../docs/Models/Approval2ApprovalCriteria.md | 21 + .../Approval2ApprovalCriteriaApproval.md | 20 + .../Approval2ApprovalCriteriaRejection.md | 20 + .../docs/Models/Approvalapproverequest.md | 20 + .../docs/Models/Approvalattributesrequest.md | 21 + .../approvals/docs/Models/Approvalbatch.md | 20 + .../docs/Models/Approvalcancelrequest.md | 19 + .../approvals/docs/Models/Approvalcomment3.md | 22 + .../docs/Models/Approvalcommentsrequest.md | 19 + .../approvals/docs/Models/Approvalconfig.md | 28 + .../docs/Models/ApprovalconfigCronTimezone.md | 20 + .../Models/ApprovalconfigEscalationConfig.md | 22 + ...figEscalationConfigEscalationChainInner.md | 21 + .../Models/ApprovalconfigFallbackApprover.md | 20 + .../Models/ApprovalconfigReminderConfig.md | 22 + .../Models/ApprovalconfigSerialChainInner.md | 21 + .../Models/ApprovalconfigTimeoutConfig.md | 21 + .../docs/Models/Approvaldescription.md | 20 + .../approvals/docs/Models/Approvalidentity.md | 25 + .../Models/ApprovalidentityMembersInner.md | 22 + .../Models/ApprovalidentityOwnerOfInner.md | 21 + .../docs/Models/Approvalidentityrecord.md | 25 + .../approvals/docs/Models/Approvalname.md | 20 + .../Models/Approvalreassignmenthistory.md | 24 + .../docs/Models/Approvalreassignrequest.md | 21 + .../docs/Models/Approvalreference.md | 23 + .../docs/Models/Approvalrejectrequest.md | 19 + .../docs/Models/Approvalrequestedtarget.md | 25 + .../docs/Models/Bulkapproverequestdto.md | 21 + .../docs/Models/Bulkcancelrequestdto.md | 20 + .../docs/Models/Bulkreassignrequestdto.md | 22 + .../docs/Models/Bulkrejectrequestdto.md | 20 + .../approvals/docs/Models/Errormessagedto.md | 21 + .../approvals/docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetApprovalsV1401Response.md | 19 + .../docs/Models/GetApprovalsV1429Response.md | 19 + sdk-output/approvals/docs/Models/Index.md | 19 + .../approvals/docs/Models/Localeorigin.md | 21 + sdk-output/approvals/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 251 ++ sdk-output/apps/docs/Methods/AppsV1Api.md | 697 +++++ sdk-output/apps/docs/Methods/Index.md | 30 + .../apps/docs/Models/Accessprofiledetails.md | 41 + .../AccessprofiledetailsAccountSelector.md | 19 + .../docs/Models/Appaccessprofileselector.md | 20 + ...accessprofileselectorAccountMatchConfig.md | 19 + ...lectorAccountMatchConfigMatchExpression.md | 20 + .../apps/docs/Models/Appaccountdetails.md | 21 + .../Models/AppaccountdetailsSourceAccount.md | 23 + sdk-output/apps/docs/Models/ArrayInner.md | 18 + .../apps/docs/Models/Basereferencedto.md | 21 + sdk-output/apps/docs/Models/Dtotype.md | 75 + .../apps/docs/Models/Errormessagedto.md | 21 + .../apps/docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetSourceAppV1401Response.md | 19 + .../docs/Models/GetSourceAppV1429Response.md | 19 + sdk-output/apps/docs/Models/Index.md | 19 + .../apps/docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + sdk-output/apps/docs/Models/Localeorigin.md | 21 + sdk-output/apps/docs/Models/Matchterm.md | 24 + sdk-output/apps/docs/Models/README.md | 46 + sdk-output/apps/docs/Models/Sourceapp.md | 30 + .../docs/Models/SourceappAccountSource.md | 23 + .../docs/Models/Sourceappbulkupdaterequest.md | 20 + .../apps/docs/Models/Sourceappcreatedto.md | 22 + .../Models/SourceappcreatedtoAccountSource.md | 21 + .../apps/docs/Models/Sourceapppatchdto.md | 31 + sdk-output/apps/docs/Models/Userapp.md | 29 + sdk-output/apps/docs/Models/UserappAccount.md | 21 + sdk-output/apps/docs/Models/UserappOwner.md | 22 + sdk-output/apps/docs/Models/UserappSource.md | 21 + .../apps/docs/Models/UserappSourceApp.md | 21 + .../typescript_code_examples_overlay.yaml | 48 + .../docs/Methods/AuthProfileV1Api.md | 158 ++ sdk-output/auth_profile/docs/Methods/Index.md | 30 + .../auth_profile/docs/Models/ArrayInner.md | 18 + .../auth_profile/docs/Models/Authprofile.md | 25 + .../docs/Models/Authprofilesummary.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetProfileConfigListV1401Response.md | 19 + .../GetProfileConfigListV1429Response.md | 19 + sdk-output/auth_profile/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../auth_profile/docs/Models/Localeorigin.md | 21 + sdk-output/auth_profile/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 31 + .../auth_users/docs/Methods/AuthUsersV1Api.md | 108 + sdk-output/auth_users/docs/Methods/Index.md | 30 + .../auth_users/docs/Models/ArrayInner.md | 18 + sdk-output/auth_users/docs/Models/Authuser.md | 36 + .../auth_users/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetAuthUserV1401Response.md | 19 + .../docs/Models/GetAuthUserV1429Response.md | 19 + sdk-output/auth_users/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../auth_users/docs/Models/Localeorigin.md | 21 + sdk-output/auth_users/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 89 + .../branding/docs/Methods/BrandingV1Api.md | 245 ++ sdk-output/branding/docs/Methods/Index.md | 30 + .../branding/docs/Models/Brandingitem.md | 26 + .../docs/Models/Brandingitemcreate.md | 26 + .../branding/docs/Models/Errormessagedto.md | 21 + .../branding/docs/Models/Errorresponsedto.md | 22 + .../Models/GetBrandingListV1401Response.md | 19 + .../Models/GetBrandingListV1429Response.md | 19 + sdk-output/branding/docs/Models/Index.md | 19 + .../branding/docs/Models/Localeorigin.md | 21 + sdk-output/branding/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 78 + .../CertificationCampaignFiltersV1Api.md | 247 ++ .../docs/Methods/Index.md | 30 + .../docs/Models/Campaignfilterdetails.md | 25 + .../CampaignfilterdetailsCriteriaListInner.md | 28 + .../docs/Models/Criteriatype.md | 39 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../ListCampaignFiltersV1200Response.md | 20 + .../ListCampaignFiltersV1401Response.md | 19 + .../ListCampaignFiltersV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Operation.md | 31 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 346 +++ .../Methods/CertificationCampaignsV1Api.md | 1015 +++++++ .../docs/Methods/Index.md | 30 + .../docs/Models/Accessconstraint.md | 21 + .../docs/Models/Activatecampaignoptions.md | 19 + .../docs/Models/Adminreviewreassign.md | 21 + .../Models/AdminreviewreassignReassignTo.md | 20 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Campaign2.md | 41 + .../docs/Models/Campaign2AllOfFilter.md | 21 + ...ampaign2AllOfMachineAccountCampaignInfo.md | 20 + ...mpaign2AllOfRoleCompositionCampaignInfo.md | 24 + ...oleCompositionCampaignInfoRemediatorRef.md | 21 + ...llOfRoleCompositionCampaignInfoReviewer.md | 21 + .../Campaign2AllOfSearchCampaignInfo.md | 24 + ...ampaign2AllOfSearchCampaignInfoReviewer.md | 21 + .../Campaign2AllOfSourceOwnerCampaignInfo.md | 19 + ...aign2AllOfSourcesWithOrphanEntitlements.md | 21 + .../docs/Models/Campaignalert.md | 20 + .../docs/Models/Campaigncompleteoptions.md | 19 + .../docs/Models/Campaignreference.md | 25 + .../docs/Models/Campaignreport.md | 24 + .../docs/Models/Campaignreportsconfig.md | 19 + .../docs/Models/Campaignsdeleterequest.md | 19 + .../docs/Models/Campaigntemplate.md | 27 + .../docs/Models/CampaigntemplateOwnerRef.md | 22 + .../docs/Models/Certificationtask.md | 26 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetActiveCampaignsV1200ResponseInner.md | 41 + .../Models/GetActiveCampaignsV1401Response.md | 19 + .../Models/GetActiveCampaignsV1429Response.md | 19 + .../docs/Models/GetCampaignV1200Response.md | 41 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Reassignmenttraildto.md | 21 + .../docs/Models/Reportresultreference.md | 22 + .../docs/Models/Reporttype.md | 25 + .../docs/Models/Schedule2.md | 24 + .../docs/Models/Schedule2Days.md | 21 + .../docs/Models/Schedule2Hours.md | 21 + .../docs/Models/Schedule2Months.md | 21 + .../docs/Models/Slimcampaign.md | 32 + .../docs/Models/Sodreportresultdto.md | 21 + .../typescript_code_examples_overlay.yaml | 73 + .../Methods/CertificationSummariesV1Api.md | 215 ++ .../docs/Methods/Index.md | 30 + .../docs/Models/Accesssummary.md | 22 + .../docs/Models/AccesssummaryAccess.md | 21 + .../docs/Models/Activityinsights.md | 21 + .../Models/Certificationidentitysummary.md | 22 + .../docs/Models/Dataaccess.md | 21 + .../docs/Models/DataaccessCategoriesInner.md | 20 + .../docs/Models/DataaccessImpactScore.md | 19 + .../docs/Models/DataaccessPoliciesInner.md | 19 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...GetIdentityDecisionSummaryV1401Response.md | 19 + ...GetIdentityDecisionSummaryV1429Response.md | 19 + .../Models/Identitycertdecisionsummary.md | 34 + .../Identityreferencewithnameandemail.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Reviewableaccessprofile.md | 28 + .../docs/Models/Reviewableentitlement.md | 36 + .../Models/ReviewableentitlementAccount.md | 30 + .../ReviewableentitlementAccountOwner.md | 21 + .../docs/Models/Reviewablerole.md | 27 + .../typescript_code_examples_overlay.yaml | 195 ++ .../docs/Methods/CertificationsV1Api.md | 536 ++++ .../certifications/docs/Methods/Index.md | 30 + .../docs/Models/Accessreviewitem.md | 25 + .../docs/Models/Accesssummary.md | 22 + .../docs/Models/AccesssummaryAccess.md | 21 + .../docs/Models/Activityinsights.md | 21 + .../docs/Models/Campaignreference.md | 25 + .../docs/Models/Certificationdecision.md | 21 + .../Models/Certificationidentitysummary.md | 22 + .../docs/Models/Certificationphase.md | 23 + .../docs/Models/Certificationreference.md | 22 + .../docs/Models/Certificationtask.md | 26 + .../certifications/docs/Models/Dataaccess.md | 21 + .../docs/Models/DataaccessCategoriesInner.md | 20 + .../docs/Models/DataaccessImpactScore.md | 19 + .../docs/Models/DataaccessPoliciesInner.md | 19 + .../certifications/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Identitycertificationdto.md | 35 + .../Identityreferencewithnameandemail.md | 22 + .../certifications/docs/Models/Index.md | 19 + ...ListIdentityCertificationsV1401Response.md | 19 + ...ListIdentityCertificationsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Permissiondto.md | 20 + .../certifications/docs/Models/README.md | 46 + .../docs/Models/Reassignment.md | 20 + .../docs/Models/Reassignmenttraildto.md | 21 + .../docs/Models/Reassignreference.md | 20 + .../docs/Models/Reviewableaccessprofile.md | 28 + .../docs/Models/Reviewableentitlement.md | 36 + .../Models/ReviewableentitlementAccount.md | 30 + .../ReviewableentitlementAccountOwner.md | 21 + .../docs/Models/Reviewablerole.md | 27 + .../docs/Models/Reviewdecision.md | 24 + .../certifications/docs/Models/Reviewer.md | 24 + .../docs/Models/Reviewreassign.md | 21 + .../docs/Models/Reviewrecommendation.md | 21 + .../typescript_code_examples_overlay.yaml | 45 + .../docs/Methods/ClassifySourceV1Api.md | 139 + .../classify_source/docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...ineAccountFromSourceStatusV1401Response.md | 19 + ...ineAccountFromSourceStatusV1429Response.md | 19 + .../classify_source/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../classify_source/docs/Models/README.md | 46 + ...fyMachineAccountFromSourceV1200Response.md | 19 + .../docs/Models/Sourceclassificationstatus.md | 22 + .../SourceclassificationstatusAllOfCounts.md | 21 + .../typescript_code_examples_overlay.yaml | 304 ++ .../docs/Methods/ConfigurationHubV1Api.md | 845 ++++++ .../configuration_hub/docs/Methods/Index.md | 30 + .../docs/Models/Approvalcomment.md | 23 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Backupoptions.md | 20 + .../docs/Models/Backupresponse.md | 35 + .../CreateUploadedConfigurationV1Request.md | 20 + .../docs/Models/Deployrequest.md | 19 + .../docs/Models/Deployresponse.md | 30 + .../docs/Models/Draftresponse.md | 34 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetObjectMappingsV1401Response.md | 19 + .../Models/GetObjectMappingsV1429Response.md | 19 + .../configuration_hub/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatch.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/ListDeploysV1200Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Objectexportimportnames.md | 19 + .../Models/Objectmappingbulkcreaterequest.md | 19 + .../Models/Objectmappingbulkcreateresponse.md | 19 + .../Models/Objectmappingbulkpatchrequest.md | 19 + .../Models/Objectmappingbulkpatchresponse.md | 19 + .../docs/Models/Objectmappingrequest.md | 23 + .../docs/Models/Objectmappingresponse.md | 26 + .../configuration_hub/docs/Models/README.md | 46 + .../docs/Models/Scheduledactionpayload.md | 23 + .../Models/ScheduledactionpayloadContent.md | 23 + ...eduledactionpayloadContentBackupOptions.md | 20 + .../docs/Models/Scheduledactionresponse.md | 25 + .../Models/ScheduledactionresponseContent.md | 23 + ...duledactionresponseContentBackupOptions.md | 20 + ...eContentBackupOptionsObjectOptionsValue.md | 19 + .../typescript_code_examples_overlay.yaml | 92 + .../docs/Methods/ConnectorCustomizersV1Api.md | 260 ++ .../docs/Methods/Index.md | 30 + .../Connectorcustomizercreaterequest.md | 19 + .../Connectorcustomizercreateresponse.md | 22 + .../Models/Connectorcustomizersresponse.md | 24 + .../Connectorcustomizerupdaterequest.md | 19 + .../Connectorcustomizerupdateresponse.md | 24 + ...onnectorcustomizerversioncreateresponse.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../ListConnectorCustomizersV1401Response.md | 19 + .../ListConnectorCustomizersV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 93 + .../Methods/ConnectorRuleManagementV1Api.md | 266 ++ .../docs/Methods/Index.md | 30 + .../docs/Models/Argument.md | 21 + .../docs/Models/Connectorrulecreaterequest.md | 24 + .../ConnectorrulecreaterequestSignature.md | 20 + .../docs/Models/Connectorruleresponse.md | 27 + .../docs/Models/Connectorruleupdaterequest.md | 25 + .../Models/Connectorrulevalidationresponse.md | 20 + ...ectorrulevalidationresponseDetailsInner.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetConnectorRuleListV1401Response.md | 19 + .../GetConnectorRuleListV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Sourcecode.md | 20 + .../typescript_code_examples_overlay.yaml | 206 ++ .../docs/Methods/ConnectorsV1Api.md | 574 ++++ sdk-output/connectors/docs/Methods/Index.md | 30 + .../connectors/docs/Models/ArrayInner.md | 18 + .../connectors/docs/Models/Connectordetail.md | 34 + .../connectors/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetConnectorV1401Response.md | 19 + .../docs/Models/GetConnectorV1429Response.md | 19 + sdk-output/connectors/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../connectors/docs/Models/Localeorigin.md | 21 + .../PutConnectorCorrelationConfigV1Request.md | 19 + .../PutConnectorSourceConfigV1Request.md | 19 + .../PutConnectorSourceTemplateV1Request.md | 19 + sdk-output/connectors/docs/Models/README.md | 46 + .../connectors/docs/Models/Updatedetail.md | 22 + .../connectors/docs/Models/V3connectordto.md | 26 + .../docs/Models/V3createconnectordto.md | 23 + .../typescript_code_examples_overlay.yaml | 290 ++ .../docs/Methods/CustomFormsV1Api.md | 772 +++++ sdk-output/custom_forms/docs/Methods/Index.md | 30 + .../docs/Models/Conditioneffect.md | 20 + .../docs/Models/ConditioneffectConfig.md | 20 + .../custom_forms/docs/Models/Conditionrule.md | 23 + ...reateFormDefinitionFileRequestV1Request.md | 19 + .../Models/Createformdefinitionrequest.md | 25 + .../docs/Models/Createforminstancerequest.md | 26 + sdk-output/custom_forms/docs/Models/Error.md | 21 + .../custom_forms/docs/Models/Errormessage.md | 21 + ...rmDefinitionsByTenantV1200ResponseInner.md | 21 + ...finitionsByTenantV1200ResponseInnerSelf.md | 19 + .../custom_forms/docs/Models/Formcondition.md | 21 + .../Formdefinitiondynamicschemarequest.md | 23 + ...efinitiondynamicschemarequestAttributes.md | 19 + .../Formdefinitiondynamicschemaresponse.md | 19 + .../Formdefinitionfileuploadresponse.md | 21 + .../docs/Models/Formdefinitioninput.md | 22 + .../docs/Models/Formdefinitionresponse.md | 28 + .../Formdefinitionselfimportexportdto.md | 21 + .../custom_forms/docs/Models/Formelement.md | 23 + .../Formelementdatasourceconfigoptions.md | 21 + .../Models/Formelementdynamicdatasource.md | 20 + .../Formelementdynamicdatasourceconfig.md | 22 + .../docs/Models/Formelementpreviewrequest.md | 19 + .../docs/Models/Formelementvalidationsset.md | 19 + .../custom_forms/docs/Models/Formerror.md | 21 + .../docs/Models/Forminstancecreatedby.md | 20 + .../docs/Models/Forminstancerecipient.md | 20 + .../docs/Models/Forminstanceresponse.md | 33 + .../custom_forms/docs/Models/Formowner.md | 21 + .../custom_forms/docs/Models/Formusedby.md | 21 + .../ImportFormDefinitionsV1202Response.md | 22 + ...FormDefinitionsV1202ResponseErrorsInner.md | 21 + .../ImportFormDefinitionsV1RequestInner.md | 21 + sdk-output/custom_forms/docs/Models/Index.md | 19 + .../Listformdefinitionsbytenantresponse.md | 20 + .../Listformelementdatabyelementidresponse.md | 19 + .../Listforminstancesbytenantresponse.md | 33 + .../Listpredefinedselectoptionsresponse.md | 19 + .../docs/Models/Previewdatasourceresponse.md | 19 + sdk-output/custom_forms/docs/Models/README.md | 46 + ...rchFormDefinitionsByTenantV1400Response.md | 22 + .../typescript_code_examples_overlay.yaml | 50 + .../CustomPasswordInstructionsV1Api.md | 166 ++ .../docs/Methods/Index.md | 30 + .../docs/Models/Custompasswordinstruction.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 156 + .../docs/Methods/CustomUserLevelsV1Api.md | 445 +++ .../custom_user_levels/docs/Methods/Index.md | 30 + .../docs/Models/ArrayInner.md | 18 + .../Models/Authuserlevelsidentitycount.md | 20 + .../docs/Models/Authuserslimresponse.md | 22 + .../custom_user_levels/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Hierarchicalrightset.md | 24 + .../docs/Models/Identityreference.md | 21 + .../custom_user_levels/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatch.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListUserLevelsV1401Response.md | 19 + .../Models/ListUserLevelsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Nestedconfig.md | 22 + .../docs/Models/Publicidentity.md | 26 + .../Models/PublicidentityAttributesInner.md | 21 + .../custom_user_levels/docs/Models/README.md | 46 + .../docs/Models/Rightsetdto.md | 29 + .../docs/Models/Userlevelpublishsummary.md | 22 + .../docs/Models/Userlevelrequest.md | 22 + .../docs/Models/Userlevelsummarydto.md | 33 + .../typescript_code_examples_overlay.yaml | 397 +++ .../docs/Methods/DataAccessSecurityV1Api.md | 1043 +++++++ .../docs/Methods/Index.md | 30 + .../Models/Activityconfigurationsettings.md | 26 + .../docs/Models/Applicationcrawlersettings.md | 28 + .../docs/Models/Applicationitem.md | 28 + .../docs/Models/Applicationtype.md | 47 + .../docs/Models/Assignresourceownerrequest.md | 21 + .../Models/Basecreateapplicationrequest.md | 30 + .../docs/Models/Basesettings.md | 20 + .../docs/Models/Businessservicetype.md | 157 + .../docs/Models/Crawlresourcessizesoptions.md | 25 + .../CreateIdentityCollectorV1200Response.md | 20 + .../Models/Createidentitycollectorrequest.md | 20 + .../docs/Models/Createschedulerequest.md | 28 + .../docs/Models/Dataclassificationsettings.md | 20 + .../docs/Models/Dataownermodel.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetTasksV1401Response.md | 19 + .../docs/Models/GetTasksV1429Response.md | 19 + .../docs/Models/Identitycollectorlistitem.md | 22 + .../data_access_security/docs/Models/Index.md | 19 + .../docs/Models/Int64stringkeyvaluepair.md | 20 + .../docs/Models/Localeorigin.md | 21 + .../Models/Permissioncollectorsettings.md | 24 + .../PutIdentityCollectorV1409Response.md | 21 + ...tityCollectorV1409ResponseMessagesInner.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Reelectrequest.md | 21 + .../docs/Models/Resourcemodel.md | 24 + .../docs/Models/Scheduleinfo.md | 33 + .../data_access_security/docs/Models/Tag.md | 20 + .../docs/Models/Taskinfo.md | 28 + .../Models/Updateidentitycollectorrequest.md | 21 + .../docs/Models/Updateschedulerequest.md | 28 + .../typescript_code_examples_overlay.yaml | 137 + .../docs/Methods/DataSegmentationV1Api.md | 389 +++ .../data_segmentation/docs/Methods/Index.md | 30 + .../docs/Models/DataSegment.md | 29 + .../data_segmentation/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Expression.md | 22 + .../docs/Models/ExpressionChildrenInner.md | 22 + ...aSegmentIdentityMembershipV1401Response.md | 19 + ...aSegmentIdentityMembershipV1429Response.md | 19 + .../data_segmentation/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Membershiptype.md | 23 + .../data_segmentation/docs/Models/README.md | 46 + .../data_segmentation/docs/Models/Ref.md | 20 + .../data_segmentation/docs/Models/Scope.md | 22 + .../docs/Models/Scopetype.md | 25 + .../docs/Models/Scopevisibilitytype.md | 25 + .../docs/Models/Segmentmembership.md | 21 + .../data_segmentation/docs/Models/Value.md | 20 + .../docs/Models/Visibilitycriteria.md | 19 + .../typescript_code_examples_overlay.yaml | 15 + .../docs/Methods/DeclassifySourceV1Api.md | 59 + .../declassify_source/docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../declassify_source/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../declassify_source/docs/Models/README.md | 46 + ...fyMachineAccountFromSourceV1401Response.md | 19 + ...fyMachineAccountFromSourceV1429Response.md | 19 + .../typescript_code_examples_overlay.yaml | 144 + .../docs/Methods/DimensionsV1Api.md | 399 +++ sdk-output/dimensions/docs/Methods/Index.md | 30 + .../dimensions/docs/Models/Accessduration.md | 20 + .../docs/Models/Accessmodelmetadata.md | 26 + .../Models/AccessmodelmetadataValuesInner.md | 21 + .../dimensions/docs/Models/Accessprofile.md | 34 + .../Models/Accessprofileapprovalscheme.md | 20 + .../docs/Models/Accessprofileref.md | 21 + .../docs/Models/Accessprofilesourceref.md | 21 + .../docs/Models/Additionalownerref.md | 21 + .../dimensions/docs/Models/ArrayInner.md | 18 + .../dimensions/docs/Models/Attributedto.md | 26 + .../docs/Models/Attributedtolist.md | 19 + .../docs/Models/Attributevaluedto.md | 21 + .../dimensions/docs/Models/Dimension.md | 28 + .../docs/Models/Dimensionbulkdeleterequest.md | 19 + .../docs/Models/Dimensioncriteriakey.md | 20 + .../docs/Models/Dimensioncriteriakeytype.md | 19 + .../docs/Models/Dimensioncriterialevel1.md | 22 + .../docs/Models/Dimensioncriterialevel2.md | 22 + .../docs/Models/Dimensioncriterialevel3.md | 21 + .../docs/Models/Dimensioncriteriaoperation.md | 23 + .../Models/Dimensionmembershipselector.md | 20 + .../Models/Dimensionmembershipselectortype.md | 19 + .../dimensions/docs/Models/Entitlement.md | 37 + .../Models/EntitlementAccessModelMetadata.md | 19 + .../docs/Models/EntitlementOwner.md | 21 + .../docs/Models/EntitlementSource.md | 21 + .../dimensions/docs/Models/Entitlementref.md | 21 + .../dimensions/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + sdk-output/dimensions/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListDimensionsV1401Response.md | 19 + .../Models/ListDimensionsV1429Response.md | 19 + .../dimensions/docs/Models/Localeorigin.md | 21 + .../dimensions/docs/Models/Ownerreference.md | 21 + .../dimensions/docs/Models/Permissiondto.md | 20 + .../docs/Models/Provisioningcriterialevel1.md | 22 + .../docs/Models/Provisioningcriterialevel2.md | 22 + .../docs/Models/Provisioningcriterialevel3.md | 22 + .../Models/Provisioningcriteriaoperation.md | 29 + sdk-output/dimensions/docs/Models/README.md | 46 + .../dimensions/docs/Models/Requestability.md | 24 + .../dimensions/docs/Models/Revocability.md | 19 + .../dimensions/docs/Models/Taskresultdto.md | 21 + .../typescript_code_examples_overlay.yaml | 89 + .../Methods/EntitlementConnectionsV1Api.md | 255 ++ .../docs/Methods/Index.md | 30 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Entitlementconnection.md | 41 + .../Entitlementconnectionbulkupdateitem.md | 20 + ...titlementconnectionbulkupdateresultitem.md | 22 + .../Models/Entitlementconnectionsearchhit.md | 28 + ...titlementconnectionsearchhitentitlement.md | 26 + ...ctionsearchhitentitlementPrivilegeLevel.md | 19 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + ...ListEntitlementConnectionsV1401Response.md | 19 + ...ListEntitlementConnectionsV1412Response.md | 19 + ...ListEntitlementConnectionsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 227 ++ .../docs/Methods/EntitlementsV1Api.md | 614 ++++ sdk-output/entitlements/docs/Methods/Index.md | 30 + .../docs/Models/Accessmodelmetadata.md | 26 + .../Models/AccessmodelmetadataValuesInner.md | 21 + .../docs/Models/Additionalownerref.md | 21 + .../entitlements/docs/Models/ArrayInner.md | 18 + .../entitlements/docs/Models/Entitlement.md | 37 + .../docs/Models/EntitlementSource.md | 21 + .../Models/Entitlementaccessrequestconfig.md | 24 + ...requestconfigMaxPermittedAccessDuration.md | 20 + .../docs/Models/Entitlementapprovalscheme.md | 20 + .../Models/Entitlementbulkupdaterequest.md | 20 + .../docs/Models/Entitlementprivilegelevel.md | 23 + .../docs/Models/Entitlementrequestconfig.md | 20 + .../Entitlementrevocationrequestconfig.md | 19 + .../Entitlementsourceresetbasereferencedto.md | 21 + .../entitlements/docs/Models/Entitlementv2.md | 37 + .../Entitlementv2AccessModelMetadata.md | 19 + .../docs/Models/Entitlementv2Owner.md | 21 + .../Models/Entitlementv2PrivilegeLevel.md | 23 + .../docs/Models/Entitlementv2Source.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../ImportEntitlementsBySourceV1Request.md | 19 + sdk-output/entitlements/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListEntitlementsV1401Response.md | 19 + .../Models/ListEntitlementsV1429Response.md | 19 + .../docs/Models/Loadentitlementtask.md | 25 + .../Models/LoadentitlementtaskReturnsInner.md | 20 + .../entitlements/docs/Models/Localeorigin.md | 21 + .../entitlements/docs/Models/Permissiondto.md | 20 + sdk-output/entitlements/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 131 + .../GlobalTenantSecuritySettingsV1Api.md | 359 +++ .../docs/Methods/Index.md | 30 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Federationprotocoldetails.md | 20 + .../GetAuthOrgNetworkConfigV1401Response.md | 19 + .../GetAuthOrgNetworkConfigV1429Response.md | 19 + .../docs/Models/Idpdetails.md | 32 + .../docs/Models/Index.md | 19 + .../docs/Models/Jitconfiguration.md | 21 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Lockoutconfiguration.md | 21 + .../docs/Models/Networkconfiguration.md | 21 + .../docs/Models/README.md | 46 + .../Models/Serviceproviderconfiguration.md | 22 + ...igurationFederationProtocolDetailsInner.md | 35 + .../docs/Models/Sessionconfiguration.md | 21 + .../docs/Models/Spdetails.md | 23 + .../typescript_code_examples_overlay.yaml | 165 ++ .../docs/Methods/GovernanceGroupsV1Api.md | 465 +++ .../governance_groups/docs/Methods/Index.md | 30 + .../docs/Models/ArrayInner.md | 18 + .../BulkworkgroupmembersrequestInner.md | 21 + .../docs/Models/Connectedobject.md | 22 + .../docs/Models/Connectedobjecttype.md | 25 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../governance_groups/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../ListWorkgroupMembersV1200ResponseInner.md | 22 + .../Models/ListWorkgroupsV1401Response.md | 19 + .../Models/ListWorkgroupsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../governance_groups/docs/Models/Ownerdto.md | 21 + .../governance_groups/docs/Models/README.md | 46 + .../docs/Models/Workgroupbulkdeleterequest.md | 19 + .../docs/Models/Workgroupconnectiondto.md | 20 + .../Models/WorkgroupconnectiondtoObject.md | 22 + .../docs/Models/Workgroupdeleteitem.md | 21 + .../docs/Models/Workgroupdto.md | 26 + .../docs/Models/WorkgroupdtoOwner.md | 23 + .../docs/Models/Workgroupmemberadditem.md | 21 + .../docs/Models/Workgroupmemberdeleteitem.md | 21 + .../typescript_code_examples_overlay.yaml | 177 ++ .../IAIAccessRequestRecommendationsV1Api.md | 493 ++++ .../docs/Methods/Index.md | 30 + .../Models/Accessrecommendationmessage.md | 19 + ...ccessrequestrecommendationactionitemdto.md | 20 + ...uestrecommendationactionitemresponsedto.md | 21 + .../Accessrequestrecommendationconfigdto.md | 24 + .../Models/Accessrequestrecommendationitem.md | 20 + .../Accessrequestrecommendationitemdetail.md | 25 + ...ssrequestrecommendationitemdetailAccess.md | 22 + .../Accessrequestrecommendationitemtype.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...cessRequestRecommendationsV1401Response.md | 19 + ...cessRequestRecommendationsV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Translationmessage.md | 20 + .../typescript_code_examples_overlay.yaml | 52 + .../docs/Methods/IAICommonAccessV1Api.md | 159 ++ .../iai_common_access/docs/Methods/Index.md | 30 + .../docs/Models/Commonaccessidstatus.md | 20 + .../docs/Models/Commonaccessitemaccess.md | 24 + .../docs/Models/Commonaccessitemrequest.md | 20 + .../docs/Models/Commonaccessitemresponse.md | 25 + .../docs/Models/Commonaccessitemstate.md | 21 + .../docs/Models/Commonaccessresponse.md | 26 + .../docs/Models/Commonaccesstype.md | 21 + .../Models/CreateCommonAccessV1429Response.md | 19 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetCommonAccessV1401Response.md | 19 + .../iai_common_access/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../iai_common_access/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 164 ++ .../docs/Methods/IAIOutliersV1Api.md | 467 +++ sdk-output/iai_outliers/docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...etIdentityOutlierSnapshotsV1401Response.md | 19 + ...etIdentityOutlierSnapshotsV1429Response.md | 19 + sdk-output/iai_outliers/docs/Models/Index.md | 19 + .../docs/Models/Latestoutliersummary.md | 23 + .../iai_outliers/docs/Models/Localeorigin.md | 21 + .../iai_outliers/docs/Models/Outlier.md | 29 + .../docs/Models/Outliercontributingfeature.md | 26 + .../docs/Models/Outlierfeaturesummary.md | 26 + ...summaryOutlierFeatureDisplayValuesInner.md | 21 + .../docs/Models/Outlierfeaturetranslation.md | 20 + .../Outlierscontributingfeatureaccessitems.md | 24 + .../docs/Models/Outliersummary.md | 23 + .../docs/Models/Outliervaluetype.md | 20 + sdk-output/iai_outliers/docs/Models/README.md | 46 + .../docs/Models/Translationmessage.md | 20 + .../typescript_code_examples_overlay.yaml | 19 + .../Methods/IAIPeerGroupStrategiesV1Api.md | 72 + .../docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPeerGroupOutliersV1401Response.md | 19 + .../GetPeerGroupOutliersV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Peergroupmember.md | 22 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 47 + .../docs/Methods/IAIRecommendationsV1Api.md | 149 + .../iai_recommendations/docs/Methods/Index.md | 30 + .../docs/Models/Accessitemref.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Featurevaluedto.md | 21 + .../Models/GetRecommendationsV1401Response.md | 19 + .../Models/GetRecommendationsV1429Response.md | 19 + .../iai_recommendations/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../iai_recommendations/docs/Models/README.md | 46 + .../docs/Models/Recommendationconfigdto.md | 22 + .../docs/Models/Recommendationrequest.md | 20 + .../docs/Models/Recommendationrequestdto.md | 23 + .../docs/Models/Recommendationresponse.md | 23 + .../docs/Models/Recommendationresponsedto.md | 19 + .../docs/Models/Recommendercalculations.md | 26 + ...ndercalculationsIdentityAttributesValue.md | 19 + .../docs/Models/Translationmessage.md | 20 + .../typescript_code_examples_overlay.yaml | 471 +++ .../docs/Methods/IAIRoleMiningV1Api.md | 1285 +++++++++ .../iai_role_mining/docs/Methods/Index.md | 30 + .../iai_role_mining/docs/Models/ArrayInner.md | 18 + .../docs/Models/ArrayInner1.md | 18 + .../docs/Models/Entitycreatedbydto.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetRoleMiningSessionsV1401Response.md | 19 + .../GetRoleMiningSessionsV1429Response.md | 19 + .../iai_role_mining/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/Jsonpatchoperationrolemining.md | 21 + .../JsonpatchoperationroleminingValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../iai_role_mining/docs/Models/README.md | 46 + .../docs/Models/Roleminingentitlement.md | 27 + .../docs/Models/Roleminingentitlementref.md | 22 + .../docs/Models/Roleminingidentity.md | 21 + .../Models/Roleminingidentitydistribution.md | 20 + ...ngidentitydistributionDistributionInner.md | 20 + .../docs/Models/Roleminingpotentialrole.md | 39 + ...RoleminingpotentialrolePotentialRoleRef.md | 20 + .../Roleminingpotentialroleapplication.md | 20 + ...Roleminingpotentialroleeditentitlements.md | 20 + .../Roleminingpotentialroleentitlements.md | 20 + .../Roleminingpotentialroleexportrequest.md | 20 + .../Roleminingpotentialroleexportresponse.md | 22 + .../Roleminingpotentialroleexportstate.md | 25 + ...Roleminingpotentialroleprovisionrequest.md | 23 + .../Roleminingpotentialroleprovisionstate.md | 25 + .../docs/Models/Roleminingpotentialroleref.md | 20 + .../Roleminingpotentialrolesourceusage.md | 22 + .../Models/Roleminingpotentialrolesummary.md | 35 + ...RoleminingpotentialrolesummaryCreatedBy.md | 20 + .../docs/Models/Roleminingroletype.md | 21 + .../Models/Roleminingsessiondraftroledto.md | 28 + .../docs/Models/Roleminingsessiondto.md | 29 + .../Models/Roleminingsessionparametersdto.md | 27 + .../docs/Models/Roleminingsessionresponse.md | 36 + .../RoleminingsessionresponseCreatedBy.md | 20 + .../docs/Models/Roleminingsessionscope.md | 21 + .../Models/Roleminingsessionscopingmethod.md | 21 + .../docs/Models/Roleminingsessionstate.md | 29 + .../docs/Models/Roleminingsessionstatus.md | 19 + .../typescript_code_examples_overlay.yaml | 35 + sdk-output/icons/docs/Methods/IconsV1Api.md | 115 + sdk-output/icons/docs/Methods/Index.md | 30 + .../icons/docs/Models/Errormessagedto.md | 21 + .../icons/docs/Models/Errorresponsedto.md | 22 + sdk-output/icons/docs/Models/Index.md | 19 + sdk-output/icons/docs/Models/Localeorigin.md | 21 + sdk-output/icons/docs/Models/README.md | 46 + .../icons/docs/Models/SetIconV1200Response.md | 19 + .../icons/docs/Models/SetIconV1401Response.md | 19 + .../icons/docs/Models/SetIconV1429Response.md | 19 + .../icons/docs/Models/SetIconV1Request.md | 19 + .../typescript_code_examples_overlay.yaml | 197 ++ .../docs/Methods/IdentitiesV1Api.md | 566 ++++ sdk-output/identities/docs/Methods/Index.md | 30 + .../docs/Models/Accessrequestcontext.md | 19 + .../identities/docs/Models/Accountinfodto.md | 21 + .../docs/Models/Assignmentcontextdto.md | 21 + .../docs/Models/Basereferencedto.md | 21 + .../docs/Models/Contextattributedto.md | 21 + .../docs/Models/ContextattributedtoValue.md | 18 + sdk-output/identities/docs/Models/Dtotype.md | 75 + .../identities/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetRoleAssignmentsV1200ResponseInner.md | 29 + sdk-output/identities/docs/Models/Identity.md | 31 + .../docs/Models/IdentityLifecycleState.md | 20 + .../docs/Models/IdentityManagerRef.md | 21 + .../docs/Models/Identityassociationdetails.md | 20 + ...sociationdetailsAssociationDetailsInner.md | 20 + .../docs/Models/Identityentities.md | 19 + .../Models/IdentityentitiesIdentityEntity.md | 21 + .../docs/Models/Identityentitlements.md | 20 + .../Identityownershipassociationdetails.md | 19 + ...sociationdetailsAssociationDetailsInner.md | 20 + .../identities/docs/Models/Identitysyncjob.md | 21 + .../docs/Models/Identitysyncpayload.md | 20 + sdk-output/identities/docs/Models/Index.md | 19 + .../docs/Models/Inviteidentitiesrequest.md | 20 + .../docs/Models/Lifecyclestatedto.md | 20 + .../Models/ListIdentitiesV1401Response.md | 19 + .../Models/ListIdentitiesV1429Response.md | 19 + .../identities/docs/Models/Localeorigin.md | 21 + .../docs/Models/Localizedmessage.md | 20 + .../docs/Models/Processidentitiesrequest.md | 19 + sdk-output/identities/docs/Models/README.md | 46 + .../docs/Models/Roleassignmentdto.md | 29 + .../docs/Models/RoleassignmentdtoAssigner.md | 21 + .../RoleassignmentdtoAssignmentContext.md | 21 + .../docs/Models/Roleassignmentref.md | 23 + .../identities/docs/Models/Rolematchdto.md | 20 + .../identities/docs/Models/Roletargetdto.md | 21 + .../Models/Sendaccountverificationrequest.md | 20 + .../identities/docs/Models/Taggedobjectdto.md | 21 + sdk-output/identities/docs/Models/Target.md | 21 + .../docs/Models/Taskdefinitionsummary.md | 24 + .../docs/Models/Taskresultresponse.md | 21 + .../docs/Models/Taskreturndetails.md | 20 + .../identities/docs/Models/Taskstatus.md | 36 + .../docs/Models/Taskstatusmessage.md | 22 + .../TaskstatusmessageParametersInner.md | 18 + .../typescript_code_examples_overlay.yaml | 94 + .../docs/Methods/IdentityAttributesV1Api.md | 261 ++ .../identity_attributes/docs/Methods/Index.md | 30 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Identityattribute2.md | 26 + .../docs/Models/Identityattributenames.md | 19 + .../identity_attributes/docs/Models/Index.md | 19 + .../ListIdentityAttributesV1401Response.md | 19 + .../ListIdentityAttributesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../identity_attributes/docs/Models/README.md | 46 + .../docs/Models/Source2.md | 20 + .../typescript_code_examples_overlay.yaml | 217 ++ .../docs/Methods/IdentityHistoryV1Api.md | 586 ++++ .../identity_history/docs/Methods/Index.md | 30 + .../Models/Accessitemaccessprofileresponse.md | 30 + ...ssitemaccessprofileresponseAppRefsInner.md | 20 + .../docs/Models/Accessitemaccountresponse.md | 25 + .../docs/Models/Accessitemappresponse.md | 23 + .../docs/Models/Accessitemassociated.md | 24 + .../Models/AccessitemassociatedAccessItem.md | 37 + .../docs/Models/Accessitemdiff.md | 22 + .../Models/Accessitementitlementresponse.md | 30 + .../docs/Models/Accessitemremoved.md | 24 + .../docs/Models/Accessitemroleresponse.md | 26 + .../docs/Models/Accessrequested.md | 22 + .../docs/Models/Accessrequestitemresponse.md | 26 + .../docs/Models/Accessrequestresponse2.md | 21 + .../docs/Models/Accountstatuschanged.md | 23 + .../Models/AccountstatuschangedAccount.md | 25 + .../AccountstatuschangedStatusChange.md | 20 + .../docs/Models/Approvalinforesponse.md | 21 + .../docs/Models/Attributechange.md | 21 + .../docs/Models/Attributeschanged.md | 22 + .../docs/Models/Certifierresponse.md | 20 + .../docs/Models/Correlatedgovernanceevent.md | 25 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...toricalIdentityEventsV1200ResponseInner.md | 34 + .../docs/Models/Identitycertified.md | 26 + .../docs/Models/Identitycompareresponse.md | 19 + .../docs/Models/Identityhistoryresponse.md | 24 + .../docs/Models/Identitylistitem.md | 24 + .../Models/Identitysnapshotsummaryresponse.md | 19 + .../identity_history/docs/Models/Index.md | 19 + .../ListHistoricalIdentitiesV1401Response.md | 19 + .../ListHistoricalIdentitiesV1429Response.md | 19 + ...stIdentityAccessItemsV1200ResponseInner.md | 37 + ...tySnapshotAccessItemsV1200ResponseInner.md | 37 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Metricresponse.md | 20 + .../identity_history/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 174 ++ .../docs/Methods/IdentityProfilesV1Api.md | 493 ++++ .../identity_profiles/docs/Methods/Index.md | 30 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Basecommondto.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Identityattributeconfig.md | 20 + .../docs/Models/Identityattributepreview.md | 22 + .../docs/Models/Identityattributetransform.md | 20 + .../Identityexceptionreportreference.md | 20 + .../docs/Models/Identitypreviewrequest.md | 20 + .../docs/Models/Identitypreviewresponse.md | 20 + .../Models/IdentitypreviewresponseIdentity.md | 21 + .../docs/Models/Identityprofile.md | 31 + ...IdentityprofileAllOfAuthoritativeSource.md | 21 + .../docs/Models/IdentityprofileAllOfOwner.md | 21 + .../Models/Identityprofileexportedobject.md | 21 + .../IdentityprofileexportedobjectSelf.md | 21 + .../docs/Models/Importobject.md | 21 + .../identity_profiles/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../ListIdentityProfilesV1401Response.md | 19 + .../ListIdentityProfilesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Objectimportresult.md | 22 + .../identity_profiles/docs/Models/README.md | 46 + .../docs/Models/Spconfigmessage.md | 21 + .../docs/Models/Taskresultsimplified.md | 25 + .../docs/Models/Transformdefinition.md | 20 + .../typescript_code_examples_overlay.yaml | 31 + sdk-output/jit_access/docs/Methods/Index.md | 30 + .../jit_access/docs/Methods/JITAccessV1Api.md | 112 + .../jit_access/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetJitActivationConfigV1401Response.md | 19 + .../GetJitActivationConfigV1429Response.md | 19 + sdk-output/jit_access/docs/Models/Index.md | 19 + .../docs/Models/Jitaccessoperationrequest.md | 21 + .../Models/JitaccessoperationrequestValue.md | 18 + .../Models/Jitactivationconfigresponse.md | 27 + .../jit_access/docs/Models/Localeorigin.md | 21 + sdk-output/jit_access/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 45 + .../jit_activations/docs/Methods/Index.md | 30 + .../docs/Methods/JITActivationsV1Api.md | 154 + .../docs/Models/Activationworkflowstatus.md | 33 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../jit_activations/docs/Models/Index.md | 19 + .../Models/Jitactivationactivaterequest.md | 20 + .../Models/Jitactivationactivateresponse.md | 24 + .../Models/Jitactivationdeactivaterequest.md | 19 + .../Models/Jitactivationdeactivateresponse.md | 23 + .../docs/Models/Jitactivationextendrequest.md | 20 + .../Models/Jitactivationextendresponse.md | 24 + .../docs/Models/Localeorigin.md | 21 + .../jit_activations/docs/Models/README.md | 46 + .../StartActivateWorkflowV1401Response.md | 19 + .../StartActivateWorkflowV1429Response.md | 19 + .../typescript_code_examples_overlay.yaml | 93 + sdk-output/launchers/docs/Methods/Index.md | 30 + .../launchers/docs/Methods/LaunchersV1Api.md | 259 ++ .../launchers/docs/Models/Errormessagedto.md | 21 + .../launchers/docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetLaunchersV1200Response.md | 20 + .../docs/Models/GetLaunchersV1401Response.md | 19 + .../docs/Models/GetLaunchersV1429Response.md | 19 + sdk-output/launchers/docs/Models/Index.md | 19 + sdk-output/launchers/docs/Models/Launcher.md | 28 + .../launchers/docs/Models/LauncherOwner.md | 20 + .../docs/Models/LauncherReference.md | 20 + .../launchers/docs/Models/Launcherrequest.md | 24 + .../docs/Models/LauncherrequestReference.md | 20 + .../launchers/docs/Models/Localeorigin.md | 21 + sdk-output/launchers/docs/Models/README.md | 46 + .../docs/Models/StartLauncherV1200Response.md | 19 + .../typescript_code_examples_overlay.yaml | 100 + .../lifecycle_states/docs/Methods/Index.md | 30 + .../docs/Methods/LifecycleStatesV1Api.md | 311 ++ .../docs/Models/Accessactionconfiguration.md | 19 + .../docs/Models/Accountaction.md | 22 + .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Basecommondto.md | 22 + .../docs/Models/Emailnotificationoption.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../lifecycle_states/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Lifecyclestate.md | 32 + .../docs/Models/Lifecyclestatedeleted.md | 21 + .../docs/Models/Localeorigin.md | 21 + .../lifecycle_states/docs/Models/README.md | 46 + .../Models/SetLifecycleStateV1200Response.md | 19 + .../Models/SetLifecycleStateV1401Response.md | 19 + .../Models/SetLifecycleStateV1429Response.md | 19 + .../docs/Models/SetLifecycleStateV1Request.md | 19 + .../typescript_code_examples_overlay.yaml | 16 + .../docs/Methods/Index.md | 30 + .../Methods/MachineAccountClassifyV1Api.md | 61 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + ...SendClassifyMachineAccountV1200Response.md | 19 + ...SendClassifyMachineAccountV1401Response.md | 19 + ...SendClassifyMachineAccountV1429Response.md | 19 + .../typescript_code_examples_overlay.yaml | 49 + .../docs/Methods/Index.md | 30 + .../MachineAccountCreationRequestV1Api.md | 160 ++ .../docs/Models/Accountrequestasyncresult.md | 19 + .../docs/Models/Accountrequestdetailsdto.md | 26 + .../AccountrequestdetailsdtoRequester.md | 21 + .../docs/Models/Accountrequestphase.md | 22 + .../docs/Models/Accountrequestphasestate.md | 31 + .../docs/Models/Basereferencedto.md | 21 + ...reateMachineAccountRequestV1401Response.md | 19 + ...reateMachineAccountRequestV1429Response.md | 19 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/Machineaccountcreateaccessdto.md | 21 + ...hineaccountcreateaccessdtoSubtypesInner.md | 22 + .../Machineaccountcreaterequestinput.md | 26 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 64 + .../docs/Methods/Index.md | 30 + .../Methods/MachineAccountMappingsV1Api.md | 185 ++ .../docs/Models/Attributemappings.md | 20 + .../Models/AttributemappingsAllOfTarget.md | 21 + ...tributemappingsAllOfTransformDefinition.md | 21 + ...pingsAllOfTransformDefinitionAttributes.md | 19 + ...AllOfTransformDefinitionAttributesInput.md | 20 + ...formDefinitionAttributesInputAttributes.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + ...ListMachineAccountMappingsV1401Response.md | 19 + ...ListMachineAccountMappingsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 134 + .../docs/Methods/Index.md | 30 + .../Methods/MachineAccountSubtypesV1Api.md | 387 +++ .../docs/Models/ArrayInner.md | 18 + .../Models/CreateSourceSubtypeV1Request.md | 23 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../LoadBulkSourceSubtypesV1401Response.md | 19 + .../LoadBulkSourceSubtypesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/Machineaccountsubtypeconfigdto.md | 21 + ...untsubtypeconfigdtoMachineAccountCreate.md | 25 + ...untsubtypeconfigdtoMachineAccountDelete.md | 20 + .../Models/Machinesubtypeapprovalconfig.md | 20 + .../docs/Models/README.md | 46 + .../docs/Models/Sourcesubtypewithsource.md | 28 + .../Models/SourcesubtypewithsourceSource.md | 21 + .../typescript_code_examples_overlay.yaml | 159 ++ .../machine_accounts/docs/Methods/Index.md | 30 + .../docs/Methods/MachineAccountsV1Api.md | 465 +++ .../docs/Models/Basecommondto.md | 22 + .../CreateMachineAccountSubtypeV1Request.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../machine_accounts/docs/Models/Index.md | 19 + .../ListMachineAccountsV1401Response.md | 19 + .../ListMachineAccountsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Machineaccount.md | 39 + .../machine_accounts/docs/Models/README.md | 46 + .../docs/Models/Sourcesubtype.md | 26 + .../typescript_code_examples_overlay.yaml | 46 + .../docs/Methods/Index.md | 30 + .../MachineClassificationConfigV1Api.md | 139 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...achineClassificationConfigV1401Response.md | 19 + ...achineClassificationConfigV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/Machineclassificationconfig.md | 23 + .../Machineclassificationcriterialevel1.md | 24 + .../Machineclassificationcriterialevel2.md | 24 + .../Machineclassificationcriterialevel3.md | 24 + .../Machineclassificationcriteriaoperation.md | 31 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 122 + .../machine_identities/docs/Methods/Index.md | 30 + .../docs/Methods/MachineIdentitiesV1Api.md | 349 +++ .../docs/Models/Basecommondto.md | 22 + .../docs/Models/Basereferencedto.md | 21 + .../machine_identities/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../machine_identities/docs/Models/Index.md | 19 + .../ListMachineIdentitiesV1401Response.md | 19 + .../ListMachineIdentitiesV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Localizedmessage.md | 20 + .../docs/Models/MachineIdentityDtoOwners.md | 20 + .../MachineIdentityRequestUserEntitlements.md | 20 + ...MachineIdentityResponseUserEntitlements.md | 22 + .../docs/Models/Machineidentity.md | 29 + .../Machineidentityaggregationrequest.md | 20 + .../Machineidentityaggregationresponse.md | 36 + ...achineidentityaggregationresponseTarget.md | 21 + .../docs/Models/Machineidentityrequest.md | 30 + .../docs/Models/Machineidentityresponse.md | 34 + .../Machineidentityuserentitlementresponse.md | 23 + ...ntityuserentitlementresponseEntitlement.md | 21 + ...neidentityuserentitlementresponseSource.md | 21 + .../machine_identities/docs/Models/README.md | 46 + .../docs/Models/Taskdefinitionsummary.md | 24 + .../docs/Models/Taskreturndetails.md | 20 + .../docs/Models/Taskstatusmessage.md | 22 + .../TaskstatusmessageParametersInner.md | 18 + .../typescript_code_examples_overlay.yaml | 110 + .../managed_clients/docs/Methods/Index.md | 30 + .../docs/Methods/ManagedClientsV1Api.md | 305 ++ .../managed_clients/docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetManagedClientsV1401Response.md | 19 + .../Models/GetManagedClientsV1429Response.md | 19 + .../docs/Models/Healthevent.md | 25 + .../docs/Models/Healthindicatorcategory.md | 20 + .../managed_clients/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Managedclient.md | 39 + .../Models/Managedclienthealthindicators.md | 22 + .../ManagedclienthealthindicatorsBody.md | 45 + ...enthealthindicatorsBodyHealthIndicators.md | 21 + .../docs/Models/Managedclientrequest.md | 22 + .../docs/Models/Managedclientstatus.md | 22 + .../docs/Models/Managedclientstatuscode.md | 31 + .../docs/Models/Managedclienttype.md | 25 + .../managed_clients/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 80 + .../docs/Methods/Index.md | 30 + .../docs/Methods/ManagedClusterTypesV1Api.md | 228 ++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetManagedClusterTypesV1401Response.md | 19 + .../GetManagedClusterTypesV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatch.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Managedclustertype.md | 23 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 126 + .../managed_clusters/docs/Methods/Index.md | 30 + .../docs/Methods/ManagedClustersV1Api.md | 347 +++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Clientlogconfiguration.md | 23 + .../Clientlogconfigurationdurationminutes.md | 22 + .../Clientlogconfigurationexpiration.md | 22 + .../docs/Models/Clustermanualupgrade.md | 19 + .../Models/ClustermanualupgradeJobsInner.md | 24 + ...adeJobsInnerManagedProcessConfiguration.md | 23 + ...JobsInnerManagedProcessConfigurationCcg.md | 23 + ...sInnerManagedProcessConfigurationCharon.md | 22 + ...nerManagedProcessConfigurationOtelAgent.md | 22 + ...bsInnerManagedProcessConfigurationRelay.md | 22 + ...InnerManagedProcessConfigurationToolbox.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetManagedClustersV1401Response.md | 19 + .../Models/GetManagedClustersV1429Response.md | 19 + .../managed_clusters/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Managedclienttype.md | 25 + .../docs/Models/Managedcluster.md | 50 + .../Models/ManagedclusterUpdatePreferences.md | 21 + .../docs/Models/Managedclusterattributes.md | 20 + .../Models/Managedclusterencryptionconfig.md | 19 + .../docs/Models/Managedclusterkeypair.md | 21 + .../docs/Models/Managedclusterqueue.md | 20 + .../docs/Models/Managedclusterredis.md | 20 + .../docs/Models/Managedclusterrequest.md | 22 + .../docs/Models/Managedclustertypes.md | 37 + .../PutClientLogConfigurationV1Request.md | 23 + .../managed_clusters/docs/Models/README.md | 46 + .../docs/Models/Standardlevel.md | 31 + .../typescript_code_examples_overlay.yaml | 103 + .../mfa_configuration/docs/Methods/Index.md | 30 + .../docs/Methods/MFAConfigurationV1Api.md | 284 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetMFAOktaConfigV1401Response.md | 19 + .../Models/GetMFAOktaConfigV1429Response.md | 19 + .../mfa_configuration/docs/Models/Index.md | 19 + .../docs/Models/Kbaanswerrequestitem.md | 20 + .../docs/Models/Kbaanswerresponseitem.md | 21 + .../docs/Models/Kbaquestion.md | 22 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Mfaconfigtestresponse.md | 20 + .../docs/Models/Mfaduoconfig.md | 24 + .../docs/Models/Mfaoktaconfig.md | 23 + .../mfa_configuration/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 227 ++ .../docs/Methods/Index.md | 30 + .../docs/Methods/MultiHostIntegrationV1Api.md | 627 ++++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...tMultiHostIntegrationsListV1401Response.md | 19 + ...tMultiHostIntegrationsListV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Managercorrelationmapping.md | 20 + .../docs/Models/Multihostintegrations.md | 50 + ...ostintegrationsAccountCorrelationConfig.md | 21 + ...ihostintegrationsAccountCorrelationRule.md | 21 + .../MultihostintegrationsAccountsFile.md | 23 + ...ihostintegrationsBeforeProvisioningRule.md | 21 + .../Models/MultihostintegrationsCluster.md | 21 + ...ultihostintegrationsConnectorAttributes.md | 25 + ...torAttributesConnectorFileUploadHistory.md | 19 + ...sConnectorAttributesMultiHostAttributes.md | 22 + ...ultihostintegrationsManagementWorkgroup.md | 21 + ...stintegrationsManagerCorrelationMapping.md | 20 + ...ihostintegrationsManagerCorrelationRule.md | 21 + .../docs/Models/MultihostintegrationsOwner.md | 21 + ...tihostintegrationsPasswordPoliciesInner.md | 21 + .../MultihostintegrationsSchemasInner.md | 21 + .../Multihostintegrationsaggscheduleupdate.md | 26 + .../Models/Multihostintegrationscreate.md | 27 + .../Multihostintegrationscreatesources.md | 21 + .../Multihostintegrationtemplatetype.md | 21 + .../docs/Models/Multihostsources.md | 49 + .../MultihostsourcesBeforeProvisioningRule.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Sourcecreationerrors.md | 24 + ...tSourceConnectionMultihostV1200Response.md | 23 + .../UpdateMultiHostSourcesV1RequestInner.md | 21 + ...dateMultiHostSourcesV1RequestInnerValue.md | 18 + .../typescript_code_examples_overlay.yaml | 511 ++++ .../docs/Methods/Index.md | 30 + .../NonEmployeeLifecycleManagementV1Api.md | 1411 +++++++++ .../docs/Models/Approvalstatus.md | 27 + .../docs/Models/ArrayInner.md | 18 + ...DeleteNonEmployeeRecordsInBulkV1Request.md | 19 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...ImportNonEmployeeRecordsInBulkV1Request.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../ListNonEmployeeRecordsV1401Response.md | 19 + .../ListNonEmployeeRecordsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/Nonemployeeapprovaldecision.md | 19 + .../docs/Models/Nonemployeeapprovalitem.md | 27 + .../Models/Nonemployeeapprovalitembase.md | 26 + .../Models/Nonemployeeapprovalitemdetail.md | 27 + .../docs/Models/Nonemployeeapprovalsummary.md | 21 + .../docs/Models/Nonemployeebulkuploadjob.md | 23 + .../Models/Nonemployeebulkuploadstatus.md | 19 + .../docs/Models/Nonemployeeidentitydtotype.md | 21 + .../Nonemployeeidentityreferencewithid.md | 20 + .../docs/Models/Nonemployeeidnuserrequest.md | 19 + .../docs/Models/Nonemployeerecord.md | 31 + .../Nonemployeerejectapprovaldecision.md | 19 + .../docs/Models/Nonemployeerequest.md | 38 + .../docs/Models/Nonemployeerequestbody.md | 28 + .../docs/Models/Nonemployeerequestlite.md | 20 + .../docs/Models/Nonemployeerequestsummary.md | 22 + .../Nonemployeerequestwithoutapprovalitem.md | 35 + .../docs/Models/Nonemployeeschemaattribute.md | 28 + .../Models/Nonemployeeschemaattributebody.md | 24 + .../Models/Nonemployeeschemaattributetype.md | 23 + .../docs/Models/Nonemployeesource.md | 26 + .../docs/Models/Nonemployeesourcelite.md | 22 + ...nemployeesourcelitewithschemaattributes.md | 23 + .../Models/Nonemployeesourcerequestbody.md | 24 + .../Nonemployeesourcewithcloudexternalid.md | 27 + .../Models/Nonemployeesourcewithnecount.md | 27 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 251 ++ .../notifications/docs/Methods/Index.md | 30 + .../docs/Methods/NotificationsV1Api.md | 670 +++++ .../Models/CreateDomainDkimV1405Response.md | 21 + .../docs/Models/Dkimattributes.md | 24 + .../docs/Models/Domainaddress.md | 19 + .../docs/Models/Domainstatusdto.md | 24 + .../docs/Models/Emailstatusdto.md | 23 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...ificationTemplateVariablesV1401Response.md | 19 + ...ificationTemplateVariablesV1429Response.md | 19 + sdk-output/notifications/docs/Models/Index.md | 19 + .../notifications/docs/Models/Localeorigin.md | 21 + .../docs/Models/Mailfromattributes.md | 23 + .../docs/Models/Mailfromattributesdto.md | 20 + .../notifications/docs/Models/Medium.md | 23 + .../Models/Notificationtemplatecontext.md | 21 + .../docs/Models/Preferencesdto.md | 21 + .../notifications/docs/Models/README.md | 46 + .../Models/Sendtestnotificationrequestdto.md | 25 + .../docs/Models/Templatebulkdeletedto.md | 21 + .../notifications/docs/Models/Templatedto.md | 34 + .../docs/Models/TemplatedtoSlackTemplate.md | 29 + .../docs/Models/TemplatedtoTeamsTemplate.md | 29 + .../docs/Models/Templatedtodefault.md | 31 + .../docs/Models/Templatemediumdto.md | 23 + .../docs/Models/Templateslack.md | 29 + .../Models/TemplateslackAutoApprovalData.md | 23 + .../docs/Models/TemplateslackCustomFields.md | 22 + .../docs/Models/Templateteams.md | 29 + .../docs/Models/Templatevariable.md | 22 + .../docs/Models/Templatevariablesdto.md | 22 + .../typescript_code_examples_overlay.yaml | 76 + .../oauth_clients/docs/Methods/Index.md | 30 + .../docs/Methods/OAuthClientsV1Api.md | 219 ++ .../oauth_clients/docs/Models/Accesstype.md | 21 + .../oauth_clients/docs/Models/ArrayInner.md | 18 + .../oauth_clients/docs/Models/Clienttype.md | 21 + .../docs/Models/Createoauthclientrequest.md | 33 + .../docs/Models/Createoauthclientresponse.md | 37 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Getoauthclientresponse.md | 39 + .../oauth_clients/docs/Models/Granttype.md | 23 + sdk-output/oauth_clients/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListOauthClientsV1401Response.md | 19 + .../Models/ListOauthClientsV1429Response.md | 19 + .../oauth_clients/docs/Models/Localeorigin.md | 21 + .../oauth_clients/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 47 + sdk-output/org_config/docs/Methods/Index.md | 30 + .../org_config/docs/Methods/OrgConfigV1Api.md | 143 + .../org_config/docs/Models/ArrayInner.md | 18 + .../org_config/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetOrgConfigV1401Response.md | 19 + .../docs/Models/GetOrgConfigV1429Response.md | 19 + sdk-output/org_config/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../org_config/docs/Models/Localeorigin.md | 21 + .../org_config/docs/Models/Orgconfig.md | 28 + sdk-output/org_config/docs/Models/README.md | 46 + .../org_config/docs/Models/Reportconfigdto.md | 22 + .../typescript_code_examples_overlay.yaml | 127 + .../parameter_storage/docs/Methods/Index.md | 30 + .../docs/Methods/ParameterStorageV1Api.md | 365 +++ .../Models/DeleteParameterV1409Response.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetAttestationDocumentV1401Response.md | 19 + .../GetAttestationDocumentV1429Response.md | 19 + .../parameter_storage/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Parameterstorageattestationdocument.md | 19 + .../docs/Models/Parameterstoragejsonpatch.md | 22 + .../Models/Parameterstoragenewparameter.md | 24 + .../docs/Models/Parameterstorageparameter.md | 29 + .../docs/Models/Parameterstoragereference.md | 23 + .../Models/Parameterstorageupdateparameter.md | 23 + .../parameter_storage/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 44 + .../docs/Methods/Index.md | 30 + .../Methods/PasswordConfigurationV1Api.md | 142 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPasswordOrgConfigV1401Response.md | 19 + .../GetPasswordOrgConfigV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Passwordorgconfig.md | 22 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 29 + .../password_dictionary/docs/Methods/Index.md | 30 + .../docs/Methods/PasswordDictionaryV1Api.md | 196 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPasswordDictionaryV1401Response.md | 19 + .../GetPasswordDictionaryV1429Response.md | 19 + .../password_dictionary/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/PutPasswordDictionaryV1Request.md | 19 + .../password_dictionary/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 61 + .../password_management/docs/Methods/Index.md | 30 + .../docs/Methods/PasswordManagementV1Api.md | 224 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../password_management/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Passwordchangerequest.md | 23 + .../docs/Models/Passwordchangeresponse.md | 20 + .../docs/Models/Passworddigittoken.md | 20 + .../docs/Models/Passworddigittokenreset.md | 21 + .../docs/Models/Passwordinfo.md | 24 + .../docs/Models/Passwordinfoaccount.md | 20 + .../docs/Models/Passwordinfoquerydto.md | 20 + .../docs/Models/Passwordstatus.md | 22 + .../Models/QueryPasswordInfoV1401Response.md | 19 + .../Models/QueryPasswordInfoV1429Response.md | 19 + .../password_management/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 83 + .../password_policies/docs/Methods/Index.md | 30 + .../docs/Methods/PasswordPoliciesV1Api.md | 254 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPasswordPolicyByIdV1401Response.md | 19 + .../GetPasswordPolicyByIdV1429Response.md | 19 + .../password_policies/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Passwordpolicyv3dto.md | 49 + .../password_policies/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 78 + .../docs/Methods/Index.md | 30 + .../docs/Methods/PasswordSyncGroupsV1Api.md | 252 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPasswordSyncGroupsV1401Response.md | 19 + .../GetPasswordSyncGroupsV1429Response.md | 19 + .../password_sync_groups/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Passwordsyncgroup.md | 24 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 62 + .../docs/Methods/Index.md | 30 + .../docs/Methods/PersonalAccessTokensV1Api.md | 207 ++ .../docs/Models/ArrayInner.md | 18 + .../Createpersonalaccesstokenrequest.md | 23 + .../Createpersonalaccesstokenresponse.md | 26 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/Getpersonalaccesstokenresponse.md | 28 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../ListPersonalAccessTokensV1401Response.md | 19 + .../ListPersonalAccessTokensV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Patowner.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 76 + .../privilege_criteria/docs/Methods/Index.md | 30 + .../docs/Methods/PrivilegeCriteriaV1Api.md | 217 ++ .../Models/Createprivilegecriteriarequest.md | 23 + ...eateprivilegecriteriarequestGroupsInner.md | 20 + ...riarequestGroupsInnerCriteriaItemsInner.md | 22 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../privilege_criteria/docs/Models/Index.md | 19 + .../ListPrivilegeCriteriaV1401Response.md | 19 + .../ListPrivilegeCriteriaV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Privilegecriteriadto.md | 24 + .../Models/PrivilegecriteriadtoGroupsInner.md | 20 + ...riteriadtoGroupsInnerCriteriaItemsInner.md | 23 + .../privilege_criteria/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 46 + .../docs/Methods/Index.md | 30 + .../PrivilegeCriteriaConfigurationV1Api.md | 165 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...GetPrivilegeCriteriaConfigV1401Response.md | 19 + ...GetPrivilegeCriteriaConfigV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Privilegecriteriaconfigdto.md | 23 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 33 + .../prompt_insights/docs/Methods/Index.md | 30 + .../docs/Methods/PromptInsightsV1Api.md | 111 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPromptInsightsMetricsV1401Response.md | 19 + .../GetPromptInsightsMetricsV1429Response.md | 19 + .../prompt_insights/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Promptinsight.md | 27 + .../docs/Models/Promptinsightsmetrics.md | 20 + .../prompt_insights/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 20 + .../public_identities/docs/Methods/Index.md | 30 + .../docs/Methods/PublicIdentitiesV1Api.md | 71 + .../public_identities/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPublicIdentitiesV1401Response.md | 19 + .../GetPublicIdentitiesV1429Response.md | 19 + .../docs/Models/Identityreference.md | 21 + .../public_identities/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Publicidentity.md | 26 + .../Models/PublicidentityAttributesInner.md | 21 + .../public_identities/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 29 + .../docs/Methods/Index.md | 30 + .../Methods/PublicIdentitiesConfigV1Api.md | 103 + .../docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetPublicIdentityConfigV1401Response.md | 19 + .../GetPublicIdentityConfigV1429Response.md | 19 + .../docs/Models/Identityreference.md | 21 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/Publicidentityattributeconfig.md | 20 + .../docs/Models/Publicidentityconfig.md | 21 + .../docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 64 + .../docs/Methods/Index.md | 30 + .../Methods/ReportsDataExtractionV1Api.md | 186 ++ .../Models/AccountsExportReportArguments.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetReportResultV1401Response.md | 19 + .../Models/GetReportResultV1429Response.md | 19 + .../IdentitiesDetailsReportArguments.md | 19 + .../docs/Models/IdentitiesReportArguments.md | 19 + ...tityProfileIdentityErrorReportArguments.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../Models/OrphanIdentitiesReportArguments.md | 19 + .../docs/Models/README.md | 46 + .../docs/Models/Reportdetails.md | 20 + .../docs/Models/ReportdetailsArguments.md | 27 + .../docs/Models/Reportresults.md | 26 + .../Models/SearchExportReportArguments.md | 22 + .../docs/Models/Taskresultdetails.md | 32 + .../Models/TaskresultdetailsMessagesInner.md | 23 + .../Models/TaskresultdetailsReturnsInner.md | 20 + .../UncorrelatedAccountsReportArguments.md | 19 + .../typescript_code_examples_overlay.yaml | 23 + .../requestable_objects/docs/Methods/Index.md | 30 + .../docs/Methods/RequestableObjectsV1Api.md | 79 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Identityreferencewithnameandemail.md | 22 + .../requestable_objects/docs/Models/Index.md | 19 + .../ListRequestableObjectsV1401Response.md | 19 + .../ListRequestableObjectsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../requestable_objects/docs/Models/README.md | 46 + .../docs/Models/Requestableobject.md | 28 + .../Models/Requestableobjectrequeststatus.md | 23 + .../docs/Models/Requestableobjecttype.md | 23 + .../typescript_code_examples_overlay.yaml | 158 ++ .../role_insights/docs/Methods/Index.md | 30 + .../docs/Methods/RoleInsightsV1Api.md | 449 +++ .../CreateRoleInsightRequestsV1401Response.md | 19 + .../CreateRoleInsightRequestsV1429Response.md | 19 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + sdk-output/role_insights/docs/Models/Index.md | 19 + .../role_insights/docs/Models/Localeorigin.md | 21 + .../role_insights/docs/Models/README.md | 46 + .../role_insights/docs/Models/Roleinsight.md | 24 + .../docs/Models/Roleinsightsentitlement.md | 24 + .../Models/Roleinsightsentitlementchanges.md | 25 + .../docs/Models/Roleinsightsidentities.md | 21 + .../docs/Models/Roleinsightsinsight.md | 23 + .../docs/Models/Roleinsightsresponse.md | 24 + .../docs/Models/Roleinsightsrole.md | 23 + .../docs/Models/Roleinsightssummary.md | 24 + .../typescript_code_examples_overlay.yaml | 93 + .../role_propagation/docs/Methods/Index.md | 30 + .../docs/Methods/RolePropagationV1Api.md | 288 ++ .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../role_propagation/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../role_propagation/docs/Models/README.md | 46 + .../docs/Models/RolePropagationConfigInput.md | 19 + .../Models/RolePropagationConfigResponse.md | 22 + .../Models/RolePropagationOngoingResponse.md | 20 + ...onOngoingResponseRolePropagationDetails.md | 27 + .../docs/Models/RolePropagationResponse.md | 19 + .../Models/RolePropagationStatusResponse.md | 27 + ...RolePropagationStatusResponseLaunchedBy.md | 21 + ...lePropagationStatusResponseTerminatedBy.md | 21 + .../StartRolePropagationV1401Response.md | 19 + .../StartRolePropagationV1429Response.md | 19 + .../typescript_code_examples_overlay.yaml | 269 ++ sdk-output/roles/docs/Methods/Index.md | 30 + sdk-output/roles/docs/Methods/RolesV1Api.md | 786 +++++ .../roles/docs/Models/Accessduration.md | 20 + .../roles/docs/Models/Accessmodelmetadata.md | 26 + .../Models/AccessmodelmetadataValuesInner.md | 21 + .../roles/docs/Models/Accessprofileref.md | 21 + .../roles/docs/Models/Additionalownerref.md | 21 + .../docs/Models/Approvalschemeforrole.md | 20 + sdk-output/roles/docs/Models/ArrayInner.md | 18 + sdk-output/roles/docs/Models/Attributedto.md | 26 + .../roles/docs/Models/Attributedtolist.md | 19 + .../roles/docs/Models/Attributevaluedto.md | 21 + .../roles/docs/Models/Dimensionattribute.md | 21 + sdk-output/roles/docs/Models/Dimensionref.md | 21 + .../roles/docs/Models/Dimensionschema.md | 19 + sdk-output/roles/docs/Models/Dtotype.md | 75 + sdk-output/roles/docs/Models/Entitlement.md | 37 + .../Models/EntitlementAccessModelMetadata.md | 19 + .../roles/docs/Models/EntitlementOwner.md | 21 + .../roles/docs/Models/EntitlementSource.md | 21 + .../roles/docs/Models/Entitlementref.md | 21 + .../roles/docs/Models/Errormessagedto.md | 21 + .../roles/docs/Models/Errorresponsedto.md | 22 + sdk-output/roles/docs/Models/Index.md | 19 + .../roles/docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/ListRolesV1401Response.md | 19 + .../docs/Models/ListRolesV1429Response.md | 19 + sdk-output/roles/docs/Models/Localeorigin.md | 21 + .../roles/docs/Models/Ownerreference.md | 21 + sdk-output/roles/docs/Models/Permissiondto.md | 20 + sdk-output/roles/docs/Models/README.md | 46 + .../docs/Models/Requestabilityforrole.md | 26 + .../roles/docs/Models/Revocabilityforrole.md | 21 + sdk-output/roles/docs/Models/Role.md | 38 + .../docs/Models/Roleassignmentsourcetype.md | 21 + .../docs/Models/Rolebulkdeleterequest.md | 19 + .../docs/Models/Rolebulkupdateresponse.md | 22 + .../roles/docs/Models/Rolecriteriakey.md | 21 + .../roles/docs/Models/Rolecriteriakeytype.md | 23 + .../roles/docs/Models/Rolecriterialevel1.md | 22 + .../roles/docs/Models/Rolecriterialevel2.md | 22 + .../roles/docs/Models/Rolecriterialevel3.md | 21 + .../docs/Models/Rolecriteriaoperation.md | 41 + .../Models/Rolegetallbulkupdateresponse.md | 22 + sdk-output/roles/docs/Models/Roleidentity.md | 23 + .../roles/docs/Models/Rolelistfilterdto.md | 20 + .../RolelistfilterdtoAmmKeyValuesInner.md | 20 + .../docs/Models/Rolemembershipidentity.md | 22 + .../docs/Models/Rolemembershipselector.md | 21 + .../docs/Models/Rolemembershipselectortype.md | 21 + .../Rolemetadatabulkupdatebyfilterrequest.md | 22 + ...atabulkupdatebyfilterrequestValuesInner.md | 20 + .../Rolemetadatabulkupdatebyidrequest.md | 22 + ...etadatabulkupdatebyidrequestValuesInner.md | 20 + .../Rolemetadatabulkupdatebyqueryrequest.md | 22 + ...databulkupdatebyqueryrequestValuesInner.md | 20 + sdk-output/roles/docs/Models/Taskresultdto.md | 21 + .../typescript_code_examples_overlay.yaml | 95 + sdk-output/saved_search/docs/Methods/Index.md | 30 + .../docs/Methods/SavedSearchV1Api.md | 281 ++ sdk-output/saved_search/docs/Models/Bound.md | 20 + sdk-output/saved_search/docs/Models/Column.md | 20 + .../docs/Models/CreateSavedSearchV1Request.md | 29 + .../saved_search/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + sdk-output/saved_search/docs/Models/Filter.md | 22 + .../saved_search/docs/Models/Filtertype.md | 23 + sdk-output/saved_search/docs/Models/Index.md | 19 + .../Models/ListSavedSearchesV1401Response.md | 19 + .../Models/ListSavedSearchesV1429Response.md | 19 + .../saved_search/docs/Models/Localeorigin.md | 21 + sdk-output/saved_search/docs/Models/README.md | 46 + sdk-output/saved_search/docs/Models/Range.md | 20 + .../saved_search/docs/Models/Savedsearch.md | 33 + .../docs/Models/Savedsearchdetail.md | 27 + .../docs/Models/SavedsearchdetailFilters.md | 22 + .../docs/Models/Savedsearchname.md | 20 + .../docs/Models/Searcharguments.md | 21 + .../docs/Models/Typedreference.md | 20 + .../typescript_code_examples_overlay.yaml | 95 + .../scheduled_search/docs/Methods/Index.md | 30 + .../docs/Methods/ScheduledSearchV1Api.md | 294 ++ .../Models/CreateScheduledSearchV1Request.md | 28 + .../scheduled_search/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../scheduled_search/docs/Models/Index.md | 19 + .../ListScheduledSearchV1401Response.md | 19 + .../ListScheduledSearchV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../scheduled_search/docs/Models/README.md | 46 + .../scheduled_search/docs/Models/Schedule.md | 24 + .../docs/Models/ScheduleDays.md | 21 + .../docs/Models/ScheduleHours.md | 21 + .../docs/Models/ScheduleMonths.md | 21 + .../docs/Models/Scheduledsearch.md | 31 + .../docs/Models/ScheduledsearchAllOfOwner.md | 20 + .../docs/Models/Scheduledsearchname.md | 20 + .../docs/Models/Scheduletype.md | 27 + .../docs/Models/Searchschedule.md | 26 + .../Models/SearchscheduleRecipientsInner.md | 20 + .../scheduled_search/docs/Models/Selector.md | 21 + .../docs/Models/Selectortype.md | 21 + .../docs/Models/Typedreference.md | 20 + .../typescript_code_examples_overlay.yaml | 67 + sdk-output/search/docs/Methods/Index.md | 30 + sdk-output/search/docs/Methods/SearchV1Api.md | 212 ++ .../search/docs/Models/Aggregationresult.md | 20 + sdk-output/search/docs/Models/Aggregations.md | 22 + .../search/docs/Models/Aggregationtype.md | 21 + sdk-output/search/docs/Models/Bound.md | 20 + .../search/docs/Models/Bucketaggregation.md | 23 + sdk-output/search/docs/Models/Buckettype.md | 19 + .../search/docs/Models/Errormessagedto.md | 21 + .../search/docs/Models/Errorresponsedto.md | 22 + sdk-output/search/docs/Models/Filter.md | 22 + .../search/docs/Models/Filteraggregation.md | 22 + sdk-output/search/docs/Models/Filtertype.md | 23 + sdk-output/search/docs/Models/Index.md | 19 + sdk-output/search/docs/Models/Innerhit.md | 20 + sdk-output/search/docs/Models/Localeorigin.md | 21 + .../search/docs/Models/Metricaggregation.md | 21 + sdk-output/search/docs/Models/Metrictype.md | 31 + .../search/docs/Models/Nestedaggregation.md | 20 + sdk-output/search/docs/Models/Query.md | 22 + .../search/docs/Models/Queryresultfilter.md | 20 + sdk-output/search/docs/Models/Querytype.md | 25 + sdk-output/search/docs/Models/README.md | 46 + sdk-output/search/docs/Models/Range.md | 20 + sdk-output/search/docs/Models/Search.md | 34 + .../docs/Models/SearchPostV1401Response.md | 19 + .../docs/Models/SearchPostV1429Response.md | 19 + .../Models/Searchaggregationspecification.md | 23 + .../search/docs/Models/Searchfiltertype.md | 19 + .../Subsearchaggregationspecification.md | 23 + sdk-output/search/docs/Models/Textquery.md | 22 + .../search/docs/Models/Typeaheadquery.md | 25 + .../typescript_code_examples_overlay.yaml | 82 + .../docs/Methods/Index.md | 30 + .../SearchAttributeConfigurationV1Api.md | 264 ++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetSearchAttributeConfigV1401Response.md | 19 + .../GetSearchAttributeConfigV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../docs/Models/Searchattributeconfig.md | 21 + .../typescript_code_examples_overlay.yaml | 78 + sdk-output/segments/docs/Methods/Index.md | 30 + .../segments/docs/Methods/SegmentsV1Api.md | 240 ++ .../segments/docs/Models/Errormessagedto.md | 21 + .../segments/docs/Models/Errorresponsedto.md | 22 + sdk-output/segments/docs/Models/Expression.md | 22 + .../docs/Models/ExpressionChildrenInner.md | 22 + sdk-output/segments/docs/Models/Index.md | 19 + .../docs/Models/ListSegmentsV1401Response.md | 19 + .../docs/Models/ListSegmentsV1429Response.md | 19 + .../segments/docs/Models/Localeorigin.md | 21 + .../docs/Models/Ownerreferencesegments.md | 21 + sdk-output/segments/docs/Models/README.md | 46 + sdk-output/segments/docs/Models/Segment.md | 26 + .../docs/Models/SegmentVisibilityCriteria.md | 19 + sdk-output/segments/docs/Models/Value.md | 20 + .../docs/Models/Visibilitycriteria.md | 19 + .../typescript_code_examples_overlay.yaml | 154 + .../docs/Methods/Index.md | 30 + .../Methods/ServiceDeskIntegrationV1Api.md | 437 +++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Basecommondto.md | 22 + .../docs/Models/Beforeprovisioningruledto.md | 21 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + ...GetServiceDeskIntegrationsV1401Response.md | 19 + ...GetServiceDeskIntegrationsV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Ownerdto.md | 21 + .../docs/Models/Provisioningconfig.md | 23 + ...ProvisioningconfigPlanInitializerScript.md | 19 + .../docs/Models/Queuedcheckconfigdetails.md | 20 + .../docs/Models/README.md | 46 + .../docs/Models/Servicedeskintegrationdto.md | 31 + .../Servicedeskintegrationtemplatedto.md | 25 + .../Servicedeskintegrationtemplatetype.md | 21 + .../docs/Models/Servicedesksource.md | 21 + .../docs/Models/Sourceclusterdto.md | 21 + .../typescript_code_examples_overlay.yaml | 148 + .../docs/Methods/Index.md | 30 + .../Methods/SharedSignalsFrameworkSSFV1Api.md | 428 +++ .../docs/Models/Authorizationscheme.md | 19 + .../Models/Createstreamdeliveryrequest.md | 21 + .../docs/Models/Createstreamrequest.md | 21 + .../docs/Models/Deliveryrequest.md | 21 + .../docs/Models/Deliveryresponse.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetSSFConfigurationV1401Response.md | 19 + .../GetSSFConfigurationV1429Response.md | 19 + .../docs/Models/GetStreamV1200Response.md | 28 + .../docs/Models/Index.md | 19 + .../docs/Models/Jwk.md | 24 + .../docs/Models/Jwks.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/README.md | 46 + .../Replacestreamconfigurationrequest.md | 22 + ...placestreamconfigurationrequestDelivery.md | 21 + .../docs/Models/Streamconfigresponse.md | 28 + .../docs/Models/Streamstatusresponse.md | 21 + .../docs/Models/Transmittermetadata.md | 26 + .../docs/Models/Updatestreamconfigresponse.md | 29 + .../Updatestreamconfigurationrequest.md | 22 + .../docs/Models/Updatestreamstatusrequest.md | 21 + .../docs/Models/Verificationrequest.md | 20 + .../typescript_code_examples_overlay.yaml | 114 + .../sim_integrations/docs/Methods/Index.md | 30 + .../docs/Methods/SIMIntegrationsV1Api.md | 338 +++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Basecommondto.md | 22 + .../docs/Models/Beforeprovisioningruledto.md | 21 + .../sim_integrations/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../Models/GetSIMIntegrationV1401Response.md | 19 + .../Models/GetSIMIntegrationV1429Response.md | 19 + .../sim_integrations/docs/Models/Index.md | 19 + .../sim_integrations/docs/Models/Jsonpatch.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../sim_integrations/docs/Models/Ownerdto.md | 21 + .../docs/Models/Provisioningconfig.md | 23 + ...ProvisioningconfigPlanInitializerScript.md | 19 + .../sim_integrations/docs/Models/README.md | 46 + .../docs/Models/Servicedeskintegrationdto.md | 31 + .../docs/Models/Servicedesksource.md | 21 + .../docs/Models/Simintegrationdetails.md | 30 + ...ationdetailsAllOfBeforeProvisioningRule.md | 21 + .../docs/Models/Sourceclusterdto.md | 21 + .../typescript_code_examples_overlay.yaml | 263 ++ sdk-output/sod_policies/docs/Methods/Index.md | 30 + .../docs/Methods/SODPoliciesV1Api.md | 729 +++++ .../docs/Models/Accesscriteria.md | 20 + .../Models/AccesscriteriaCriteriaListInner.md | 21 + .../sod_policies/docs/Models/ArrayInner.md | 18 + .../docs/Models/Conflictingaccesscriteria.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + sdk-output/sod_policies/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../Models/ListSodPoliciesV1401Response.md | 19 + .../Models/ListSodPoliciesV1429Response.md | 19 + .../sod_policies/docs/Models/Localeorigin.md | 21 + .../docs/Models/Multipolicyrequest.md | 19 + sdk-output/sod_policies/docs/Models/README.md | 46 + .../docs/Models/Reportresultreference.md | 22 + .../sod_policies/docs/Models/Schedule.md | 24 + .../sod_policies/docs/Models/ScheduleDays.md | 21 + .../sod_policies/docs/Models/ScheduleHours.md | 21 + .../docs/Models/ScheduleMonths.md | 21 + .../sod_policies/docs/Models/Scheduletype.md | 27 + .../sod_policies/docs/Models/Selector.md | 21 + .../sod_policies/docs/Models/Selectortype.md | 21 + .../sod_policies/docs/Models/Sodpolicy.md | 36 + .../SodpolicyConflictingAccessCriteria.md | 20 + .../docs/Models/SodpolicyOwnerRef.md | 21 + .../docs/Models/Sodpolicyschedule.md | 27 + .../sod_policies/docs/Models/Sodrecipient.md | 21 + .../docs/Models/Sodreportresultdto.md | 21 + .../Models/Violationownerassignmentconfig.md | 20 + .../ViolationownerassignmentconfigOwnerRef.md | 21 + .../typescript_code_examples_overlay.yaml | 30 + .../sod_violations/docs/Methods/Index.md | 30 + .../docs/Methods/SODViolationsV1Api.md | 115 + .../sod_violations/docs/Models/Dtotype.md | 75 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Exceptionaccesscriteria.md | 20 + .../docs/Models/Exceptioncriteria.md | 19 + .../ExceptioncriteriaCriteriaListInner.md | 22 + .../docs/Models/Exceptioncriteriaaccess.md | 22 + .../docs/Models/Identitywithnewaccess.md | 20 + .../IdentitywithnewaccessAccessRefsInner.md | 20 + .../sod_violations/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../sod_violations/docs/Models/README.md | 46 + .../docs/Models/Sodpolicydto2.md | 21 + .../docs/Models/Sodviolationcheck.md | 20 + .../StartPredictSodViolationsV1401Response.md | 19 + .../StartPredictSodViolationsV1429Response.md | 19 + .../docs/Models/Violationcontext.md | 20 + .../docs/Models/ViolationcontextPolicy.md | 21 + .../docs/Models/Violationprediction.md | 19 + .../typescript_code_examples_overlay.yaml | 34 + .../source_usages/docs/Methods/Index.md | 30 + .../docs/Methods/SourceUsagesV1Api.md | 108 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetStatusBySourceIdV1401Response.md | 19 + .../GetStatusBySourceIdV1429Response.md | 19 + sdk-output/source_usages/docs/Models/Index.md | 19 + .../source_usages/docs/Models/Localeorigin.md | 21 + .../source_usages/docs/Models/README.md | 46 + .../source_usages/docs/Models/Sourceusage.md | 20 + .../docs/Models/Sourceusagestatus.md | 19 + .../typescript_code_examples_overlay.yaml | 899 ++++++ sdk-output/sources/docs/Methods/Index.md | 30 + .../sources/docs/Methods/SourcesV1Api.md | 2528 +++++++++++++++++ .../docs/Models/Accountdeleteconfigdto.md | 20 + .../sources/docs/Models/Approvalconfig.md | 28 + .../docs/Models/ApprovalconfigCronTimezone.md | 20 + .../Models/ApprovalconfigEscalationConfig.md | 22 + ...figEscalationConfigEscalationChainInner.md | 21 + .../Models/ApprovalconfigFallbackApprover.md | 20 + .../Models/ApprovalconfigReminderConfig.md | 22 + .../Models/ApprovalconfigSerialChainInner.md | 21 + .../Models/ApprovalconfigTimeoutConfig.md | 21 + sdk-output/sources/docs/Models/ArrayInner.md | 18 + .../docs/Models/Attributedefinition.md | 26 + .../docs/Models/AttributedefinitionSchema.md | 21 + .../docs/Models/Attributedefinitiontype.md | 27 + .../sources/docs/Models/Attrsyncsource.md | 21 + .../Models/Attrsyncsourceattributeconfig.md | 22 + .../docs/Models/Attrsyncsourceconfig.md | 20 + .../sources/docs/Models/Basereferencedto.md | 21 + .../sources/docs/Models/Connectordetail.md | 34 + .../sources/docs/Models/Correlationconfig.md | 21 + ...relationconfigAttributeAssignmentsInner.md | 25 + .../docs/Models/DeleteSourceV1202Response.md | 21 + .../docs/Models/Dependantappconnections.md | 27 + .../DependantappconnectionsAccountSource.md | 20 + ...tionsAccountSourcePasswordPoliciesInner.md | 21 + .../Models/Dependantconnectionsmissingdto.md | 20 + sdk-output/sources/docs/Models/Dtotype.md | 75 + .../Models/Entitlementaccessrequestconfig.md | 24 + ...requestconfigMaxPermittedAccessDuration.md | 20 + .../docs/Models/Entitlementapprovalscheme.md | 20 + .../Entitlementrevocationrequestconfig.md | 19 + .../sources/docs/Models/Errormessagedto.md | 21 + .../sources/docs/Models/Errorresponsedto.md | 22 + .../sources/docs/Models/Fielddetailsdto.md | 24 + .../Models/Identityprofilesconnections.md | 21 + .../Models/ImportAccountsSchemaV1Request.md | 19 + .../docs/Models/ImportAccountsV1Request.md | 20 + .../Models/ImportEntitlementsV1Request.md | 19 + sdk-output/sources/docs/Models/Index.md | 19 + .../sources/docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/ListSourcesV1401Response.md | 19 + .../docs/Models/ListSourcesV1429Response.md | 19 + .../sources/docs/Models/Loadaccountstask.md | 20 + .../docs/Models/LoadaccountstaskTask.md | 32 + .../Models/LoadaccountstaskTaskAttributes.md | 20 + .../LoadaccountstaskTaskMessagesInner.md | 23 + .../LoadaccountstaskTaskReturnsInner.md | 20 + .../docs/Models/Loadentitlementtask.md | 25 + .../Models/LoadentitlementtaskReturnsInner.md | 20 + .../Models/Loaduncorrelatedaccountstask.md | 20 + .../LoaduncorrelatedaccountstaskTask.md | 32 + ...duncorrelatedaccountstaskTaskAttributes.md | 20 + ...correlatedaccountstaskTaskMessagesInner.md | 23 + .../sources/docs/Models/Localeorigin.md | 21 + .../docs/Models/Managercorrelationmapping.md | 20 + .../Models/Nativechangedetectionconfig.md | 24 + .../Models/PasswordpolicyholdersdtoInner.md | 21 + .../Passwordpolicyholdersdtoattributes.md | 19 + ...cyholdersdtoattributesIdentityAttrInner.md | 20 + .../docs/Models/Provisioningpolicydto.md | 22 + sdk-output/sources/docs/Models/README.md | 46 + .../sources/docs/Models/Resourceobject.md | 31 + .../docs/Models/Resourceobjectsrequest.md | 20 + .../docs/Models/Resourceobjectsresponse.md | 23 + sdk-output/sources/docs/Models/Schedule3.md | 20 + sdk-output/sources/docs/Models/Schema.md | 30 + sdk-output/sources/docs/Models/Source.md | 49 + .../Models/SourceAccountCorrelationConfig.md | 21 + .../Models/SourceAccountCorrelationRule.md | 21 + .../Models/SourceBeforeProvisioningRule.md | 21 + .../sources/docs/Models/SourceCluster.md | 21 + .../docs/Models/SourceManagementWorkgroup.md | 21 + .../Models/SourceManagerCorrelationMapping.md | 20 + .../Models/SourceManagerCorrelationRule.md | 21 + sdk-output/sources/docs/Models/SourceOwner.md | 21 + .../Models/SourcePasswordPoliciesInner.md | 21 + .../sources/docs/Models/SourceSchemasInner.md | 21 + .../docs/Models/Sourceconnectionsdto.md | 25 + .../Models/Sourceentitlementrequestconfig.md | 20 + .../sources/docs/Models/Sourcehealthdto.md | 28 + .../sources/docs/Models/Sourcesyncjob.md | 21 + .../sources/docs/Models/Sourcesyncpayload.md | 20 + .../sources/docs/Models/Statusresponse.md | 23 + .../sources/docs/Models/Taskresultdto.md | 21 + sdk-output/sources/docs/Models/Transform.md | 21 + .../sources/docs/Models/Transformread.md | 23 + sdk-output/sources/docs/Models/Usagetype.md | 49 + .../typescript_code_examples_overlay.yaml | 106 + sdk-output/sp_config/docs/Methods/Index.md | 30 + .../sp_config/docs/Methods/SPConfigV1Api.md | 313 ++ .../sp_config/docs/Models/Configobject.md | 21 + .../sp_config/docs/Models/Errormessagedto.md | 21 + .../sp_config/docs/Models/Errorresponsedto.md | 22 + .../Models/ExportSpConfigV1401Response.md | 19 + .../Models/ExportSpConfigV1429Response.md | 19 + .../sp_config/docs/Models/Exportoptions.md | 21 + .../sp_config/docs/Models/Exportpayload.md | 22 + .../docs/Models/ImportSpConfigV1Request.md | 20 + .../sp_config/docs/Models/Importobject.md | 21 + .../sp_config/docs/Models/Importoptions.md | 23 + sdk-output/sp_config/docs/Models/Index.md | 19 + .../sp_config/docs/Models/Localeorigin.md | 21 + .../docs/Models/Objectexportimportoptions.md | 20 + .../docs/Models/Objectimportresult2.md | 22 + sdk-output/sp_config/docs/Models/README.md | 46 + .../docs/Models/Selfimportexportdto.md | 21 + .../docs/Models/Spconfigexportjob.md | 25 + .../docs/Models/Spconfigexportjobstatus.md | 26 + .../docs/Models/Spconfigexportresults.md | 24 + .../docs/Models/Spconfigimportjobstatus.md | 26 + .../docs/Models/Spconfigimportresults.md | 20 + .../sp_config/docs/Models/Spconfigjob.md | 24 + .../sp_config/docs/Models/Spconfigmessage2.md | 21 + .../sp_config/docs/Models/Spconfigobject.md | 26 + .../sp_config/docs/Models/Spconfigrule.md | 21 + .../docs/Models/SpconfigruleValue.md | 18 + .../sp_config/docs/Models/Spconfigrules.md | 21 + .../typescript_code_examples_overlay.yaml | 239 ++ .../docs/Methods/Index.md | 30 + .../SuggestedEntitlementDescriptionV1Api.md | 655 +++++ .../docs/Models/ArrayInner.md | 18 + .../docs/Models/Autowritesetting.md | 21 + .../docs/Models/Autowritesettingpatch.md | 21 + .../docs/Models/AutowritesettingpatchValue.md | 18 + .../docs/Models/Autowritesettingresponse.md | 23 + ...ulkapproveentitlementrecommendationitem.md | 22 + ...approveentitlementrecommendationrequest.md | 19 + ...kapproveentitlementrecommendationresult.md | 21 + .../CreateAutoWriteSettingsV1409Response.md | 21 + .../Entitlementrecommendationassignee.md | 20 + .../EntitlementrecommendationassigneeOneOf.md | 20 + ...EntitlementrecommendationassigneeOneOf1.md | 19 + .../Entitlementrecommendationassignrequest.md | 20 + .../Entitlementrecommendationassignresult.md | 19 + .../Models/Entitlementrecommendationrecord.md | 36 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetAutoWriteSettingsV1401Response.md | 19 + .../GetAutoWriteSettingsV1429Response.md | 19 + .../docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../Models/Privilegedrecommendationgroup.md | 24 + .../Privilegedrecommendationinstance.md | 28 + .../docs/Models/README.md | 46 + .../docs/Models/Searchcriteria.md | 26 + .../docs/Models/SearchcriteriaFiltersValue.md | 21 + .../Models/SearchcriteriaFiltersValueRange.md | 20 + .../SearchcriteriaFiltersValueRangeLower.md | 20 + .../SearchcriteriaFiltersValueRangeUpper.md | 20 + .../docs/Models/SearchcriteriaQuery.md | 19 + .../docs/Models/SearchcriteriaTextQuery.md | 21 + .../docs/Models/Sed.md | 32 + .../docs/Models/Sedapproval.md | 19 + .../docs/Models/Sedapprovalstatus.md | 21 + .../docs/Models/Sedassignee.md | 20 + .../docs/Models/Sedassignment.md | 20 + .../docs/Models/Sedassignmentresponse.md | 19 + .../docs/Models/Sedbatchrecord.md | 27 + .../docs/Models/Sedbatchrequest.md | 21 + .../docs/Models/Sedbatchresponse.md | 19 + .../docs/Models/Sedbatchstats.md | 23 + .../docs/Models/Sedpatch.md | 21 + .../typescript_code_examples_overlay.yaml | 131 + .../tagged_objects/docs/Methods/Index.md | 30 + .../docs/Methods/TaggedObjectsV1Api.md | 406 +++ .../docs/Models/Bulkaddtaggedobject.md | 21 + .../docs/Models/Bulkremovetaggedobject.md | 20 + .../docs/Models/Bulktaggedobjectresponse.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../tagged_objects/docs/Models/Index.md | 19 + .../Models/ListTaggedObjectsV1401Response.md | 19 + .../Models/ListTaggedObjectsV1429Response.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../tagged_objects/docs/Models/README.md | 46 + .../docs/Models/Taggedobject.md | 20 + .../docs/Models/Taggedobjectdto.md | 21 + .../typescript_code_examples_overlay.yaml | 64 + sdk-output/tags/docs/Methods/Index.md | 30 + sdk-output/tags/docs/Methods/TagsV1Api.md | 191 ++ .../tags/docs/Models/Errormessagedto.md | 21 + .../tags/docs/Models/Errorresponsedto.md | 22 + sdk-output/tags/docs/Models/Index.md | 19 + .../tags/docs/Models/ListTagsV1401Response.md | 19 + .../tags/docs/Models/ListTagsV1429Response.md | 19 + sdk-output/tags/docs/Models/Localeorigin.md | 21 + sdk-output/tags/docs/Models/README.md | 46 + sdk-output/tags/docs/Models/Tag2.md | 23 + .../docs/Models/Tag2TagCategoryRefsInner.md | 21 + .../typescript_code_examples_overlay.yaml | 50 + .../task_management/docs/Methods/Index.md | 30 + .../docs/Methods/TaskManagementV1Api.md | 147 + .../task_management/docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetTaskStatusV1401Response.md | 19 + .../docs/Models/GetTaskStatusV1429Response.md | 19 + .../task_management/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Localizedmessage.md | 20 + .../task_management/docs/Models/README.md | 46 + .../task_management/docs/Models/Target.md | 21 + .../docs/Models/Taskdefinitionsummary.md | 24 + .../docs/Models/Taskreturndetails.md | 20 + .../task_management/docs/Models/Taskstatus.md | 36 + .../docs/Models/Taskstatusmessage.md | 22 + .../TaskstatusmessageParametersInner.md | 18 + .../typescript_code_examples_overlay.yaml | 14 + sdk-output/tenant/docs/Methods/Index.md | 30 + sdk-output/tenant/docs/Methods/TenantV1Api.md | 54 + .../tenant/docs/Models/Errormessagedto.md | 21 + .../tenant/docs/Models/Errorresponsedto.md | 22 + .../docs/Models/GetTenantV1401Response.md | 19 + .../docs/Models/GetTenantV1429Response.md | 19 + sdk-output/tenant/docs/Models/Index.md | 19 + sdk-output/tenant/docs/Models/License.md | 20 + sdk-output/tenant/docs/Models/Localeorigin.md | 21 + sdk-output/tenant/docs/Models/Product.md | 34 + sdk-output/tenant/docs/Models/README.md | 46 + sdk-output/tenant/docs/Models/Tenant.md | 25 + .../typescript_code_examples_overlay.yaml | 29 + .../tenant_context/docs/Methods/Index.md | 30 + .../docs/Methods/TenantContextV1Api.md | 102 + .../tenant_context/docs/Models/ArrayInner.md | 18 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetTenantContextV1200ResponseInner.md | 20 + .../Models/GetTenantContextV1401Response.md | 19 + .../Models/GetTenantContextV1429Response.md | 19 + .../tenant_context/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + .../docs/Models/Localeorigin.md | 21 + .../tenant_context/docs/Models/README.md | 46 + .../typescript_code_examples_overlay.yaml | 80 + sdk-output/transforms/docs/Methods/Index.md | 30 + .../docs/Methods/TransformsV1Api.md | 229 ++ .../transforms/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + sdk-output/transforms/docs/Models/Index.md | 19 + .../Models/ListTransformsV1401Response.md | 19 + .../Models/ListTransformsV1429Response.md | 19 + .../transforms/docs/Models/Localeorigin.md | 21 + sdk-output/transforms/docs/Models/README.md | 46 + .../transforms/docs/Models/Transform.md | 21 + .../transforms/docs/Models/Transformread.md | 23 + .../typescript_code_examples_overlay.yaml | 165 ++ sdk-output/triggers/docs/Methods/Index.md | 30 + .../triggers/docs/Methods/TriggersV1Api.md | 485 ++++ .../docs/Models/Accessitemapproverdto.md | 21 + .../docs/Models/Accessitemrequestedfordto.md | 21 + .../docs/Models/Accessitemrequesterdto.md | 21 + .../Models/Accessrequestdynamicapprover.md | 22 + .../Models/Accessrequestdynamicapprover2.md | 21 + ...questdynamicapproverRequestedItemsInner.md | 24 + .../docs/Models/Accessrequestpostapproval.md | 22 + ...stpostapprovalRequestedItemsStatusInner.md | 26 + ...uestedItemsStatusInnerApprovalInfoInner.md | 22 + ...emsStatusInnerApprovalInfoInnerApprover.md | 21 + .../docs/Models/Accessrequestpreapproval.md | 22 + .../docs/Models/Accessrequestpreapproval2.md | 21 + ...ssrequestpreapprovalRequestedItemsInner.md | 24 + .../Models/Accountaggregationcompleted.md | 25 + .../AccountaggregationcompletedSource.md | 21 + .../AccountaggregationcompletedStats.md | 23 + .../docs/Models/Accountattributeschanged.md | 22 + .../Models/AccountattributeschangedAccount.md | 23 + .../AccountattributeschangedChangesInner.md | 21 + ...ntattributeschangedChangesInnerNewValue.md | 18 + ...ntattributeschangedChangesInnerOldValue.md | 18 + .../AccountattributeschangedIdentity.md | 21 + .../Models/AccountattributeschangedSource.md | 21 + .../triggers/docs/Models/Accountcorrelated.md | 23 + .../docs/Models/AccountcorrelatedAccount.md | 23 + .../docs/Models/AccountcorrelatedIdentity.md | 21 + .../docs/Models/AccountcorrelatedSource.md | 21 + .../triggers/docs/Models/Accountcreated.md | 22 + .../docs/Models/AccountcreatedEvent.md | 20 + .../triggers/docs/Models/Accountdeleted.md | 22 + .../docs/Models/AccountdeletedEvent.md | 20 + .../Models/Accountscollectedforaggregation.md | 25 + .../AccountscollectedforaggregationSource.md | 21 + .../AccountscollectedforaggregationStats.md | 23 + .../docs/Models/Accountsourcereference.md | 23 + .../AccountsourcereferenceGovernanceGroup.md | 20 + .../Models/AccountsourcereferenceOwner.md | 20 + .../docs/Models/Accountuncorrelated.md | 22 + .../docs/Models/AccountuncorrelatedAccount.md | 23 + .../Models/AccountuncorrelatedIdentity.md | 21 + .../docs/Models/AccountuncorrelatedSource.md | 21 + .../triggers/docs/Models/Accountupdated.md | 26 + .../AccountupdatedEntitlementChangesInner.md | 21 + ...pdatedEntitlementChangesInnerAddedInner.md | 22 + ...dEntitlementChangesInnerAddedInnerOwner.md | 21 + .../docs/Models/AccountupdatedEvent.md | 20 + ...tupdatedMultiValueAttributeChangesInner.md | 21 + ...ueAttributeChangesInnerAddedValuesInner.md | 18 + ...updatedSingleValueAttributeChangesInner.md | 21 + ...ingleValueAttributeChangesInnerNewValue.md | 18 + ...ingleValueAttributeChangesInnerOldValue.md | 18 + sdk-output/triggers/docs/Models/Accountv2.md | 26 + .../triggers/docs/Models/Basicauthconfig.md | 20 + .../docs/Models/Bearertokenauthconfig.md | 19 + .../triggers/docs/Models/Campaignactivated.md | 19 + .../docs/Models/CampaignactivatedCampaign.md | 27 + .../CampaignactivatedCampaignCampaignOwner.md | 21 + .../triggers/docs/Models/Campaignended.md | 19 + .../docs/Models/CampaignendedCampaign.md | 27 + .../triggers/docs/Models/Campaigngenerated.md | 19 + .../docs/Models/CampaigngeneratedCampaign.md | 27 + .../CampaigngeneratedCampaignCampaignOwner.md | 21 + .../triggers/docs/Models/Campaignreference.md | 25 + .../triggers/docs/Models/Certificationdto.md | 31 + .../docs/Models/Certificationphase.md | 23 + .../docs/Models/Certificationreference.md | 22 + .../docs/Models/Certificationsignedoff.md | 19 + .../CertificationsignedoffCertification.md | 35 + .../docs/Models/Completeinvocation.md | 21 + .../docs/Models/Completeinvocationinput.md | 20 + .../triggers/docs/Models/Errormessagedto.md | 21 + .../triggers/docs/Models/Errorresponsedto.md | 22 + .../triggers/docs/Models/Eventbridgeconfig.md | 20 + .../docs/Models/Httpauthenticationtype.md | 23 + sdk-output/triggers/docs/Models/Httpconfig.md | 23 + .../triggers/docs/Models/Httpdispatchmode.md | 23 + .../docs/Models/Identityattributeschanged.md | 20 + .../IdentityattributeschangedChangesInner.md | 21 + ...tyattributeschangedChangesInnerNewValue.md | 18 + ...tyattributeschangedChangesInnerOldValue.md | 18 + ...eschangedChangesInnerOldValueOneOfValue.md | 18 + .../IdentityattributeschangedIdentity.md | 21 + .../triggers/docs/Models/Identitycreated.md | 20 + .../docs/Models/IdentitycreatedIdentity.md | 21 + .../triggers/docs/Models/Identitydeleted.md | 20 + .../docs/Models/IdentitydeletedIdentity.md | 21 + .../docs/Models/Identityreference2.md | 22 + sdk-output/triggers/docs/Models/Index.md | 19 + sdk-output/triggers/docs/Models/Invocation.md | 22 + .../triggers/docs/Models/Invocationstatus.md | 27 + .../docs/Models/Invocationstatustype.md | 21 + .../docs/Models/ListTriggersV1401Response.md | 19 + .../docs/Models/ListTriggersV1429Response.md | 19 + .../triggers/docs/Models/Localeorigin.md | 21 + .../triggers/docs/Models/Localizedmessage.md | 20 + .../docs/Models/Machineidentitycreated.md | 20 + .../MachineidentitycreatedMachineIdentity.md | 36 + .../docs/Models/Machineidentitydeleted.md | 20 + .../MachineidentitydeletedMachineIdentity.md | 36 + .../Models/Machineidentityownerreference.md | 22 + .../Models/Machineidentitysourcereference.md | 21 + .../docs/Models/Machineidentityupdated.md | 24 + .../MachineidentityupdatedMachineIdentity.md | 36 + .../MachineidentityupdatedOwnerChanges.md | 21 + ...updatedSingleValueAttributeChangesInner.md | 21 + ...ingleValueAttributeChangesInnerNewValue.md | 18 + ...ingleValueAttributeChangesInnerOldValue.md | 18 + ...neidentityupdatedUserEntitlementChanges.md | 21 + .../Models/Machineidentityuserentitlements.md | 21 + .../docs/Models/Provisioningcompleted.md | 26 + ...ovisioningcompletedAccountRequestsInner.md | 25 + ...ountRequestsInnerAttributeRequestsInner.md | 21 + ...ningcompletedAccountRequestsInnerSource.md | 21 + .../Models/ProvisioningcompletedRecipient.md | 21 + .../Models/ProvisioningcompletedRequester.md | 21 + sdk-output/triggers/docs/Models/README.md | 46 + .../triggers/docs/Models/Reassignment.md | 20 + sdk-output/triggers/docs/Models/Reviewer.md | 24 + .../docs/Models/Savedsearchcomplete.md | 25 + .../SavedsearchcompleteSearchResults.md | 21 + ...SavedsearchcompleteSearchResultsAccount.md | 21 + ...dsearchcompleteSearchResultsEntitlement.md | 21 + ...avedsearchcompleteSearchResultsIdentity.md | 21 + .../docs/Models/Sourceaccountcreated.md | 26 + .../docs/Models/Sourceaccountdeleted.md | 26 + .../docs/Models/Sourceaccountupdated.md | 26 + .../triggers/docs/Models/Sourcecreated.md | 24 + .../docs/Models/SourcecreatedActor.md | 21 + .../triggers/docs/Models/Sourcedeleted.md | 24 + .../docs/Models/SourcedeletedActor.md | 21 + .../triggers/docs/Models/Sourceupdated.md | 24 + .../docs/Models/SourceupdatedActor.md | 21 + .../docs/Models/Startinvocationinput.md | 21 + .../triggers/docs/Models/Subscription.md | 29 + .../Models/SubscriptionpatchrequestInner.md | 21 + .../SubscriptionpatchrequestInnerValue.md | 18 + ...riptionpatchrequestInnerValueAnyOfInner.md | 18 + .../docs/Models/Subscriptionpostrequest.md | 27 + .../docs/Models/Subscriptionputrequest.md | 26 + .../triggers/docs/Models/Subscriptiontype.md | 27 + .../triggers/docs/Models/Testinvocation.md | 22 + sdk-output/triggers/docs/Models/Trigger.md | 26 + .../docs/Models/TriggerExampleInput.md | 77 + .../docs/Models/TriggerExampleOutput.md | 24 + .../triggers/docs/Models/Triggertype.md | 21 + .../docs/Models/Vaclusterstatuschangeevent.md | 23 + .../VaclusterstatuschangeeventApplication.md | 21 + ...usterstatuschangeeventHealthCheckResult.md | 21 + ...tuschangeeventPreviousHealthCheckResult.md | 21 + .../docs/Models/Validatefilterinputdto.md | 20 + .../docs/Models/Validatefilteroutputdto.md | 21 + .../typescript_code_examples_overlay.yaml | 31 + sdk-output/ui_metadata/docs/Methods/Index.md | 30 + .../docs/Methods/UIMetadataV1Api.md | 106 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../GetTenantUiMetadataV1401Response.md | 19 + .../GetTenantUiMetadataV1429Response.md | 19 + sdk-output/ui_metadata/docs/Models/Index.md | 19 + .../ui_metadata/docs/Models/Localeorigin.md | 21 + sdk-output/ui_metadata/docs/Models/README.md | 46 + .../Models/Tenantuimetadataitemresponse.md | 21 + .../Tenantuimetadataitemupdaterequest.md | 21 + .../typescript_code_examples_overlay.yaml | 206 ++ sdk-output/work_items/docs/Methods/Index.md | 30 + .../work_items/docs/Methods/WorkItemsV1Api.md | 562 ++++ .../docs/Models/Approvalitemdetails.md | 25 + .../work_items/docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../work_items/docs/Models/Formdetails.md | 24 + .../work_items/docs/Models/Formitemdetails.md | 19 + sdk-output/work_items/docs/Models/Index.md | 19 + .../docs/Models/ListWorkItemsV1401Response.md | 19 + .../docs/Models/ListWorkItemsV1429Response.md | 19 + .../work_items/docs/Models/Localeorigin.md | 21 + sdk-output/work_items/docs/Models/README.md | 46 + .../docs/Models/Remediationitemdetails.md | 27 + .../work_items/docs/Models/Sectiondetails.md | 21 + .../work_items/docs/Models/Workitemforward.md | 21 + .../work_items/docs/Models/Workitems.md | 35 + .../work_items/docs/Models/WorkitemsForm.md | 24 + .../work_items/docs/Models/Workitemscount.md | 19 + .../docs/Models/Workitemssummary.md | 21 + .../work_items/docs/Models/Workitemstate.md | 29 + .../Models/Workitemstatemanualworkitems.md | 29 + .../Models/Workitemtypemanualworkitems.md | 45 + .../typescript_code_examples_overlay.yaml | 145 + .../work_reassignment/docs/Methods/Index.md | 30 + .../docs/Methods/WorkReassignmentV1Api.md | 427 +++ .../docs/Models/Auditdetails.md | 22 + .../docs/Models/Configtype.md | 23 + .../docs/Models/Configtypeenum.md | 25 + .../docs/Models/Configtypeenumcamel.md | 23 + .../Models/Configurationdetailsresponse.md | 23 + .../docs/Models/Configurationitemrequest.md | 23 + .../docs/Models/Configurationitemresponse.md | 20 + .../docs/Models/Configurationresponse.md | 20 + .../docs/Models/Errormessagedto.md | 21 + .../docs/Models/Errorresponsedto.md | 22 + .../docs/Models/Evaluateresponse.md | 20 + ...GetReassignmentConfigTypesV1401Response.md | 19 + ...GetReassignmentConfigTypesV1429Response.md | 19 + .../docs/Models/Identity2.md | 20 + .../work_reassignment/docs/Models/Index.md | 19 + .../docs/Models/Localeorigin.md | 21 + .../docs/Models/Lookupstep.md | 21 + .../work_reassignment/docs/Models/README.md | 46 + .../docs/Models/Reassignmenttypeenum.md | 25 + .../docs/Models/Tenantconfigurationdetails.md | 19 + .../docs/Models/Tenantconfigurationrequest.md | 19 + .../Models/Tenantconfigurationresponse.md | 20 + .../typescript_code_examples_overlay.yaml | 296 ++ sdk-output/workflows/docs/Methods/Index.md | 30 + .../workflows/docs/Methods/WorkflowsV1Api.md | 800 ++++++ .../workflows/docs/Models/ArrayInner.md | 18 + ...ateExternalExecuteWorkflowV1200Response.md | 20 + .../CreateExternalExecuteWorkflowV1Request.md | 19 + .../docs/Models/CreateWorkflowV1Request.md | 24 + .../workflows/docs/Models/Errormessagedto.md | 21 + .../workflows/docs/Models/Errorresponsedto.md | 22 + sdk-output/workflows/docs/Models/Index.md | 19 + .../docs/Models/Jsonpatchoperation.md | 21 + .../docs/Models/JsonpatchoperationValue.md | 18 + ...mpleteWorkflowLibraryV1200ResponseInner.md | 31 + .../docs/Models/ListWorkflowsV1401Response.md | 19 + .../docs/Models/ListWorkflowsV1429Response.md | 19 + .../workflows/docs/Models/Localeorigin.md | 21 + sdk-output/workflows/docs/Models/README.md | 46 + ...estExternalExecuteWorkflowV1200Response.md | 19 + .../TestExternalExecuteWorkflowV1Request.md | 19 + .../docs/Models/TestWorkflowV1200Response.md | 19 + .../docs/Models/TestWorkflowV1Request.md | 19 + sdk-output/workflows/docs/Models/Workflow.md | 31 + .../docs/Models/WorkflowAllOfCreator.md | 21 + .../workflows/docs/Models/Workflowbody.md | 24 + .../docs/Models/WorkflowbodyOwner.md | 21 + .../docs/Models/Workflowdefinition.md | 20 + .../docs/Models/Workflowexecution.md | 24 + .../docs/Models/Workflowexecutionevent.md | 21 + .../docs/Models/Workflowexecutionhistory.md | 21 + .../docs/Models/Workflowlibraryaction.md | 30 + .../WorkflowlibraryactionExampleOutput.md | 18 + .../docs/Models/Workflowlibraryformfields.md | 24 + .../docs/Models/Workflowlibraryoperator.md | 27 + .../docs/Models/Workflowlibrarytrigger.md | 29 + .../docs/Models/Workflowmodifiedby.md | 21 + .../docs/Models/Workflowoauthclient.md | 21 + .../workflows/docs/Models/Workflowtrigger.md | 21 + sdk-resources/resources/api_doc.mustache | 72 + .../developerSite_code_examples.mustache | 21 + .../resources/docs_methods_index.mustache | 30 + .../resources/docs_models_index.mustache | 19 + sdk-resources/resources/model_doc.mustache | 29 + 2775 files changed, 115347 insertions(+) create mode 100644 sdk-output/access_model_metadata/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/access_model_metadata/docs/Methods/AccessModelMetadataV1Api.md create mode 100644 sdk-output/access_model_metadata/docs/Methods/Index.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Accessmodelmetadatabulkupdateresponse.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Aggregations.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Aggregationtype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/ArrayInner.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Attributedto.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Attributevaluedto.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Bound.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Bucketaggregation.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Buckettype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/BulkupdateammkeyvalueInner.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatefilterrequest.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdateidsrequest.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatequeryrequest.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Errormessagedto.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Filter.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Filteraggregation.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Filtertype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Index.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Innerhit.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/access_model_metadata/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1401Response.md create mode 100644 sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1429Response.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Localeorigin.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Metricaggregation.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Metrictype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Nestedaggregation.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Query.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Queryresultfilter.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Querytype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/README.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Range.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Search.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Searchaggregationspecification.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Searchfiltertype.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Subsearchaggregationspecification.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Textquery.md create mode 100644 sdk-output/access_model_metadata/docs/Models/Typeaheadquery.md create mode 100644 sdk-output/access_profiles/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/access_profiles/docs/Methods/AccessProfilesV1Api.md create mode 100644 sdk-output/access_profiles/docs/Methods/Index.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessduration.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessmodelmetadata.md create mode 100644 sdk-output/access_profiles/docs/Models/AccessmodelmetadataValuesInner.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofile.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofileapprovalscheme.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleterequest.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleteresponse.md create mode 100644 sdk-output/access_profiles/docs/Models/AccessprofilebulkupdaterequestInner.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofilesourceref.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofileupdateitem.md create mode 100644 sdk-output/access_profiles/docs/Models/Accessprofileusage.md create mode 100644 sdk-output/access_profiles/docs/Models/AccessprofileusageUsedByInner.md create mode 100644 sdk-output/access_profiles/docs/Models/Additionalownerref.md create mode 100644 sdk-output/access_profiles/docs/Models/ArrayInner.md create mode 100644 sdk-output/access_profiles/docs/Models/Attributedto.md create mode 100644 sdk-output/access_profiles/docs/Models/Attributedtolist.md create mode 100644 sdk-output/access_profiles/docs/Models/Attributevaluedto.md create mode 100644 sdk-output/access_profiles/docs/Models/Entitlement.md create mode 100644 sdk-output/access_profiles/docs/Models/EntitlementAccessModelMetadata.md create mode 100644 sdk-output/access_profiles/docs/Models/EntitlementOwner.md create mode 100644 sdk-output/access_profiles/docs/Models/EntitlementSource.md create mode 100644 sdk-output/access_profiles/docs/Models/Entitlementref.md create mode 100644 sdk-output/access_profiles/docs/Models/Errormessagedto.md create mode 100644 sdk-output/access_profiles/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/access_profiles/docs/Models/Index.md create mode 100644 sdk-output/access_profiles/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/access_profiles/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/access_profiles/docs/Models/ListAccessProfilesV1401Response.md create mode 100644 sdk-output/access_profiles/docs/Models/ListAccessProfilesV1429Response.md create mode 100644 sdk-output/access_profiles/docs/Models/Localeorigin.md create mode 100644 sdk-output/access_profiles/docs/Models/Ownerreference.md create mode 100644 sdk-output/access_profiles/docs/Models/Permissiondto.md create mode 100644 sdk-output/access_profiles/docs/Models/Provisioningcriterialevel1.md create mode 100644 sdk-output/access_profiles/docs/Models/Provisioningcriterialevel2.md create mode 100644 sdk-output/access_profiles/docs/Models/Provisioningcriterialevel3.md create mode 100644 sdk-output/access_profiles/docs/Models/Provisioningcriteriaoperation.md create mode 100644 sdk-output/access_profiles/docs/Models/README.md create mode 100644 sdk-output/access_profiles/docs/Models/Requestability.md create mode 100644 sdk-output/access_profiles/docs/Models/Revocability.md create mode 100644 sdk-output/access_profiles/docs/Models/UpdateAccessProfilesInBulkV1412Response.md create mode 100644 sdk-output/access_request_approvals/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/access_request_approvals/docs/Methods/AccessRequestApprovalsV1Api.md create mode 100644 sdk-output/access_request_approvals/docs/Methods/Index.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Accessitemrequestedfor.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Accessitemrequester.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Accessitemreviewedby.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Accessrequestapproverslistresponse.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Accessrequesttype.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Approvalforwardhistory.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Approvalsummary.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Commentdto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/CommentdtoAuthor.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Completedapproval.md create mode 100644 sdk-output/access_request_approvals/docs/Models/CompletedapprovalPreApprovalTriggerResult.md create mode 100644 sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequestedFor.md create mode 100644 sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequesterComment.md create mode 100644 sdk-output/access_request_approvals/docs/Models/CompletedapprovalReviewerComment.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Completedapprovalstate.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Dtotype.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Errormessagedto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Forwardapprovaldto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Index.md create mode 100644 sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1401Response.md create mode 100644 sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1429Response.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Localeorigin.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Ownerdto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Pendingapproval.md create mode 100644 sdk-output/access_request_approvals/docs/Models/PendingapprovalMaxPermittedAccessDuration.md create mode 100644 sdk-output/access_request_approvals/docs/Models/PendingapprovalOwner.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Pendingapprovalaction.md create mode 100644 sdk-output/access_request_approvals/docs/Models/README.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Reassignmenttype.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Requestableobjectreference.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Requestedaccountref.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Sodexemptcriteria.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Sodpolicydto.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Sodviolationcheckresult.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Sodviolationcontext.md create mode 100644 sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteria.md create mode 100644 sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md create mode 100644 sdk-output/access_request_approvals/docs/Models/Sodviolationcontextcheckcompleted.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsV1Api.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Methods/Index.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/Errormessagedto.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1401Response.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1429Response.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/Index.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/Localeorigin.md create mode 100644 sdk-output/access_request_identity_metrics/docs/Models/README.md create mode 100644 sdk-output/access_requests/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/access_requests/docs/Methods/AccessRequestsV1Api.md create mode 100644 sdk-output/access_requests/docs/Methods/Index.md create mode 100644 sdk-output/access_requests/docs/Models/Accessitemrequester.md create mode 100644 sdk-output/access_requests/docs/Models/Accessitemreviewedby.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestadminitemstatus.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestconfig.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestconfigv2.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestitem.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestphases.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequestresponse.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequesttracking.md create mode 100644 sdk-output/access_requests/docs/Models/Accessrequesttype.md create mode 100644 sdk-output/access_requests/docs/Models/Accountinforef.md create mode 100644 sdk-output/access_requests/docs/Models/Accountitemref.md create mode 100644 sdk-output/access_requests/docs/Models/Accountsselectionrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Accountsselectionresponse.md create mode 100644 sdk-output/access_requests/docs/Models/Approvalforwardhistory.md create mode 100644 sdk-output/access_requests/docs/Models/Approvalreminderandescalationconfig.md create mode 100644 sdk-output/access_requests/docs/Models/Approvalscheme.md create mode 100644 sdk-output/access_requests/docs/Models/Approvalstatusdto.md create mode 100644 sdk-output/access_requests/docs/Models/ApprovalstatusdtoCurrentOwner.md create mode 100644 sdk-output/access_requests/docs/Models/ApprovalstatusdtoOriginalOwner.md create mode 100644 sdk-output/access_requests/docs/Models/Bulkapproveaccessrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Bulkcancelaccessrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Cancelaccessrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Cancelledrequestdetails.md create mode 100644 sdk-output/access_requests/docs/Models/Closeaccessrequest.md create mode 100644 sdk-output/access_requests/docs/Models/Commentdto.md create mode 100644 sdk-output/access_requests/docs/Models/CommentdtoAuthor.md create mode 100644 sdk-output/access_requests/docs/Models/Dtotype.md create mode 100644 sdk-output/access_requests/docs/Models/Entitlementaccessrequestconfig.md create mode 100644 sdk-output/access_requests/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md create mode 100644 sdk-output/access_requests/docs/Models/Entitlementapprovalscheme.md create mode 100644 sdk-output/access_requests/docs/Models/Entitlementrequestconfig.md create mode 100644 sdk-output/access_requests/docs/Models/Entitlementrequestconfigv2.md create mode 100644 sdk-output/access_requests/docs/Models/Entitlementrevocationrequestconfig.md create mode 100644 sdk-output/access_requests/docs/Models/Errormessagedto.md create mode 100644 sdk-output/access_requests/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1401Response.md create mode 100644 sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1429Response.md create mode 100644 sdk-output/access_requests/docs/Models/Identityaccountselections.md create mode 100644 sdk-output/access_requests/docs/Models/Identityentitlementdetails.md create mode 100644 sdk-output/access_requests/docs/Models/Identityentitlementdetailsaccounttarget.md create mode 100644 sdk-output/access_requests/docs/Models/Identityentitlementdetailsentitlementdto.md create mode 100644 sdk-output/access_requests/docs/Models/Identityreferencewithnameandemail.md create mode 100644 sdk-output/access_requests/docs/Models/Index.md create mode 100644 sdk-output/access_requests/docs/Models/Localeorigin.md create mode 100644 sdk-output/access_requests/docs/Models/Manualworkitemdetails.md create mode 100644 sdk-output/access_requests/docs/Models/ManualworkitemdetailsCurrentOwner.md create mode 100644 sdk-output/access_requests/docs/Models/ManualworkitemdetailsOriginalOwner.md create mode 100644 sdk-output/access_requests/docs/Models/Manualworkitemstate.md create mode 100644 sdk-output/access_requests/docs/Models/Ownerdto.md create mode 100644 sdk-output/access_requests/docs/Models/Preapprovaltriggerdetails.md create mode 100644 sdk-output/access_requests/docs/Models/Provisioningdetails.md create mode 100644 sdk-output/access_requests/docs/Models/README.md create mode 100644 sdk-output/access_requests/docs/Models/Reassignmenttype.md create mode 100644 sdk-output/access_requests/docs/Models/Requestedaccountref.md create mode 100644 sdk-output/access_requests/docs/Models/Requestedfordtoref.md create mode 100644 sdk-output/access_requests/docs/Models/Requesteditemaccountselections.md create mode 100644 sdk-output/access_requests/docs/Models/Requesteditemdetails.md create mode 100644 sdk-output/access_requests/docs/Models/Requesteditemdtoref.md create mode 100644 sdk-output/access_requests/docs/Models/Requesteditemstatus.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusCancelledRequestDetails.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusPreApprovalTriggerDetails.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusProvisioningDetails.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusRequestedFor.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusRequesterComment.md create mode 100644 sdk-output/access_requests/docs/Models/RequesteditemstatusSodViolationContext.md create mode 100644 sdk-output/access_requests/docs/Models/Requesteditemstatusrequeststate.md create mode 100644 sdk-output/access_requests/docs/Models/Requestonbehalfofconfig.md create mode 100644 sdk-output/access_requests/docs/Models/Requestonbehalfofconfigv2.md create mode 100644 sdk-output/access_requests/docs/Models/Sodexemptcriteria.md create mode 100644 sdk-output/access_requests/docs/Models/Sodpolicydto.md create mode 100644 sdk-output/access_requests/docs/Models/Sodviolationcheckresult.md create mode 100644 sdk-output/access_requests/docs/Models/Sodviolationcontext.md create mode 100644 sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteria.md create mode 100644 sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md create mode 100644 sdk-output/access_requests/docs/Models/Sodviolationcontextcheckcompleted.md create mode 100644 sdk-output/access_requests/docs/Models/Sourceaccountselections.md create mode 100644 sdk-output/access_requests/docs/Models/Sourceitemref.md create mode 100644 sdk-output/account_activities/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/account_activities/docs/Methods/AccountActivitiesV1Api.md create mode 100644 sdk-output/account_activities/docs/Methods/Index.md create mode 100644 sdk-output/account_activities/docs/Models/Accountactivity.md create mode 100644 sdk-output/account_activities/docs/Models/Accountactivityapprovalstatus.md create mode 100644 sdk-output/account_activities/docs/Models/Accountactivityitem.md create mode 100644 sdk-output/account_activities/docs/Models/Accountactivityitemoperation.md create mode 100644 sdk-output/account_activities/docs/Models/Accountrequestinfo.md create mode 100644 sdk-output/account_activities/docs/Models/Comment.md create mode 100644 sdk-output/account_activities/docs/Models/Completionstatus.md create mode 100644 sdk-output/account_activities/docs/Models/Errormessagedto.md create mode 100644 sdk-output/account_activities/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/account_activities/docs/Models/Executionstatus.md create mode 100644 sdk-output/account_activities/docs/Models/Identitysummary.md create mode 100644 sdk-output/account_activities/docs/Models/Index.md create mode 100644 sdk-output/account_activities/docs/Models/ListAccountActivitiesV1401Response.md create mode 100644 sdk-output/account_activities/docs/Models/ListAccountActivitiesV1429Response.md create mode 100644 sdk-output/account_activities/docs/Models/Localeorigin.md create mode 100644 sdk-output/account_activities/docs/Models/Provisioningstate.md create mode 100644 sdk-output/account_activities/docs/Models/README.md create mode 100644 sdk-output/account_activities/docs/Models/Requestableobjecttype.md create mode 100644 sdk-output/account_aggregations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/account_aggregations/docs/Methods/AccountAggregationsV1Api.md create mode 100644 sdk-output/account_aggregations/docs/Methods/Index.md create mode 100644 sdk-output/account_aggregations/docs/Models/Accountaggregationstatus.md create mode 100644 sdk-output/account_aggregations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/account_aggregations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1400Response.md create mode 100644 sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1429Response.md create mode 100644 sdk-output/account_aggregations/docs/Models/Index.md create mode 100644 sdk-output/account_aggregations/docs/Models/Localeorigin.md create mode 100644 sdk-output/account_aggregations/docs/Models/README.md create mode 100644 sdk-output/account_deletion_requests/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/account_deletion_requests/docs/Methods/AccountDeletionRequestsV1Api.md create mode 100644 sdk-output/account_deletion_requests/docs/Methods/Index.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountactionrequestdto.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoAccountDetails.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoCorrelatedIdentity.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoRequester.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountdeleterequestinput.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountdetails.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountrequestasyncresult.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountrequestphase.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Accountrequestphasestate.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Approvaldetails.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Approverdto.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Approverreference.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Basereferencedto.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Dtotype.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Errormessagedto.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1401Response.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1429Response.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Identityreference.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Index.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/Localeorigin.md create mode 100644 sdk-output/account_deletion_requests/docs/Models/README.md create mode 100644 sdk-output/account_usages/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/account_usages/docs/Methods/AccountUsagesV1Api.md create mode 100644 sdk-output/account_usages/docs/Methods/Index.md create mode 100644 sdk-output/account_usages/docs/Models/Accountusage.md create mode 100644 sdk-output/account_usages/docs/Models/Errormessagedto.md create mode 100644 sdk-output/account_usages/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1401Response.md create mode 100644 sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1429Response.md create mode 100644 sdk-output/account_usages/docs/Models/Index.md create mode 100644 sdk-output/account_usages/docs/Models/Localeorigin.md create mode 100644 sdk-output/account_usages/docs/Models/README.md create mode 100644 sdk-output/accounts/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/accounts/docs/Methods/AccountsV1Api.md create mode 100644 sdk-output/accounts/docs/Methods/Index.md create mode 100644 sdk-output/accounts/docs/Models/Accessmodelmetadata.md create mode 100644 sdk-output/accounts/docs/Models/AccessmodelmetadataValuesInner.md create mode 100644 sdk-output/accounts/docs/Models/Account.md create mode 100644 sdk-output/accounts/docs/Models/AccountAllOfIdentity.md create mode 100644 sdk-output/accounts/docs/Models/AccountAllOfOwnerIdentity.md create mode 100644 sdk-output/accounts/docs/Models/AccountAllOfRecommendation.md create mode 100644 sdk-output/accounts/docs/Models/AccountAllOfSourceOwner.md create mode 100644 sdk-output/accounts/docs/Models/Accountattributes.md create mode 100644 sdk-output/accounts/docs/Models/Accountattributescreate.md create mode 100644 sdk-output/accounts/docs/Models/AccountattributescreateAttributes.md create mode 100644 sdk-output/accounts/docs/Models/Accountsasyncresult.md create mode 100644 sdk-output/accounts/docs/Models/Accounttogglerequest.md create mode 100644 sdk-output/accounts/docs/Models/Accountunlockrequest.md create mode 100644 sdk-output/accounts/docs/Models/Additionalownerref.md create mode 100644 sdk-output/accounts/docs/Models/Basecommondto.md create mode 100644 sdk-output/accounts/docs/Models/Basereferencedto.md create mode 100644 sdk-output/accounts/docs/Models/Bulkidentitiesaccountsresponse.md create mode 100644 sdk-output/accounts/docs/Models/Dtotype.md create mode 100644 sdk-output/accounts/docs/Models/Entitlement.md create mode 100644 sdk-output/accounts/docs/Models/EntitlementAccessModelMetadata.md create mode 100644 sdk-output/accounts/docs/Models/EntitlementOwner.md create mode 100644 sdk-output/accounts/docs/Models/EntitlementSource.md create mode 100644 sdk-output/accounts/docs/Models/Errormessagedto.md create mode 100644 sdk-output/accounts/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/accounts/docs/Models/Identitiesaccountsbulkrequest.md create mode 100644 sdk-output/accounts/docs/Models/Index.md create mode 100644 sdk-output/accounts/docs/Models/ListAccountsV1401Response.md create mode 100644 sdk-output/accounts/docs/Models/ListAccountsV1429Response.md create mode 100644 sdk-output/accounts/docs/Models/Localeorigin.md create mode 100644 sdk-output/accounts/docs/Models/Permissiondto.md create mode 100644 sdk-output/accounts/docs/Models/README.md create mode 100644 sdk-output/accounts/docs/Models/Recommendation.md create mode 100644 sdk-output/accounts/docs/Models/Taskresultdto.md create mode 100644 sdk-output/api_usage/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/api_usage/docs/Methods/ApiUsageV1Api.md create mode 100644 sdk-output/api_usage/docs/Methods/Index.md create mode 100644 sdk-output/api_usage/docs/Models/Errormessagedto.md create mode 100644 sdk-output/api_usage/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/api_usage/docs/Models/GetTotalCountV1401Response.md create mode 100644 sdk-output/api_usage/docs/Models/GetTotalCountV1429Response.md create mode 100644 sdk-output/api_usage/docs/Models/Index.md create mode 100644 sdk-output/api_usage/docs/Models/Localeorigin.md create mode 100644 sdk-output/api_usage/docs/Models/README.md create mode 100644 sdk-output/api_usage/docs/Models/Summaryresponse.md create mode 100644 sdk-output/application_discovery/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/application_discovery/docs/Methods/ApplicationDiscoveryV1Api.md create mode 100644 sdk-output/application_discovery/docs/Methods/Index.md create mode 100644 sdk-output/application_discovery/docs/Models/Applicationdiscoveryrequest.md create mode 100644 sdk-output/application_discovery/docs/Models/Applicationdiscoveryresponse.md create mode 100644 sdk-output/application_discovery/docs/Models/ApplicationdiscoveryresponseTarget.md create mode 100644 sdk-output/application_discovery/docs/Models/Basereferencedto.md create mode 100644 sdk-output/application_discovery/docs/Models/Dtotype.md create mode 100644 sdk-output/application_discovery/docs/Models/Errormessagedto.md create mode 100644 sdk-output/application_discovery/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/application_discovery/docs/Models/Fulldiscoveredapplications.md create mode 100644 sdk-output/application_discovery/docs/Models/GetDiscoveredApplicationsV1200ResponseInner.md create mode 100644 sdk-output/application_discovery/docs/Models/Index.md create mode 100644 sdk-output/application_discovery/docs/Models/Localeorigin.md create mode 100644 sdk-output/application_discovery/docs/Models/Localizedmessage.md create mode 100644 sdk-output/application_discovery/docs/Models/Manualdiscoverapplications.md create mode 100644 sdk-output/application_discovery/docs/Models/Manualdiscoverapplicationstemplate.md create mode 100644 sdk-output/application_discovery/docs/Models/README.md create mode 100644 sdk-output/application_discovery/docs/Models/Slimdiscoveredapplications.md create mode 100644 sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1401Response.md create mode 100644 sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403Response.md create mode 100644 sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403ResponseOneOf.md create mode 100644 sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1429Response.md create mode 100644 sdk-output/application_discovery/docs/Models/Taskdefinitionsummary.md create mode 100644 sdk-output/application_discovery/docs/Models/Taskreturndetails.md create mode 100644 sdk-output/application_discovery/docs/Models/Taskstatusmessage.md create mode 100644 sdk-output/application_discovery/docs/Models/TaskstatusmessageParametersInner.md create mode 100644 sdk-output/approvals/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/approvals/docs/Methods/ApprovalsV1Api.md create mode 100644 sdk-output/approvals/docs/Methods/Index.md create mode 100644 sdk-output/approvals/docs/Models/Approval2.md create mode 100644 sdk-output/approvals/docs/Models/Approval2ApprovalCriteria.md create mode 100644 sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaApproval.md create mode 100644 sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaRejection.md create mode 100644 sdk-output/approvals/docs/Models/Approvalapproverequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalattributesrequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalbatch.md create mode 100644 sdk-output/approvals/docs/Models/Approvalcancelrequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalcomment3.md create mode 100644 sdk-output/approvals/docs/Models/Approvalcommentsrequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalconfig.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigCronTimezone.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfig.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigFallbackApprover.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigReminderConfig.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigSerialChainInner.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalconfigTimeoutConfig.md create mode 100644 sdk-output/approvals/docs/Models/Approvaldescription.md create mode 100644 sdk-output/approvals/docs/Models/Approvalidentity.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalidentityMembersInner.md create mode 100644 sdk-output/approvals/docs/Models/ApprovalidentityOwnerOfInner.md create mode 100644 sdk-output/approvals/docs/Models/Approvalidentityrecord.md create mode 100644 sdk-output/approvals/docs/Models/Approvalname.md create mode 100644 sdk-output/approvals/docs/Models/Approvalreassignmenthistory.md create mode 100644 sdk-output/approvals/docs/Models/Approvalreassignrequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalreference.md create mode 100644 sdk-output/approvals/docs/Models/Approvalrejectrequest.md create mode 100644 sdk-output/approvals/docs/Models/Approvalrequestedtarget.md create mode 100644 sdk-output/approvals/docs/Models/Bulkapproverequestdto.md create mode 100644 sdk-output/approvals/docs/Models/Bulkcancelrequestdto.md create mode 100644 sdk-output/approvals/docs/Models/Bulkreassignrequestdto.md create mode 100644 sdk-output/approvals/docs/Models/Bulkrejectrequestdto.md create mode 100644 sdk-output/approvals/docs/Models/Errormessagedto.md create mode 100644 sdk-output/approvals/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/approvals/docs/Models/GetApprovalsV1401Response.md create mode 100644 sdk-output/approvals/docs/Models/GetApprovalsV1429Response.md create mode 100644 sdk-output/approvals/docs/Models/Index.md create mode 100644 sdk-output/approvals/docs/Models/Localeorigin.md create mode 100644 sdk-output/approvals/docs/Models/README.md create mode 100644 sdk-output/apps/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/apps/docs/Methods/AppsV1Api.md create mode 100644 sdk-output/apps/docs/Methods/Index.md create mode 100644 sdk-output/apps/docs/Models/Accessprofiledetails.md create mode 100644 sdk-output/apps/docs/Models/AccessprofiledetailsAccountSelector.md create mode 100644 sdk-output/apps/docs/Models/Appaccessprofileselector.md create mode 100644 sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfig.md create mode 100644 sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfigMatchExpression.md create mode 100644 sdk-output/apps/docs/Models/Appaccountdetails.md create mode 100644 sdk-output/apps/docs/Models/AppaccountdetailsSourceAccount.md create mode 100644 sdk-output/apps/docs/Models/ArrayInner.md create mode 100644 sdk-output/apps/docs/Models/Basereferencedto.md create mode 100644 sdk-output/apps/docs/Models/Dtotype.md create mode 100644 sdk-output/apps/docs/Models/Errormessagedto.md create mode 100644 sdk-output/apps/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/apps/docs/Models/GetSourceAppV1401Response.md create mode 100644 sdk-output/apps/docs/Models/GetSourceAppV1429Response.md create mode 100644 sdk-output/apps/docs/Models/Index.md create mode 100644 sdk-output/apps/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/apps/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/apps/docs/Models/Localeorigin.md create mode 100644 sdk-output/apps/docs/Models/Matchterm.md create mode 100644 sdk-output/apps/docs/Models/README.md create mode 100644 sdk-output/apps/docs/Models/Sourceapp.md create mode 100644 sdk-output/apps/docs/Models/SourceappAccountSource.md create mode 100644 sdk-output/apps/docs/Models/Sourceappbulkupdaterequest.md create mode 100644 sdk-output/apps/docs/Models/Sourceappcreatedto.md create mode 100644 sdk-output/apps/docs/Models/SourceappcreatedtoAccountSource.md create mode 100644 sdk-output/apps/docs/Models/Sourceapppatchdto.md create mode 100644 sdk-output/apps/docs/Models/Userapp.md create mode 100644 sdk-output/apps/docs/Models/UserappAccount.md create mode 100644 sdk-output/apps/docs/Models/UserappOwner.md create mode 100644 sdk-output/apps/docs/Models/UserappSource.md create mode 100644 sdk-output/apps/docs/Models/UserappSourceApp.md create mode 100644 sdk-output/auth_profile/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/auth_profile/docs/Methods/AuthProfileV1Api.md create mode 100644 sdk-output/auth_profile/docs/Methods/Index.md create mode 100644 sdk-output/auth_profile/docs/Models/ArrayInner.md create mode 100644 sdk-output/auth_profile/docs/Models/Authprofile.md create mode 100644 sdk-output/auth_profile/docs/Models/Authprofilesummary.md create mode 100644 sdk-output/auth_profile/docs/Models/Errormessagedto.md create mode 100644 sdk-output/auth_profile/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/auth_profile/docs/Models/GetProfileConfigListV1401Response.md create mode 100644 sdk-output/auth_profile/docs/Models/GetProfileConfigListV1429Response.md create mode 100644 sdk-output/auth_profile/docs/Models/Index.md create mode 100644 sdk-output/auth_profile/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/auth_profile/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/auth_profile/docs/Models/Localeorigin.md create mode 100644 sdk-output/auth_profile/docs/Models/README.md create mode 100644 sdk-output/auth_users/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/auth_users/docs/Methods/AuthUsersV1Api.md create mode 100644 sdk-output/auth_users/docs/Methods/Index.md create mode 100644 sdk-output/auth_users/docs/Models/ArrayInner.md create mode 100644 sdk-output/auth_users/docs/Models/Authuser.md create mode 100644 sdk-output/auth_users/docs/Models/Errormessagedto.md create mode 100644 sdk-output/auth_users/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/auth_users/docs/Models/GetAuthUserV1401Response.md create mode 100644 sdk-output/auth_users/docs/Models/GetAuthUserV1429Response.md create mode 100644 sdk-output/auth_users/docs/Models/Index.md create mode 100644 sdk-output/auth_users/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/auth_users/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/auth_users/docs/Models/Localeorigin.md create mode 100644 sdk-output/auth_users/docs/Models/README.md create mode 100644 sdk-output/branding/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/branding/docs/Methods/BrandingV1Api.md create mode 100644 sdk-output/branding/docs/Methods/Index.md create mode 100644 sdk-output/branding/docs/Models/Brandingitem.md create mode 100644 sdk-output/branding/docs/Models/Brandingitemcreate.md create mode 100644 sdk-output/branding/docs/Models/Errormessagedto.md create mode 100644 sdk-output/branding/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/branding/docs/Models/GetBrandingListV1401Response.md create mode 100644 sdk-output/branding/docs/Models/GetBrandingListV1429Response.md create mode 100644 sdk-output/branding/docs/Models/Index.md create mode 100644 sdk-output/branding/docs/Models/Localeorigin.md create mode 100644 sdk-output/branding/docs/Models/README.md create mode 100644 sdk-output/certification_campaign_filters/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersV1Api.md create mode 100644 sdk-output/certification_campaign_filters/docs/Methods/Index.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Campaignfilterdetails.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/CampaignfilterdetailsCriteriaListInner.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Criteriatype.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Errormessagedto.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Index.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1200Response.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1401Response.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1429Response.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Localeorigin.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/Operation.md create mode 100644 sdk-output/certification_campaign_filters/docs/Models/README.md create mode 100644 sdk-output/certification_campaigns/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/certification_campaigns/docs/Methods/CertificationCampaignsV1Api.md create mode 100644 sdk-output/certification_campaigns/docs/Methods/Index.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Accessconstraint.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Activatecampaignoptions.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Adminreviewreassign.md create mode 100644 sdk-output/certification_campaigns/docs/Models/AdminreviewreassignReassignTo.md create mode 100644 sdk-output/certification_campaigns/docs/Models/ArrayInner.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfFilter.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfMachineAccountCampaignInfo.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfo.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoRemediatorRef.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoReviewer.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfo.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfoReviewer.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourceOwnerCampaignInfo.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourcesWithOrphanEntitlements.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaignalert.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaigncompleteoptions.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaignreference.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaignreport.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaignreportsconfig.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaignsdeleterequest.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Campaigntemplate.md create mode 100644 sdk-output/certification_campaigns/docs/Models/CampaigntemplateOwnerRef.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Certificationtask.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Errormessagedto.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1200ResponseInner.md create mode 100644 sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1401Response.md create mode 100644 sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1429Response.md create mode 100644 sdk-output/certification_campaigns/docs/Models/GetCampaignV1200Response.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Index.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/certification_campaigns/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Localeorigin.md create mode 100644 sdk-output/certification_campaigns/docs/Models/README.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Reassignmenttraildto.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Reportresultreference.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Reporttype.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Schedule2.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Schedule2Days.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Schedule2Hours.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Schedule2Months.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Slimcampaign.md create mode 100644 sdk-output/certification_campaigns/docs/Models/Sodreportresultdto.md create mode 100644 sdk-output/certification_summaries/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/certification_summaries/docs/Methods/CertificationSummariesV1Api.md create mode 100644 sdk-output/certification_summaries/docs/Methods/Index.md create mode 100644 sdk-output/certification_summaries/docs/Models/Accesssummary.md create mode 100644 sdk-output/certification_summaries/docs/Models/AccesssummaryAccess.md create mode 100644 sdk-output/certification_summaries/docs/Models/Activityinsights.md create mode 100644 sdk-output/certification_summaries/docs/Models/Certificationidentitysummary.md create mode 100644 sdk-output/certification_summaries/docs/Models/Dataaccess.md create mode 100644 sdk-output/certification_summaries/docs/Models/DataaccessCategoriesInner.md create mode 100644 sdk-output/certification_summaries/docs/Models/DataaccessImpactScore.md create mode 100644 sdk-output/certification_summaries/docs/Models/DataaccessPoliciesInner.md create mode 100644 sdk-output/certification_summaries/docs/Models/Dtotype.md create mode 100644 sdk-output/certification_summaries/docs/Models/Errormessagedto.md create mode 100644 sdk-output/certification_summaries/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1401Response.md create mode 100644 sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1429Response.md create mode 100644 sdk-output/certification_summaries/docs/Models/Identitycertdecisionsummary.md create mode 100644 sdk-output/certification_summaries/docs/Models/Identityreferencewithnameandemail.md create mode 100644 sdk-output/certification_summaries/docs/Models/Index.md create mode 100644 sdk-output/certification_summaries/docs/Models/Localeorigin.md create mode 100644 sdk-output/certification_summaries/docs/Models/README.md create mode 100644 sdk-output/certification_summaries/docs/Models/Reviewableaccessprofile.md create mode 100644 sdk-output/certification_summaries/docs/Models/Reviewableentitlement.md create mode 100644 sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccount.md create mode 100644 sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccountOwner.md create mode 100644 sdk-output/certification_summaries/docs/Models/Reviewablerole.md create mode 100644 sdk-output/certifications/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/certifications/docs/Methods/CertificationsV1Api.md create mode 100644 sdk-output/certifications/docs/Methods/Index.md create mode 100644 sdk-output/certifications/docs/Models/Accessreviewitem.md create mode 100644 sdk-output/certifications/docs/Models/Accesssummary.md create mode 100644 sdk-output/certifications/docs/Models/AccesssummaryAccess.md create mode 100644 sdk-output/certifications/docs/Models/Activityinsights.md create mode 100644 sdk-output/certifications/docs/Models/Campaignreference.md create mode 100644 sdk-output/certifications/docs/Models/Certificationdecision.md create mode 100644 sdk-output/certifications/docs/Models/Certificationidentitysummary.md create mode 100644 sdk-output/certifications/docs/Models/Certificationphase.md create mode 100644 sdk-output/certifications/docs/Models/Certificationreference.md create mode 100644 sdk-output/certifications/docs/Models/Certificationtask.md create mode 100644 sdk-output/certifications/docs/Models/Dataaccess.md create mode 100644 sdk-output/certifications/docs/Models/DataaccessCategoriesInner.md create mode 100644 sdk-output/certifications/docs/Models/DataaccessImpactScore.md create mode 100644 sdk-output/certifications/docs/Models/DataaccessPoliciesInner.md create mode 100644 sdk-output/certifications/docs/Models/Dtotype.md create mode 100644 sdk-output/certifications/docs/Models/Errormessagedto.md create mode 100644 sdk-output/certifications/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/certifications/docs/Models/Identitycertificationdto.md create mode 100644 sdk-output/certifications/docs/Models/Identityreferencewithnameandemail.md create mode 100644 sdk-output/certifications/docs/Models/Index.md create mode 100644 sdk-output/certifications/docs/Models/ListIdentityCertificationsV1401Response.md create mode 100644 sdk-output/certifications/docs/Models/ListIdentityCertificationsV1429Response.md create mode 100644 sdk-output/certifications/docs/Models/Localeorigin.md create mode 100644 sdk-output/certifications/docs/Models/Permissiondto.md create mode 100644 sdk-output/certifications/docs/Models/README.md create mode 100644 sdk-output/certifications/docs/Models/Reassignment.md create mode 100644 sdk-output/certifications/docs/Models/Reassignmenttraildto.md create mode 100644 sdk-output/certifications/docs/Models/Reassignreference.md create mode 100644 sdk-output/certifications/docs/Models/Reviewableaccessprofile.md create mode 100644 sdk-output/certifications/docs/Models/Reviewableentitlement.md create mode 100644 sdk-output/certifications/docs/Models/ReviewableentitlementAccount.md create mode 100644 sdk-output/certifications/docs/Models/ReviewableentitlementAccountOwner.md create mode 100644 sdk-output/certifications/docs/Models/Reviewablerole.md create mode 100644 sdk-output/certifications/docs/Models/Reviewdecision.md create mode 100644 sdk-output/certifications/docs/Models/Reviewer.md create mode 100644 sdk-output/certifications/docs/Models/Reviewreassign.md create mode 100644 sdk-output/certifications/docs/Models/Reviewrecommendation.md create mode 100644 sdk-output/classify_source/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/classify_source/docs/Methods/ClassifySourceV1Api.md create mode 100644 sdk-output/classify_source/docs/Methods/Index.md create mode 100644 sdk-output/classify_source/docs/Models/Errormessagedto.md create mode 100644 sdk-output/classify_source/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1401Response.md create mode 100644 sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1429Response.md create mode 100644 sdk-output/classify_source/docs/Models/Index.md create mode 100644 sdk-output/classify_source/docs/Models/Localeorigin.md create mode 100644 sdk-output/classify_source/docs/Models/README.md create mode 100644 sdk-output/classify_source/docs/Models/SendClassifyMachineAccountFromSourceV1200Response.md create mode 100644 sdk-output/classify_source/docs/Models/Sourceclassificationstatus.md create mode 100644 sdk-output/classify_source/docs/Models/SourceclassificationstatusAllOfCounts.md create mode 100644 sdk-output/configuration_hub/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/configuration_hub/docs/Methods/ConfigurationHubV1Api.md create mode 100644 sdk-output/configuration_hub/docs/Methods/Index.md create mode 100644 sdk-output/configuration_hub/docs/Models/Approvalcomment.md create mode 100644 sdk-output/configuration_hub/docs/Models/ArrayInner.md create mode 100644 sdk-output/configuration_hub/docs/Models/Backupoptions.md create mode 100644 sdk-output/configuration_hub/docs/Models/Backupresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/CreateUploadedConfigurationV1Request.md create mode 100644 sdk-output/configuration_hub/docs/Models/Deployrequest.md create mode 100644 sdk-output/configuration_hub/docs/Models/Deployresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/Draftresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/Errormessagedto.md create mode 100644 sdk-output/configuration_hub/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1401Response.md create mode 100644 sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1429Response.md create mode 100644 sdk-output/configuration_hub/docs/Models/Index.md create mode 100644 sdk-output/configuration_hub/docs/Models/Jsonpatch.md create mode 100644 sdk-output/configuration_hub/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/configuration_hub/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/configuration_hub/docs/Models/ListDeploysV1200Response.md create mode 100644 sdk-output/configuration_hub/docs/Models/Localeorigin.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectexportimportnames.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreaterequest.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreateresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchrequest.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingrequest.md create mode 100644 sdk-output/configuration_hub/docs/Models/Objectmappingresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/README.md create mode 100644 sdk-output/configuration_hub/docs/Models/Scheduledactionpayload.md create mode 100644 sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContent.md create mode 100644 sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContentBackupOptions.md create mode 100644 sdk-output/configuration_hub/docs/Models/Scheduledactionresponse.md create mode 100644 sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContent.md create mode 100644 sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptions.md create mode 100644 sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptionsObjectOptionsValue.md create mode 100644 sdk-output/connector_customizers/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/connector_customizers/docs/Methods/ConnectorCustomizersV1Api.md create mode 100644 sdk-output/connector_customizers/docs/Methods/Index.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizercreaterequest.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizercreateresponse.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizersresponse.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdaterequest.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdateresponse.md create mode 100644 sdk-output/connector_customizers/docs/Models/Connectorcustomizerversioncreateresponse.md create mode 100644 sdk-output/connector_customizers/docs/Models/Errormessagedto.md create mode 100644 sdk-output/connector_customizers/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/connector_customizers/docs/Models/Index.md create mode 100644 sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1401Response.md create mode 100644 sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1429Response.md create mode 100644 sdk-output/connector_customizers/docs/Models/Localeorigin.md create mode 100644 sdk-output/connector_customizers/docs/Models/README.md create mode 100644 sdk-output/connector_rule_management/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/connector_rule_management/docs/Methods/ConnectorRuleManagementV1Api.md create mode 100644 sdk-output/connector_rule_management/docs/Methods/Index.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Argument.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Connectorrulecreaterequest.md create mode 100644 sdk-output/connector_rule_management/docs/Models/ConnectorrulecreaterequestSignature.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Connectorruleresponse.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Connectorruleupdaterequest.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Connectorrulevalidationresponse.md create mode 100644 sdk-output/connector_rule_management/docs/Models/ConnectorrulevalidationresponseDetailsInner.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Errormessagedto.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1401Response.md create mode 100644 sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1429Response.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Index.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Localeorigin.md create mode 100644 sdk-output/connector_rule_management/docs/Models/README.md create mode 100644 sdk-output/connector_rule_management/docs/Models/Sourcecode.md create mode 100644 sdk-output/connectors/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/connectors/docs/Methods/ConnectorsV1Api.md create mode 100644 sdk-output/connectors/docs/Methods/Index.md create mode 100644 sdk-output/connectors/docs/Models/ArrayInner.md create mode 100644 sdk-output/connectors/docs/Models/Connectordetail.md create mode 100644 sdk-output/connectors/docs/Models/Errormessagedto.md create mode 100644 sdk-output/connectors/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/connectors/docs/Models/GetConnectorV1401Response.md create mode 100644 sdk-output/connectors/docs/Models/GetConnectorV1429Response.md create mode 100644 sdk-output/connectors/docs/Models/Index.md create mode 100644 sdk-output/connectors/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/connectors/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/connectors/docs/Models/Localeorigin.md create mode 100644 sdk-output/connectors/docs/Models/PutConnectorCorrelationConfigV1Request.md create mode 100644 sdk-output/connectors/docs/Models/PutConnectorSourceConfigV1Request.md create mode 100644 sdk-output/connectors/docs/Models/PutConnectorSourceTemplateV1Request.md create mode 100644 sdk-output/connectors/docs/Models/README.md create mode 100644 sdk-output/connectors/docs/Models/Updatedetail.md create mode 100644 sdk-output/connectors/docs/Models/V3connectordto.md create mode 100644 sdk-output/connectors/docs/Models/V3createconnectordto.md create mode 100644 sdk-output/custom_forms/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/custom_forms/docs/Methods/CustomFormsV1Api.md create mode 100644 sdk-output/custom_forms/docs/Methods/Index.md create mode 100644 sdk-output/custom_forms/docs/Models/Conditioneffect.md create mode 100644 sdk-output/custom_forms/docs/Models/ConditioneffectConfig.md create mode 100644 sdk-output/custom_forms/docs/Models/Conditionrule.md create mode 100644 sdk-output/custom_forms/docs/Models/CreateFormDefinitionFileRequestV1Request.md create mode 100644 sdk-output/custom_forms/docs/Models/Createformdefinitionrequest.md create mode 100644 sdk-output/custom_forms/docs/Models/Createforminstancerequest.md create mode 100644 sdk-output/custom_forms/docs/Models/Error.md create mode 100644 sdk-output/custom_forms/docs/Models/Errormessage.md create mode 100644 sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInner.md create mode 100644 sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInnerSelf.md create mode 100644 sdk-output/custom_forms/docs/Models/Formcondition.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemarequest.md create mode 100644 sdk-output/custom_forms/docs/Models/FormdefinitiondynamicschemarequestAttributes.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemaresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitionfileuploadresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitioninput.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitionresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Formdefinitionselfimportexportdto.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelement.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelementdatasourceconfigoptions.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelementdynamicdatasource.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelementdynamicdatasourceconfig.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelementpreviewrequest.md create mode 100644 sdk-output/custom_forms/docs/Models/Formelementvalidationsset.md create mode 100644 sdk-output/custom_forms/docs/Models/Formerror.md create mode 100644 sdk-output/custom_forms/docs/Models/Forminstancecreatedby.md create mode 100644 sdk-output/custom_forms/docs/Models/Forminstancerecipient.md create mode 100644 sdk-output/custom_forms/docs/Models/Forminstanceresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Formowner.md create mode 100644 sdk-output/custom_forms/docs/Models/Formusedby.md create mode 100644 sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202Response.md create mode 100644 sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202ResponseErrorsInner.md create mode 100644 sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1RequestInner.md create mode 100644 sdk-output/custom_forms/docs/Models/Index.md create mode 100644 sdk-output/custom_forms/docs/Models/Listformdefinitionsbytenantresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Listformelementdatabyelementidresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Listforminstancesbytenantresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Listpredefinedselectoptionsresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/Previewdatasourceresponse.md create mode 100644 sdk-output/custom_forms/docs/Models/README.md create mode 100644 sdk-output/custom_forms/docs/Models/SearchFormDefinitionsByTenantV1400Response.md create mode 100644 sdk-output/custom_password_instructions/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/custom_password_instructions/docs/Methods/CustomPasswordInstructionsV1Api.md create mode 100644 sdk-output/custom_password_instructions/docs/Methods/Index.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/Custompasswordinstruction.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/Errormessagedto.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/Index.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/Localeorigin.md create mode 100644 sdk-output/custom_password_instructions/docs/Models/README.md create mode 100644 sdk-output/custom_user_levels/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/custom_user_levels/docs/Methods/CustomUserLevelsV1Api.md create mode 100644 sdk-output/custom_user_levels/docs/Methods/Index.md create mode 100644 sdk-output/custom_user_levels/docs/Models/ArrayInner.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Authuserlevelsidentitycount.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Authuserslimresponse.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Dtotype.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Errormessagedto.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Hierarchicalrightset.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Identityreference.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Index.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Jsonpatch.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/custom_user_levels/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1401Response.md create mode 100644 sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1429Response.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Localeorigin.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Nestedconfig.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Publicidentity.md create mode 100644 sdk-output/custom_user_levels/docs/Models/PublicidentityAttributesInner.md create mode 100644 sdk-output/custom_user_levels/docs/Models/README.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Rightsetdto.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Userlevelpublishsummary.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Userlevelrequest.md create mode 100644 sdk-output/custom_user_levels/docs/Models/Userlevelsummarydto.md create mode 100644 sdk-output/data_access_security/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/data_access_security/docs/Methods/DataAccessSecurityV1Api.md create mode 100644 sdk-output/data_access_security/docs/Methods/Index.md create mode 100644 sdk-output/data_access_security/docs/Models/Activityconfigurationsettings.md create mode 100644 sdk-output/data_access_security/docs/Models/Applicationcrawlersettings.md create mode 100644 sdk-output/data_access_security/docs/Models/Applicationitem.md create mode 100644 sdk-output/data_access_security/docs/Models/Applicationtype.md create mode 100644 sdk-output/data_access_security/docs/Models/Assignresourceownerrequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Basecreateapplicationrequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Basesettings.md create mode 100644 sdk-output/data_access_security/docs/Models/Businessservicetype.md create mode 100644 sdk-output/data_access_security/docs/Models/Crawlresourcessizesoptions.md create mode 100644 sdk-output/data_access_security/docs/Models/CreateIdentityCollectorV1200Response.md create mode 100644 sdk-output/data_access_security/docs/Models/Createidentitycollectorrequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Createschedulerequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Dataclassificationsettings.md create mode 100644 sdk-output/data_access_security/docs/Models/Dataownermodel.md create mode 100644 sdk-output/data_access_security/docs/Models/Errormessagedto.md create mode 100644 sdk-output/data_access_security/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/data_access_security/docs/Models/GetTasksV1401Response.md create mode 100644 sdk-output/data_access_security/docs/Models/GetTasksV1429Response.md create mode 100644 sdk-output/data_access_security/docs/Models/Identitycollectorlistitem.md create mode 100644 sdk-output/data_access_security/docs/Models/Index.md create mode 100644 sdk-output/data_access_security/docs/Models/Int64stringkeyvaluepair.md create mode 100644 sdk-output/data_access_security/docs/Models/Localeorigin.md create mode 100644 sdk-output/data_access_security/docs/Models/Permissioncollectorsettings.md create mode 100644 sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409Response.md create mode 100644 sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409ResponseMessagesInner.md create mode 100644 sdk-output/data_access_security/docs/Models/README.md create mode 100644 sdk-output/data_access_security/docs/Models/Reelectrequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Resourcemodel.md create mode 100644 sdk-output/data_access_security/docs/Models/Scheduleinfo.md create mode 100644 sdk-output/data_access_security/docs/Models/Tag.md create mode 100644 sdk-output/data_access_security/docs/Models/Taskinfo.md create mode 100644 sdk-output/data_access_security/docs/Models/Updateidentitycollectorrequest.md create mode 100644 sdk-output/data_access_security/docs/Models/Updateschedulerequest.md create mode 100644 sdk-output/data_segmentation/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/data_segmentation/docs/Methods/DataSegmentationV1Api.md create mode 100644 sdk-output/data_segmentation/docs/Methods/Index.md create mode 100644 sdk-output/data_segmentation/docs/Models/DataSegment.md create mode 100644 sdk-output/data_segmentation/docs/Models/Dtotype.md create mode 100644 sdk-output/data_segmentation/docs/Models/Errormessagedto.md create mode 100644 sdk-output/data_segmentation/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/data_segmentation/docs/Models/Expression.md create mode 100644 sdk-output/data_segmentation/docs/Models/ExpressionChildrenInner.md create mode 100644 sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1401Response.md create mode 100644 sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1429Response.md create mode 100644 sdk-output/data_segmentation/docs/Models/Index.md create mode 100644 sdk-output/data_segmentation/docs/Models/Localeorigin.md create mode 100644 sdk-output/data_segmentation/docs/Models/Membershiptype.md create mode 100644 sdk-output/data_segmentation/docs/Models/README.md create mode 100644 sdk-output/data_segmentation/docs/Models/Ref.md create mode 100644 sdk-output/data_segmentation/docs/Models/Scope.md create mode 100644 sdk-output/data_segmentation/docs/Models/Scopetype.md create mode 100644 sdk-output/data_segmentation/docs/Models/Scopevisibilitytype.md create mode 100644 sdk-output/data_segmentation/docs/Models/Segmentmembership.md create mode 100644 sdk-output/data_segmentation/docs/Models/Value.md create mode 100644 sdk-output/data_segmentation/docs/Models/Visibilitycriteria.md create mode 100644 sdk-output/declassify_source/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/declassify_source/docs/Methods/DeclassifySourceV1Api.md create mode 100644 sdk-output/declassify_source/docs/Methods/Index.md create mode 100644 sdk-output/declassify_source/docs/Models/Errormessagedto.md create mode 100644 sdk-output/declassify_source/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/declassify_source/docs/Models/Index.md create mode 100644 sdk-output/declassify_source/docs/Models/Localeorigin.md create mode 100644 sdk-output/declassify_source/docs/Models/README.md create mode 100644 sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1401Response.md create mode 100644 sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1429Response.md create mode 100644 sdk-output/dimensions/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/dimensions/docs/Methods/DimensionsV1Api.md create mode 100644 sdk-output/dimensions/docs/Methods/Index.md create mode 100644 sdk-output/dimensions/docs/Models/Accessduration.md create mode 100644 sdk-output/dimensions/docs/Models/Accessmodelmetadata.md create mode 100644 sdk-output/dimensions/docs/Models/AccessmodelmetadataValuesInner.md create mode 100644 sdk-output/dimensions/docs/Models/Accessprofile.md create mode 100644 sdk-output/dimensions/docs/Models/Accessprofileapprovalscheme.md create mode 100644 sdk-output/dimensions/docs/Models/Accessprofileref.md create mode 100644 sdk-output/dimensions/docs/Models/Accessprofilesourceref.md create mode 100644 sdk-output/dimensions/docs/Models/Additionalownerref.md create mode 100644 sdk-output/dimensions/docs/Models/ArrayInner.md create mode 100644 sdk-output/dimensions/docs/Models/Attributedto.md create mode 100644 sdk-output/dimensions/docs/Models/Attributedtolist.md create mode 100644 sdk-output/dimensions/docs/Models/Attributevaluedto.md create mode 100644 sdk-output/dimensions/docs/Models/Dimension.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensionbulkdeleterequest.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriteriakey.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriteriakeytype.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriterialevel1.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriterialevel2.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriterialevel3.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensioncriteriaoperation.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensionmembershipselector.md create mode 100644 sdk-output/dimensions/docs/Models/Dimensionmembershipselectortype.md create mode 100644 sdk-output/dimensions/docs/Models/Entitlement.md create mode 100644 sdk-output/dimensions/docs/Models/EntitlementAccessModelMetadata.md create mode 100644 sdk-output/dimensions/docs/Models/EntitlementOwner.md create mode 100644 sdk-output/dimensions/docs/Models/EntitlementSource.md create mode 100644 sdk-output/dimensions/docs/Models/Entitlementref.md create mode 100644 sdk-output/dimensions/docs/Models/Errormessagedto.md create mode 100644 sdk-output/dimensions/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/dimensions/docs/Models/Index.md create mode 100644 sdk-output/dimensions/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/dimensions/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/dimensions/docs/Models/ListDimensionsV1401Response.md create mode 100644 sdk-output/dimensions/docs/Models/ListDimensionsV1429Response.md create mode 100644 sdk-output/dimensions/docs/Models/Localeorigin.md create mode 100644 sdk-output/dimensions/docs/Models/Ownerreference.md create mode 100644 sdk-output/dimensions/docs/Models/Permissiondto.md create mode 100644 sdk-output/dimensions/docs/Models/Provisioningcriterialevel1.md create mode 100644 sdk-output/dimensions/docs/Models/Provisioningcriterialevel2.md create mode 100644 sdk-output/dimensions/docs/Models/Provisioningcriterialevel3.md create mode 100644 sdk-output/dimensions/docs/Models/Provisioningcriteriaoperation.md create mode 100644 sdk-output/dimensions/docs/Models/README.md create mode 100644 sdk-output/dimensions/docs/Models/Requestability.md create mode 100644 sdk-output/dimensions/docs/Models/Revocability.md create mode 100644 sdk-output/dimensions/docs/Models/Taskresultdto.md create mode 100644 sdk-output/entitlement_connections/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/entitlement_connections/docs/Methods/EntitlementConnectionsV1Api.md create mode 100644 sdk-output/entitlement_connections/docs/Methods/Index.md create mode 100644 sdk-output/entitlement_connections/docs/Models/ArrayInner.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Entitlementconnection.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateitem.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateresultitem.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhit.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhitentitlement.md create mode 100644 sdk-output/entitlement_connections/docs/Models/EntitlementconnectionsearchhitentitlementPrivilegeLevel.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Errormessagedto.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Index.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/entitlement_connections/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1401Response.md create mode 100644 sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1412Response.md create mode 100644 sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1429Response.md create mode 100644 sdk-output/entitlement_connections/docs/Models/Localeorigin.md create mode 100644 sdk-output/entitlement_connections/docs/Models/README.md create mode 100644 sdk-output/entitlements/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/entitlements/docs/Methods/EntitlementsV1Api.md create mode 100644 sdk-output/entitlements/docs/Methods/Index.md create mode 100644 sdk-output/entitlements/docs/Models/Accessmodelmetadata.md create mode 100644 sdk-output/entitlements/docs/Models/AccessmodelmetadataValuesInner.md create mode 100644 sdk-output/entitlements/docs/Models/Additionalownerref.md create mode 100644 sdk-output/entitlements/docs/Models/ArrayInner.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlement.md create mode 100644 sdk-output/entitlements/docs/Models/EntitlementSource.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementaccessrequestconfig.md create mode 100644 sdk-output/entitlements/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementapprovalscheme.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementbulkupdaterequest.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementprivilegelevel.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementrequestconfig.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementrevocationrequestconfig.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementsourceresetbasereferencedto.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementv2.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementv2AccessModelMetadata.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementv2Owner.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementv2PrivilegeLevel.md create mode 100644 sdk-output/entitlements/docs/Models/Entitlementv2Source.md create mode 100644 sdk-output/entitlements/docs/Models/Errormessagedto.md create mode 100644 sdk-output/entitlements/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/entitlements/docs/Models/ImportEntitlementsBySourceV1Request.md create mode 100644 sdk-output/entitlements/docs/Models/Index.md create mode 100644 sdk-output/entitlements/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/entitlements/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/entitlements/docs/Models/ListEntitlementsV1401Response.md create mode 100644 sdk-output/entitlements/docs/Models/ListEntitlementsV1429Response.md create mode 100644 sdk-output/entitlements/docs/Models/Loadentitlementtask.md create mode 100644 sdk-output/entitlements/docs/Models/LoadentitlementtaskReturnsInner.md create mode 100644 sdk-output/entitlements/docs/Models/Localeorigin.md create mode 100644 sdk-output/entitlements/docs/Models/Permissiondto.md create mode 100644 sdk-output/entitlements/docs/Models/README.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsV1Api.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Methods/Index.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/ArrayInner.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Errormessagedto.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Federationprotocoldetails.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1401Response.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1429Response.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Idpdetails.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Index.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Jitconfiguration.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Localeorigin.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Lockoutconfiguration.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Networkconfiguration.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/README.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Serviceproviderconfiguration.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/ServiceproviderconfigurationFederationProtocolDetailsInner.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Sessionconfiguration.md create mode 100644 sdk-output/global_tenant_security_settings/docs/Models/Spdetails.md create mode 100644 sdk-output/governance_groups/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/governance_groups/docs/Methods/GovernanceGroupsV1Api.md create mode 100644 sdk-output/governance_groups/docs/Methods/Index.md create mode 100644 sdk-output/governance_groups/docs/Models/ArrayInner.md create mode 100644 sdk-output/governance_groups/docs/Models/BulkworkgroupmembersrequestInner.md create mode 100644 sdk-output/governance_groups/docs/Models/Connectedobject.md create mode 100644 sdk-output/governance_groups/docs/Models/Connectedobjecttype.md create mode 100644 sdk-output/governance_groups/docs/Models/Errormessagedto.md create mode 100644 sdk-output/governance_groups/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/governance_groups/docs/Models/Index.md create mode 100644 sdk-output/governance_groups/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/governance_groups/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/governance_groups/docs/Models/ListWorkgroupMembersV1200ResponseInner.md create mode 100644 sdk-output/governance_groups/docs/Models/ListWorkgroupsV1401Response.md create mode 100644 sdk-output/governance_groups/docs/Models/ListWorkgroupsV1429Response.md create mode 100644 sdk-output/governance_groups/docs/Models/Localeorigin.md create mode 100644 sdk-output/governance_groups/docs/Models/Ownerdto.md create mode 100644 sdk-output/governance_groups/docs/Models/README.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupbulkdeleterequest.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupconnectiondto.md create mode 100644 sdk-output/governance_groups/docs/Models/WorkgroupconnectiondtoObject.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupdeleteitem.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupdto.md create mode 100644 sdk-output/governance_groups/docs/Models/WorkgroupdtoOwner.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupmemberadditem.md create mode 100644 sdk-output/governance_groups/docs/Models/Workgroupmemberdeleteitem.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsV1Api.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Methods/Index.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrecommendationmessage.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemdto.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemresponsedto.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationconfigdto.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitem.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemdetail.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/AccessrequestrecommendationitemdetailAccess.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemtype.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1401Response.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1429Response.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Index.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/README.md create mode 100644 sdk-output/iai_access_request_recommendations/docs/Models/Translationmessage.md create mode 100644 sdk-output/iai_common_access/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_common_access/docs/Methods/IAICommonAccessV1Api.md create mode 100644 sdk-output/iai_common_access/docs/Methods/Index.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessidstatus.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessitemaccess.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessitemrequest.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessitemresponse.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessitemstate.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccessresponse.md create mode 100644 sdk-output/iai_common_access/docs/Models/Commonaccesstype.md create mode 100644 sdk-output/iai_common_access/docs/Models/CreateCommonAccessV1429Response.md create mode 100644 sdk-output/iai_common_access/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_common_access/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_common_access/docs/Models/GetCommonAccessV1401Response.md create mode 100644 sdk-output/iai_common_access/docs/Models/Index.md create mode 100644 sdk-output/iai_common_access/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_common_access/docs/Models/README.md create mode 100644 sdk-output/iai_outliers/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_outliers/docs/Methods/IAIOutliersV1Api.md create mode 100644 sdk-output/iai_outliers/docs/Methods/Index.md create mode 100644 sdk-output/iai_outliers/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_outliers/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1401Response.md create mode 100644 sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1429Response.md create mode 100644 sdk-output/iai_outliers/docs/Models/Index.md create mode 100644 sdk-output/iai_outliers/docs/Models/Latestoutliersummary.md create mode 100644 sdk-output/iai_outliers/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outlier.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outliercontributingfeature.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outlierfeaturesummary.md create mode 100644 sdk-output/iai_outliers/docs/Models/OutlierfeaturesummaryOutlierFeatureDisplayValuesInner.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outlierfeaturetranslation.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outlierscontributingfeatureaccessitems.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outliersummary.md create mode 100644 sdk-output/iai_outliers/docs/Models/Outliervaluetype.md create mode 100644 sdk-output/iai_outliers/docs/Models/README.md create mode 100644 sdk-output/iai_outliers/docs/Models/Translationmessage.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesV1Api.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Methods/Index.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1401Response.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1429Response.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/Index.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/Peergroupmember.md create mode 100644 sdk-output/iai_peer_group_strategies/docs/Models/README.md create mode 100644 sdk-output/iai_recommendations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_recommendations/docs/Methods/IAIRecommendationsV1Api.md create mode 100644 sdk-output/iai_recommendations/docs/Methods/Index.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Accessitemref.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Featurevaluedto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1401Response.md create mode 100644 sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1429Response.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Index.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_recommendations/docs/Models/README.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendationconfigdto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendationrequest.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendationrequestdto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendationresponse.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendationresponsedto.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Recommendercalculations.md create mode 100644 sdk-output/iai_recommendations/docs/Models/RecommendercalculationsIdentityAttributesValue.md create mode 100644 sdk-output/iai_recommendations/docs/Models/Translationmessage.md create mode 100644 sdk-output/iai_role_mining/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/iai_role_mining/docs/Methods/IAIRoleMiningV1Api.md create mode 100644 sdk-output/iai_role_mining/docs/Methods/Index.md create mode 100644 sdk-output/iai_role_mining/docs/Models/ArrayInner.md create mode 100644 sdk-output/iai_role_mining/docs/Models/ArrayInner1.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Entitycreatedbydto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Errormessagedto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1401Response.md create mode 100644 sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1429Response.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Index.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/iai_role_mining/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Jsonpatchoperationrolemining.md create mode 100644 sdk-output/iai_role_mining/docs/Models/JsonpatchoperationroleminingValue.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Localeorigin.md create mode 100644 sdk-output/iai_role_mining/docs/Models/README.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingentitlement.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingentitlementref.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingidentity.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingidentitydistribution.md create mode 100644 sdk-output/iai_role_mining/docs/Models/RoleminingidentitydistributionDistributionInner.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrole.md create mode 100644 sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolePotentialRoleRef.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleapplication.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleeditentitlements.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleentitlements.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportrequest.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportresponse.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportstate.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionrequest.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionstate.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleref.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesourceusage.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesummary.md create mode 100644 sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolesummaryCreatedBy.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingroletype.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessiondraftroledto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessiondto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionparametersdto.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionresponse.md create mode 100644 sdk-output/iai_role_mining/docs/Models/RoleminingsessionresponseCreatedBy.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionscope.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionscopingmethod.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionstate.md create mode 100644 sdk-output/iai_role_mining/docs/Models/Roleminingsessionstatus.md create mode 100644 sdk-output/icons/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/icons/docs/Methods/IconsV1Api.md create mode 100644 sdk-output/icons/docs/Methods/Index.md create mode 100644 sdk-output/icons/docs/Models/Errormessagedto.md create mode 100644 sdk-output/icons/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/icons/docs/Models/Index.md create mode 100644 sdk-output/icons/docs/Models/Localeorigin.md create mode 100644 sdk-output/icons/docs/Models/README.md create mode 100644 sdk-output/icons/docs/Models/SetIconV1200Response.md create mode 100644 sdk-output/icons/docs/Models/SetIconV1401Response.md create mode 100644 sdk-output/icons/docs/Models/SetIconV1429Response.md create mode 100644 sdk-output/icons/docs/Models/SetIconV1Request.md create mode 100644 sdk-output/identities/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/identities/docs/Methods/IdentitiesV1Api.md create mode 100644 sdk-output/identities/docs/Methods/Index.md create mode 100644 sdk-output/identities/docs/Models/Accessrequestcontext.md create mode 100644 sdk-output/identities/docs/Models/Accountinfodto.md create mode 100644 sdk-output/identities/docs/Models/Assignmentcontextdto.md create mode 100644 sdk-output/identities/docs/Models/Basereferencedto.md create mode 100644 sdk-output/identities/docs/Models/Contextattributedto.md create mode 100644 sdk-output/identities/docs/Models/ContextattributedtoValue.md create mode 100644 sdk-output/identities/docs/Models/Dtotype.md create mode 100644 sdk-output/identities/docs/Models/Errormessagedto.md create mode 100644 sdk-output/identities/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/identities/docs/Models/GetRoleAssignmentsV1200ResponseInner.md create mode 100644 sdk-output/identities/docs/Models/Identity.md create mode 100644 sdk-output/identities/docs/Models/IdentityLifecycleState.md create mode 100644 sdk-output/identities/docs/Models/IdentityManagerRef.md create mode 100644 sdk-output/identities/docs/Models/Identityassociationdetails.md create mode 100644 sdk-output/identities/docs/Models/IdentityassociationdetailsAssociationDetailsInner.md create mode 100644 sdk-output/identities/docs/Models/Identityentities.md create mode 100644 sdk-output/identities/docs/Models/IdentityentitiesIdentityEntity.md create mode 100644 sdk-output/identities/docs/Models/Identityentitlements.md create mode 100644 sdk-output/identities/docs/Models/Identityownershipassociationdetails.md create mode 100644 sdk-output/identities/docs/Models/IdentityownershipassociationdetailsAssociationDetailsInner.md create mode 100644 sdk-output/identities/docs/Models/Identitysyncjob.md create mode 100644 sdk-output/identities/docs/Models/Identitysyncpayload.md create mode 100644 sdk-output/identities/docs/Models/Index.md create mode 100644 sdk-output/identities/docs/Models/Inviteidentitiesrequest.md create mode 100644 sdk-output/identities/docs/Models/Lifecyclestatedto.md create mode 100644 sdk-output/identities/docs/Models/ListIdentitiesV1401Response.md create mode 100644 sdk-output/identities/docs/Models/ListIdentitiesV1429Response.md create mode 100644 sdk-output/identities/docs/Models/Localeorigin.md create mode 100644 sdk-output/identities/docs/Models/Localizedmessage.md create mode 100644 sdk-output/identities/docs/Models/Processidentitiesrequest.md create mode 100644 sdk-output/identities/docs/Models/README.md create mode 100644 sdk-output/identities/docs/Models/Roleassignmentdto.md create mode 100644 sdk-output/identities/docs/Models/RoleassignmentdtoAssigner.md create mode 100644 sdk-output/identities/docs/Models/RoleassignmentdtoAssignmentContext.md create mode 100644 sdk-output/identities/docs/Models/Roleassignmentref.md create mode 100644 sdk-output/identities/docs/Models/Rolematchdto.md create mode 100644 sdk-output/identities/docs/Models/Roletargetdto.md create mode 100644 sdk-output/identities/docs/Models/Sendaccountverificationrequest.md create mode 100644 sdk-output/identities/docs/Models/Taggedobjectdto.md create mode 100644 sdk-output/identities/docs/Models/Target.md create mode 100644 sdk-output/identities/docs/Models/Taskdefinitionsummary.md create mode 100644 sdk-output/identities/docs/Models/Taskresultresponse.md create mode 100644 sdk-output/identities/docs/Models/Taskreturndetails.md create mode 100644 sdk-output/identities/docs/Models/Taskstatus.md create mode 100644 sdk-output/identities/docs/Models/Taskstatusmessage.md create mode 100644 sdk-output/identities/docs/Models/TaskstatusmessageParametersInner.md create mode 100644 sdk-output/identity_attributes/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/identity_attributes/docs/Methods/IdentityAttributesV1Api.md create mode 100644 sdk-output/identity_attributes/docs/Methods/Index.md create mode 100644 sdk-output/identity_attributes/docs/Models/Errormessagedto.md create mode 100644 sdk-output/identity_attributes/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/identity_attributes/docs/Models/Identityattribute2.md create mode 100644 sdk-output/identity_attributes/docs/Models/Identityattributenames.md create mode 100644 sdk-output/identity_attributes/docs/Models/Index.md create mode 100644 sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1401Response.md create mode 100644 sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1429Response.md create mode 100644 sdk-output/identity_attributes/docs/Models/Localeorigin.md create mode 100644 sdk-output/identity_attributes/docs/Models/README.md create mode 100644 sdk-output/identity_attributes/docs/Models/Source2.md create mode 100644 sdk-output/identity_history/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/identity_history/docs/Methods/IdentityHistoryV1Api.md create mode 100644 sdk-output/identity_history/docs/Methods/Index.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemaccessprofileresponse.md create mode 100644 sdk-output/identity_history/docs/Models/AccessitemaccessprofileresponseAppRefsInner.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemaccountresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemappresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemassociated.md create mode 100644 sdk-output/identity_history/docs/Models/AccessitemassociatedAccessItem.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemdiff.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitementitlementresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemremoved.md create mode 100644 sdk-output/identity_history/docs/Models/Accessitemroleresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Accessrequested.md create mode 100644 sdk-output/identity_history/docs/Models/Accessrequestitemresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Accessrequestresponse2.md create mode 100644 sdk-output/identity_history/docs/Models/Accountstatuschanged.md create mode 100644 sdk-output/identity_history/docs/Models/AccountstatuschangedAccount.md create mode 100644 sdk-output/identity_history/docs/Models/AccountstatuschangedStatusChange.md create mode 100644 sdk-output/identity_history/docs/Models/Approvalinforesponse.md create mode 100644 sdk-output/identity_history/docs/Models/Attributechange.md create mode 100644 sdk-output/identity_history/docs/Models/Attributeschanged.md create mode 100644 sdk-output/identity_history/docs/Models/Certifierresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Correlatedgovernanceevent.md create mode 100644 sdk-output/identity_history/docs/Models/Errormessagedto.md create mode 100644 sdk-output/identity_history/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/identity_history/docs/Models/GetHistoricalIdentityEventsV1200ResponseInner.md create mode 100644 sdk-output/identity_history/docs/Models/Identitycertified.md create mode 100644 sdk-output/identity_history/docs/Models/Identitycompareresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Identityhistoryresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Identitylistitem.md create mode 100644 sdk-output/identity_history/docs/Models/Identitysnapshotsummaryresponse.md create mode 100644 sdk-output/identity_history/docs/Models/Index.md create mode 100644 sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1401Response.md create mode 100644 sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1429Response.md create mode 100644 sdk-output/identity_history/docs/Models/ListIdentityAccessItemsV1200ResponseInner.md create mode 100644 sdk-output/identity_history/docs/Models/ListIdentitySnapshotAccessItemsV1200ResponseInner.md create mode 100644 sdk-output/identity_history/docs/Models/Localeorigin.md create mode 100644 sdk-output/identity_history/docs/Models/Metricresponse.md create mode 100644 sdk-output/identity_history/docs/Models/README.md create mode 100644 sdk-output/identity_profiles/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/identity_profiles/docs/Methods/IdentityProfilesV1Api.md create mode 100644 sdk-output/identity_profiles/docs/Methods/Index.md create mode 100644 sdk-output/identity_profiles/docs/Models/ArrayInner.md create mode 100644 sdk-output/identity_profiles/docs/Models/Basecommondto.md create mode 100644 sdk-output/identity_profiles/docs/Models/Errormessagedto.md create mode 100644 sdk-output/identity_profiles/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityattributeconfig.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityattributepreview.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityattributetransform.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityexceptionreportreference.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identitypreviewrequest.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identitypreviewresponse.md create mode 100644 sdk-output/identity_profiles/docs/Models/IdentitypreviewresponseIdentity.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityprofile.md create mode 100644 sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfAuthoritativeSource.md create mode 100644 sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfOwner.md create mode 100644 sdk-output/identity_profiles/docs/Models/Identityprofileexportedobject.md create mode 100644 sdk-output/identity_profiles/docs/Models/IdentityprofileexportedobjectSelf.md create mode 100644 sdk-output/identity_profiles/docs/Models/Importobject.md create mode 100644 sdk-output/identity_profiles/docs/Models/Index.md create mode 100644 sdk-output/identity_profiles/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/identity_profiles/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1401Response.md create mode 100644 sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1429Response.md create mode 100644 sdk-output/identity_profiles/docs/Models/Localeorigin.md create mode 100644 sdk-output/identity_profiles/docs/Models/Objectimportresult.md create mode 100644 sdk-output/identity_profiles/docs/Models/README.md create mode 100644 sdk-output/identity_profiles/docs/Models/Spconfigmessage.md create mode 100644 sdk-output/identity_profiles/docs/Models/Taskresultsimplified.md create mode 100644 sdk-output/identity_profiles/docs/Models/Transformdefinition.md create mode 100644 sdk-output/jit_access/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/jit_access/docs/Methods/Index.md create mode 100644 sdk-output/jit_access/docs/Methods/JITAccessV1Api.md create mode 100644 sdk-output/jit_access/docs/Models/Errormessagedto.md create mode 100644 sdk-output/jit_access/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/jit_access/docs/Models/GetJitActivationConfigV1401Response.md create mode 100644 sdk-output/jit_access/docs/Models/GetJitActivationConfigV1429Response.md create mode 100644 sdk-output/jit_access/docs/Models/Index.md create mode 100644 sdk-output/jit_access/docs/Models/Jitaccessoperationrequest.md create mode 100644 sdk-output/jit_access/docs/Models/JitaccessoperationrequestValue.md create mode 100644 sdk-output/jit_access/docs/Models/Jitactivationconfigresponse.md create mode 100644 sdk-output/jit_access/docs/Models/Localeorigin.md create mode 100644 sdk-output/jit_access/docs/Models/README.md create mode 100644 sdk-output/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/jit_activations/docs/Methods/Index.md create mode 100644 sdk-output/jit_activations/docs/Methods/JITActivationsV1Api.md create mode 100644 sdk-output/jit_activations/docs/Models/Activationworkflowstatus.md create mode 100644 sdk-output/jit_activations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/jit_activations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/jit_activations/docs/Models/Index.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationactivaterequest.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationactivateresponse.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationdeactivaterequest.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationdeactivateresponse.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationextendrequest.md create mode 100644 sdk-output/jit_activations/docs/Models/Jitactivationextendresponse.md create mode 100644 sdk-output/jit_activations/docs/Models/Localeorigin.md create mode 100644 sdk-output/jit_activations/docs/Models/README.md create mode 100644 sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1401Response.md create mode 100644 sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1429Response.md create mode 100644 sdk-output/launchers/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/launchers/docs/Methods/Index.md create mode 100644 sdk-output/launchers/docs/Methods/LaunchersV1Api.md create mode 100644 sdk-output/launchers/docs/Models/Errormessagedto.md create mode 100644 sdk-output/launchers/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/launchers/docs/Models/GetLaunchersV1200Response.md create mode 100644 sdk-output/launchers/docs/Models/GetLaunchersV1401Response.md create mode 100644 sdk-output/launchers/docs/Models/GetLaunchersV1429Response.md create mode 100644 sdk-output/launchers/docs/Models/Index.md create mode 100644 sdk-output/launchers/docs/Models/Launcher.md create mode 100644 sdk-output/launchers/docs/Models/LauncherOwner.md create mode 100644 sdk-output/launchers/docs/Models/LauncherReference.md create mode 100644 sdk-output/launchers/docs/Models/Launcherrequest.md create mode 100644 sdk-output/launchers/docs/Models/LauncherrequestReference.md create mode 100644 sdk-output/launchers/docs/Models/Localeorigin.md create mode 100644 sdk-output/launchers/docs/Models/README.md create mode 100644 sdk-output/launchers/docs/Models/StartLauncherV1200Response.md create mode 100644 sdk-output/lifecycle_states/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/lifecycle_states/docs/Methods/Index.md create mode 100644 sdk-output/lifecycle_states/docs/Methods/LifecycleStatesV1Api.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Accessactionconfiguration.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Accountaction.md create mode 100644 sdk-output/lifecycle_states/docs/Models/ArrayInner.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Basecommondto.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Emailnotificationoption.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Errormessagedto.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Index.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/lifecycle_states/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Lifecyclestate.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Lifecyclestatedeleted.md create mode 100644 sdk-output/lifecycle_states/docs/Models/Localeorigin.md create mode 100644 sdk-output/lifecycle_states/docs/Models/README.md create mode 100644 sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md create mode 100644 sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1401Response.md create mode 100644 sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1429Response.md create mode 100644 sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1Request.md create mode 100644 sdk-output/machine_account_classify/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_account_classify/docs/Methods/Index.md create mode 100644 sdk-output/machine_account_classify/docs/Methods/MachineAccountClassifyV1Api.md create mode 100644 sdk-output/machine_account_classify/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_account_classify/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_account_classify/docs/Models/Index.md create mode 100644 sdk-output/machine_account_classify/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_account_classify/docs/Models/README.md create mode 100644 sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1200Response.md create mode 100644 sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1401Response.md create mode 100644 sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1429Response.md create mode 100644 sdk-output/machine_account_creation_request/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_account_creation_request/docs/Methods/Index.md create mode 100644 sdk-output/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestV1Api.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Accountrequestasyncresult.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Accountrequestdetailsdto.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/AccountrequestdetailsdtoRequester.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Accountrequestphase.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Accountrequestphasestate.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Basereferencedto.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1401Response.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1429Response.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Dtotype.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Index.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreateaccessdto.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/MachineaccountcreateaccessdtoSubtypesInner.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreaterequestinput.md create mode 100644 sdk-output/machine_account_creation_request/docs/Models/README.md create mode 100644 sdk-output/machine_account_mappings/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_account_mappings/docs/Methods/Index.md create mode 100644 sdk-output/machine_account_mappings/docs/Methods/MachineAccountMappingsV1Api.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/Attributemappings.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTarget.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinition.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributes.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInput.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInputAttributes.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/Index.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1401Response.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1429Response.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_account_mappings/docs/Models/README.md create mode 100644 sdk-output/machine_account_subtypes/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_account_subtypes/docs/Methods/Index.md create mode 100644 sdk-output/machine_account_subtypes/docs/Methods/MachineAccountSubtypesV1Api.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/ArrayInner.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/CreateSourceSubtypeV1Request.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Index.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1401Response.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1429Response.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Machineaccountsubtypeconfigdto.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountCreate.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountDelete.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Machinesubtypeapprovalconfig.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/README.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/Sourcesubtypewithsource.md create mode 100644 sdk-output/machine_account_subtypes/docs/Models/SourcesubtypewithsourceSource.md create mode 100644 sdk-output/machine_accounts/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_accounts/docs/Methods/Index.md create mode 100644 sdk-output/machine_accounts/docs/Methods/MachineAccountsV1Api.md create mode 100644 sdk-output/machine_accounts/docs/Models/Basecommondto.md create mode 100644 sdk-output/machine_accounts/docs/Models/CreateMachineAccountSubtypeV1Request.md create mode 100644 sdk-output/machine_accounts/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_accounts/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_accounts/docs/Models/Index.md create mode 100644 sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1401Response.md create mode 100644 sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1429Response.md create mode 100644 sdk-output/machine_accounts/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_accounts/docs/Models/Machineaccount.md create mode 100644 sdk-output/machine_accounts/docs/Models/README.md create mode 100644 sdk-output/machine_accounts/docs/Models/Sourcesubtype.md create mode 100644 sdk-output/machine_classification_config/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_classification_config/docs/Methods/Index.md create mode 100644 sdk-output/machine_classification_config/docs/Methods/MachineClassificationConfigV1Api.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1401Response.md create mode 100644 sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1429Response.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Index.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Machineclassificationconfig.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel1.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel2.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel3.md create mode 100644 sdk-output/machine_classification_config/docs/Models/Machineclassificationcriteriaoperation.md create mode 100644 sdk-output/machine_classification_config/docs/Models/README.md create mode 100644 sdk-output/machine_identities/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/machine_identities/docs/Methods/Index.md create mode 100644 sdk-output/machine_identities/docs/Methods/MachineIdentitiesV1Api.md create mode 100644 sdk-output/machine_identities/docs/Models/Basecommondto.md create mode 100644 sdk-output/machine_identities/docs/Models/Basereferencedto.md create mode 100644 sdk-output/machine_identities/docs/Models/Dtotype.md create mode 100644 sdk-output/machine_identities/docs/Models/Errormessagedto.md create mode 100644 sdk-output/machine_identities/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/machine_identities/docs/Models/Index.md create mode 100644 sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1401Response.md create mode 100644 sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1429Response.md create mode 100644 sdk-output/machine_identities/docs/Models/Localeorigin.md create mode 100644 sdk-output/machine_identities/docs/Models/Localizedmessage.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineIdentityDtoOwners.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineIdentityRequestUserEntitlements.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineIdentityResponseUserEntitlements.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentity.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentityaggregationrequest.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentityaggregationresponse.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineidentityaggregationresponseTarget.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentityrequest.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentityresponse.md create mode 100644 sdk-output/machine_identities/docs/Models/Machineidentityuserentitlementresponse.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseEntitlement.md create mode 100644 sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseSource.md create mode 100644 sdk-output/machine_identities/docs/Models/README.md create mode 100644 sdk-output/machine_identities/docs/Models/Taskdefinitionsummary.md create mode 100644 sdk-output/machine_identities/docs/Models/Taskreturndetails.md create mode 100644 sdk-output/machine_identities/docs/Models/Taskstatusmessage.md create mode 100644 sdk-output/machine_identities/docs/Models/TaskstatusmessageParametersInner.md create mode 100644 sdk-output/managed_clients/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/managed_clients/docs/Methods/Index.md create mode 100644 sdk-output/managed_clients/docs/Methods/ManagedClientsV1Api.md create mode 100644 sdk-output/managed_clients/docs/Models/ArrayInner.md create mode 100644 sdk-output/managed_clients/docs/Models/Errormessagedto.md create mode 100644 sdk-output/managed_clients/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/managed_clients/docs/Models/GetManagedClientsV1401Response.md create mode 100644 sdk-output/managed_clients/docs/Models/GetManagedClientsV1429Response.md create mode 100644 sdk-output/managed_clients/docs/Models/Healthevent.md create mode 100644 sdk-output/managed_clients/docs/Models/Healthindicatorcategory.md create mode 100644 sdk-output/managed_clients/docs/Models/Index.md create mode 100644 sdk-output/managed_clients/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/managed_clients/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/managed_clients/docs/Models/Localeorigin.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclient.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclienthealthindicators.md create mode 100644 sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBody.md create mode 100644 sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBodyHealthIndicators.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclientrequest.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclientstatus.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclientstatuscode.md create mode 100644 sdk-output/managed_clients/docs/Models/Managedclienttype.md create mode 100644 sdk-output/managed_clients/docs/Models/README.md create mode 100644 sdk-output/managed_cluster_types/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/managed_cluster_types/docs/Methods/Index.md create mode 100644 sdk-output/managed_cluster_types/docs/Methods/ManagedClusterTypesV1Api.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/ArrayInner.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Errormessagedto.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1401Response.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1429Response.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Index.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Jsonpatch.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Localeorigin.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/Managedclustertype.md create mode 100644 sdk-output/managed_cluster_types/docs/Models/README.md create mode 100644 sdk-output/managed_clusters/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/managed_clusters/docs/Methods/Index.md create mode 100644 sdk-output/managed_clusters/docs/Methods/ManagedClustersV1Api.md create mode 100644 sdk-output/managed_clusters/docs/Models/ArrayInner.md create mode 100644 sdk-output/managed_clusters/docs/Models/Clientlogconfiguration.md create mode 100644 sdk-output/managed_clusters/docs/Models/Clientlogconfigurationdurationminutes.md create mode 100644 sdk-output/managed_clusters/docs/Models/Clientlogconfigurationexpiration.md create mode 100644 sdk-output/managed_clusters/docs/Models/Clustermanualupgrade.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInner.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfiguration.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCcg.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCharon.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgent.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationRelay.md create mode 100644 sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationToolbox.md create mode 100644 sdk-output/managed_clusters/docs/Models/Errormessagedto.md create mode 100644 sdk-output/managed_clusters/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/managed_clusters/docs/Models/GetManagedClustersV1401Response.md create mode 100644 sdk-output/managed_clusters/docs/Models/GetManagedClustersV1429Response.md create mode 100644 sdk-output/managed_clusters/docs/Models/Index.md create mode 100644 sdk-output/managed_clusters/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/managed_clusters/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/managed_clusters/docs/Models/Localeorigin.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclienttype.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedcluster.md create mode 100644 sdk-output/managed_clusters/docs/Models/ManagedclusterUpdatePreferences.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterattributes.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterencryptionconfig.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterkeypair.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterqueue.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterredis.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclusterrequest.md create mode 100644 sdk-output/managed_clusters/docs/Models/Managedclustertypes.md create mode 100644 sdk-output/managed_clusters/docs/Models/PutClientLogConfigurationV1Request.md create mode 100644 sdk-output/managed_clusters/docs/Models/README.md create mode 100644 sdk-output/managed_clusters/docs/Models/Standardlevel.md create mode 100644 sdk-output/mfa_configuration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/mfa_configuration/docs/Methods/Index.md create mode 100644 sdk-output/mfa_configuration/docs/Methods/MFAConfigurationV1Api.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1401Response.md create mode 100644 sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1429Response.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Index.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Kbaanswerrequestitem.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Kbaanswerresponseitem.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Kbaquestion.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Localeorigin.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Mfaconfigtestresponse.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Mfaduoconfig.md create mode 100644 sdk-output/mfa_configuration/docs/Models/Mfaoktaconfig.md create mode 100644 sdk-output/mfa_configuration/docs/Models/README.md create mode 100644 sdk-output/multi_host_integration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/multi_host_integration/docs/Methods/Index.md create mode 100644 sdk-output/multi_host_integration/docs/Methods/MultiHostIntegrationV1Api.md create mode 100644 sdk-output/multi_host_integration/docs/Models/ArrayInner.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1401Response.md create mode 100644 sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1429Response.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Index.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Localeorigin.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Managercorrelationmapping.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostintegrations.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationConfig.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationRule.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountsFile.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsBeforeProvisioningRule.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsCluster.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributes.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesConnectorFileUploadHistory.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesMultiHostAttributes.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagementWorkgroup.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationMapping.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationRule.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsOwner.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsPasswordPoliciesInner.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostintegrationsSchemasInner.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostintegrationsaggscheduleupdate.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreate.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreatesources.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostintegrationtemplatetype.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Multihostsources.md create mode 100644 sdk-output/multi_host_integration/docs/Models/MultihostsourcesBeforeProvisioningRule.md create mode 100644 sdk-output/multi_host_integration/docs/Models/README.md create mode 100644 sdk-output/multi_host_integration/docs/Models/Sourcecreationerrors.md create mode 100644 sdk-output/multi_host_integration/docs/Models/TestSourceConnectionMultihostV1200Response.md create mode 100644 sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInner.md create mode 100644 sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInnerValue.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Methods/Index.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementV1Api.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Approvalstatus.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/ArrayInner.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/DeleteNonEmployeeRecordsInBulkV1Request.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Errormessagedto.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/ImportNonEmployeeRecordsInBulkV1Request.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Index.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1401Response.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1429Response.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Localeorigin.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovaldecision.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitem.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitembase.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitemdetail.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalsummary.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadjob.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadstatus.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentitydtotype.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentityreferencewithid.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidnuserrequest.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerecord.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerejectapprovaldecision.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequest.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestbody.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestlite.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestsummary.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestwithoutapprovalitem.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattribute.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributebody.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributetype.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesource.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelite.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelitewithschemaattributes.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcerequestbody.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithcloudexternalid.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithnecount.md create mode 100644 sdk-output/non_employee_lifecycle_management/docs/Models/README.md create mode 100644 sdk-output/notifications/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/notifications/docs/Methods/Index.md create mode 100644 sdk-output/notifications/docs/Methods/NotificationsV1Api.md create mode 100644 sdk-output/notifications/docs/Models/CreateDomainDkimV1405Response.md create mode 100644 sdk-output/notifications/docs/Models/Dkimattributes.md create mode 100644 sdk-output/notifications/docs/Models/Domainaddress.md create mode 100644 sdk-output/notifications/docs/Models/Domainstatusdto.md create mode 100644 sdk-output/notifications/docs/Models/Emailstatusdto.md create mode 100644 sdk-output/notifications/docs/Models/Errormessagedto.md create mode 100644 sdk-output/notifications/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1401Response.md create mode 100644 sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1429Response.md create mode 100644 sdk-output/notifications/docs/Models/Index.md create mode 100644 sdk-output/notifications/docs/Models/Localeorigin.md create mode 100644 sdk-output/notifications/docs/Models/Mailfromattributes.md create mode 100644 sdk-output/notifications/docs/Models/Mailfromattributesdto.md create mode 100644 sdk-output/notifications/docs/Models/Medium.md create mode 100644 sdk-output/notifications/docs/Models/Notificationtemplatecontext.md create mode 100644 sdk-output/notifications/docs/Models/Preferencesdto.md create mode 100644 sdk-output/notifications/docs/Models/README.md create mode 100644 sdk-output/notifications/docs/Models/Sendtestnotificationrequestdto.md create mode 100644 sdk-output/notifications/docs/Models/Templatebulkdeletedto.md create mode 100644 sdk-output/notifications/docs/Models/Templatedto.md create mode 100644 sdk-output/notifications/docs/Models/TemplatedtoSlackTemplate.md create mode 100644 sdk-output/notifications/docs/Models/TemplatedtoTeamsTemplate.md create mode 100644 sdk-output/notifications/docs/Models/Templatedtodefault.md create mode 100644 sdk-output/notifications/docs/Models/Templatemediumdto.md create mode 100644 sdk-output/notifications/docs/Models/Templateslack.md create mode 100644 sdk-output/notifications/docs/Models/TemplateslackAutoApprovalData.md create mode 100644 sdk-output/notifications/docs/Models/TemplateslackCustomFields.md create mode 100644 sdk-output/notifications/docs/Models/Templateteams.md create mode 100644 sdk-output/notifications/docs/Models/Templatevariable.md create mode 100644 sdk-output/notifications/docs/Models/Templatevariablesdto.md create mode 100644 sdk-output/oauth_clients/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/oauth_clients/docs/Methods/Index.md create mode 100644 sdk-output/oauth_clients/docs/Methods/OAuthClientsV1Api.md create mode 100644 sdk-output/oauth_clients/docs/Models/Accesstype.md create mode 100644 sdk-output/oauth_clients/docs/Models/ArrayInner.md create mode 100644 sdk-output/oauth_clients/docs/Models/Clienttype.md create mode 100644 sdk-output/oauth_clients/docs/Models/Createoauthclientrequest.md create mode 100644 sdk-output/oauth_clients/docs/Models/Createoauthclientresponse.md create mode 100644 sdk-output/oauth_clients/docs/Models/Errormessagedto.md create mode 100644 sdk-output/oauth_clients/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/oauth_clients/docs/Models/Getoauthclientresponse.md create mode 100644 sdk-output/oauth_clients/docs/Models/Granttype.md create mode 100644 sdk-output/oauth_clients/docs/Models/Index.md create mode 100644 sdk-output/oauth_clients/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/oauth_clients/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/oauth_clients/docs/Models/ListOauthClientsV1401Response.md create mode 100644 sdk-output/oauth_clients/docs/Models/ListOauthClientsV1429Response.md create mode 100644 sdk-output/oauth_clients/docs/Models/Localeorigin.md create mode 100644 sdk-output/oauth_clients/docs/Models/README.md create mode 100644 sdk-output/org_config/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/org_config/docs/Methods/Index.md create mode 100644 sdk-output/org_config/docs/Methods/OrgConfigV1Api.md create mode 100644 sdk-output/org_config/docs/Models/ArrayInner.md create mode 100644 sdk-output/org_config/docs/Models/Errormessagedto.md create mode 100644 sdk-output/org_config/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/org_config/docs/Models/GetOrgConfigV1401Response.md create mode 100644 sdk-output/org_config/docs/Models/GetOrgConfigV1429Response.md create mode 100644 sdk-output/org_config/docs/Models/Index.md create mode 100644 sdk-output/org_config/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/org_config/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/org_config/docs/Models/Localeorigin.md create mode 100644 sdk-output/org_config/docs/Models/Orgconfig.md create mode 100644 sdk-output/org_config/docs/Models/README.md create mode 100644 sdk-output/org_config/docs/Models/Reportconfigdto.md create mode 100644 sdk-output/parameter_storage/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/parameter_storage/docs/Methods/Index.md create mode 100644 sdk-output/parameter_storage/docs/Methods/ParameterStorageV1Api.md create mode 100644 sdk-output/parameter_storage/docs/Models/DeleteParameterV1409Response.md create mode 100644 sdk-output/parameter_storage/docs/Models/Errormessagedto.md create mode 100644 sdk-output/parameter_storage/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1401Response.md create mode 100644 sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1429Response.md create mode 100644 sdk-output/parameter_storage/docs/Models/Index.md create mode 100644 sdk-output/parameter_storage/docs/Models/Localeorigin.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstorageattestationdocument.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstoragejsonpatch.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstoragenewparameter.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstorageparameter.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstoragereference.md create mode 100644 sdk-output/parameter_storage/docs/Models/Parameterstorageupdateparameter.md create mode 100644 sdk-output/parameter_storage/docs/Models/README.md create mode 100644 sdk-output/password_configuration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/password_configuration/docs/Methods/Index.md create mode 100644 sdk-output/password_configuration/docs/Methods/PasswordConfigurationV1Api.md create mode 100644 sdk-output/password_configuration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/password_configuration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1401Response.md create mode 100644 sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1429Response.md create mode 100644 sdk-output/password_configuration/docs/Models/Index.md create mode 100644 sdk-output/password_configuration/docs/Models/Localeorigin.md create mode 100644 sdk-output/password_configuration/docs/Models/Passwordorgconfig.md create mode 100644 sdk-output/password_configuration/docs/Models/README.md create mode 100644 sdk-output/password_dictionary/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/password_dictionary/docs/Methods/Index.md create mode 100644 sdk-output/password_dictionary/docs/Methods/PasswordDictionaryV1Api.md create mode 100644 sdk-output/password_dictionary/docs/Models/Errormessagedto.md create mode 100644 sdk-output/password_dictionary/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1401Response.md create mode 100644 sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1429Response.md create mode 100644 sdk-output/password_dictionary/docs/Models/Index.md create mode 100644 sdk-output/password_dictionary/docs/Models/Localeorigin.md create mode 100644 sdk-output/password_dictionary/docs/Models/PutPasswordDictionaryV1Request.md create mode 100644 sdk-output/password_dictionary/docs/Models/README.md create mode 100644 sdk-output/password_management/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/password_management/docs/Methods/Index.md create mode 100644 sdk-output/password_management/docs/Methods/PasswordManagementV1Api.md create mode 100644 sdk-output/password_management/docs/Models/Errormessagedto.md create mode 100644 sdk-output/password_management/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/password_management/docs/Models/Index.md create mode 100644 sdk-output/password_management/docs/Models/Localeorigin.md create mode 100644 sdk-output/password_management/docs/Models/Passwordchangerequest.md create mode 100644 sdk-output/password_management/docs/Models/Passwordchangeresponse.md create mode 100644 sdk-output/password_management/docs/Models/Passworddigittoken.md create mode 100644 sdk-output/password_management/docs/Models/Passworddigittokenreset.md create mode 100644 sdk-output/password_management/docs/Models/Passwordinfo.md create mode 100644 sdk-output/password_management/docs/Models/Passwordinfoaccount.md create mode 100644 sdk-output/password_management/docs/Models/Passwordinfoquerydto.md create mode 100644 sdk-output/password_management/docs/Models/Passwordstatus.md create mode 100644 sdk-output/password_management/docs/Models/QueryPasswordInfoV1401Response.md create mode 100644 sdk-output/password_management/docs/Models/QueryPasswordInfoV1429Response.md create mode 100644 sdk-output/password_management/docs/Models/README.md create mode 100644 sdk-output/password_policies/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/password_policies/docs/Methods/Index.md create mode 100644 sdk-output/password_policies/docs/Methods/PasswordPoliciesV1Api.md create mode 100644 sdk-output/password_policies/docs/Models/Errormessagedto.md create mode 100644 sdk-output/password_policies/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1401Response.md create mode 100644 sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1429Response.md create mode 100644 sdk-output/password_policies/docs/Models/Index.md create mode 100644 sdk-output/password_policies/docs/Models/Localeorigin.md create mode 100644 sdk-output/password_policies/docs/Models/Passwordpolicyv3dto.md create mode 100644 sdk-output/password_policies/docs/Models/README.md create mode 100644 sdk-output/password_sync_groups/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/password_sync_groups/docs/Methods/Index.md create mode 100644 sdk-output/password_sync_groups/docs/Methods/PasswordSyncGroupsV1Api.md create mode 100644 sdk-output/password_sync_groups/docs/Models/Errormessagedto.md create mode 100644 sdk-output/password_sync_groups/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1401Response.md create mode 100644 sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1429Response.md create mode 100644 sdk-output/password_sync_groups/docs/Models/Index.md create mode 100644 sdk-output/password_sync_groups/docs/Models/Localeorigin.md create mode 100644 sdk-output/password_sync_groups/docs/Models/Passwordsyncgroup.md create mode 100644 sdk-output/password_sync_groups/docs/Models/README.md create mode 100644 sdk-output/personal_access_tokens/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/personal_access_tokens/docs/Methods/Index.md create mode 100644 sdk-output/personal_access_tokens/docs/Methods/PersonalAccessTokensV1Api.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/ArrayInner.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenrequest.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenresponse.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Errormessagedto.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Getpersonalaccesstokenresponse.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Index.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1401Response.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1429Response.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Localeorigin.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/Patowner.md create mode 100644 sdk-output/personal_access_tokens/docs/Models/README.md create mode 100644 sdk-output/privilege_criteria/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/privilege_criteria/docs/Methods/Index.md create mode 100644 sdk-output/privilege_criteria/docs/Methods/PrivilegeCriteriaV1Api.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Createprivilegecriteriarequest.md create mode 100644 sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInner.md create mode 100644 sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInner.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Errormessagedto.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Index.md create mode 100644 sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1401Response.md create mode 100644 sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1429Response.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Localeorigin.md create mode 100644 sdk-output/privilege_criteria/docs/Models/Privilegecriteriadto.md create mode 100644 sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInner.md create mode 100644 sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInnerCriteriaItemsInner.md create mode 100644 sdk-output/privilege_criteria/docs/Models/README.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/privilege_criteria_configuration/docs/Methods/Index.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationV1Api.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1401Response.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1429Response.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/Index.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/Localeorigin.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/Privilegecriteriaconfigdto.md create mode 100644 sdk-output/privilege_criteria_configuration/docs/Models/README.md create mode 100644 sdk-output/prompt_insights/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/prompt_insights/docs/Methods/Index.md create mode 100644 sdk-output/prompt_insights/docs/Methods/PromptInsightsV1Api.md create mode 100644 sdk-output/prompt_insights/docs/Models/Errormessagedto.md create mode 100644 sdk-output/prompt_insights/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1401Response.md create mode 100644 sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1429Response.md create mode 100644 sdk-output/prompt_insights/docs/Models/Index.md create mode 100644 sdk-output/prompt_insights/docs/Models/Localeorigin.md create mode 100644 sdk-output/prompt_insights/docs/Models/Promptinsight.md create mode 100644 sdk-output/prompt_insights/docs/Models/Promptinsightsmetrics.md create mode 100644 sdk-output/prompt_insights/docs/Models/README.md create mode 100644 sdk-output/public_identities/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/public_identities/docs/Methods/Index.md create mode 100644 sdk-output/public_identities/docs/Methods/PublicIdentitiesV1Api.md create mode 100644 sdk-output/public_identities/docs/Models/Dtotype.md create mode 100644 sdk-output/public_identities/docs/Models/Errormessagedto.md create mode 100644 sdk-output/public_identities/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1401Response.md create mode 100644 sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1429Response.md create mode 100644 sdk-output/public_identities/docs/Models/Identityreference.md create mode 100644 sdk-output/public_identities/docs/Models/Index.md create mode 100644 sdk-output/public_identities/docs/Models/Localeorigin.md create mode 100644 sdk-output/public_identities/docs/Models/Publicidentity.md create mode 100644 sdk-output/public_identities/docs/Models/PublicidentityAttributesInner.md create mode 100644 sdk-output/public_identities/docs/Models/README.md create mode 100644 sdk-output/public_identities_config/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/public_identities_config/docs/Methods/Index.md create mode 100644 sdk-output/public_identities_config/docs/Methods/PublicIdentitiesConfigV1Api.md create mode 100644 sdk-output/public_identities_config/docs/Models/Dtotype.md create mode 100644 sdk-output/public_identities_config/docs/Models/Errormessagedto.md create mode 100644 sdk-output/public_identities_config/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1401Response.md create mode 100644 sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1429Response.md create mode 100644 sdk-output/public_identities_config/docs/Models/Identityreference.md create mode 100644 sdk-output/public_identities_config/docs/Models/Index.md create mode 100644 sdk-output/public_identities_config/docs/Models/Localeorigin.md create mode 100644 sdk-output/public_identities_config/docs/Models/Publicidentityattributeconfig.md create mode 100644 sdk-output/public_identities_config/docs/Models/Publicidentityconfig.md create mode 100644 sdk-output/public_identities_config/docs/Models/README.md create mode 100644 sdk-output/reports_data_extraction/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/reports_data_extraction/docs/Methods/Index.md create mode 100644 sdk-output/reports_data_extraction/docs/Methods/ReportsDataExtractionV1Api.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/AccountsExportReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Errormessagedto.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/GetReportResultV1401Response.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/GetReportResultV1429Response.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/IdentitiesDetailsReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/IdentitiesReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/IdentityProfileIdentityErrorReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Index.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Localeorigin.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/OrphanIdentitiesReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/README.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Reportdetails.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/ReportdetailsArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Reportresults.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/SearchExportReportArguments.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/Taskresultdetails.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsMessagesInner.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsReturnsInner.md create mode 100644 sdk-output/reports_data_extraction/docs/Models/UncorrelatedAccountsReportArguments.md create mode 100644 sdk-output/requestable_objects/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/requestable_objects/docs/Methods/Index.md create mode 100644 sdk-output/requestable_objects/docs/Methods/RequestableObjectsV1Api.md create mode 100644 sdk-output/requestable_objects/docs/Models/Errormessagedto.md create mode 100644 sdk-output/requestable_objects/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/requestable_objects/docs/Models/Identityreferencewithnameandemail.md create mode 100644 sdk-output/requestable_objects/docs/Models/Index.md create mode 100644 sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1401Response.md create mode 100644 sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1429Response.md create mode 100644 sdk-output/requestable_objects/docs/Models/Localeorigin.md create mode 100644 sdk-output/requestable_objects/docs/Models/README.md create mode 100644 sdk-output/requestable_objects/docs/Models/Requestableobject.md create mode 100644 sdk-output/requestable_objects/docs/Models/Requestableobjectrequeststatus.md create mode 100644 sdk-output/requestable_objects/docs/Models/Requestableobjecttype.md create mode 100644 sdk-output/role_insights/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/role_insights/docs/Methods/Index.md create mode 100644 sdk-output/role_insights/docs/Methods/RoleInsightsV1Api.md create mode 100644 sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1401Response.md create mode 100644 sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1429Response.md create mode 100644 sdk-output/role_insights/docs/Models/Errormessagedto.md create mode 100644 sdk-output/role_insights/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/role_insights/docs/Models/Index.md create mode 100644 sdk-output/role_insights/docs/Models/Localeorigin.md create mode 100644 sdk-output/role_insights/docs/Models/README.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsight.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsentitlement.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsentitlementchanges.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsidentities.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsinsight.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsresponse.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightsrole.md create mode 100644 sdk-output/role_insights/docs/Models/Roleinsightssummary.md create mode 100644 sdk-output/role_propagation/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/role_propagation/docs/Methods/Index.md create mode 100644 sdk-output/role_propagation/docs/Methods/RolePropagationV1Api.md create mode 100644 sdk-output/role_propagation/docs/Models/Errormessagedto.md create mode 100644 sdk-output/role_propagation/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/role_propagation/docs/Models/Index.md create mode 100644 sdk-output/role_propagation/docs/Models/Localeorigin.md create mode 100644 sdk-output/role_propagation/docs/Models/README.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationConfigInput.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationConfigResponse.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponse.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponseRolePropagationDetails.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationResponse.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationStatusResponse.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseLaunchedBy.md create mode 100644 sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseTerminatedBy.md create mode 100644 sdk-output/role_propagation/docs/Models/StartRolePropagationV1401Response.md create mode 100644 sdk-output/role_propagation/docs/Models/StartRolePropagationV1429Response.md create mode 100644 sdk-output/roles/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/roles/docs/Methods/Index.md create mode 100644 sdk-output/roles/docs/Methods/RolesV1Api.md create mode 100644 sdk-output/roles/docs/Models/Accessduration.md create mode 100644 sdk-output/roles/docs/Models/Accessmodelmetadata.md create mode 100644 sdk-output/roles/docs/Models/AccessmodelmetadataValuesInner.md create mode 100644 sdk-output/roles/docs/Models/Accessprofileref.md create mode 100644 sdk-output/roles/docs/Models/Additionalownerref.md create mode 100644 sdk-output/roles/docs/Models/Approvalschemeforrole.md create mode 100644 sdk-output/roles/docs/Models/ArrayInner.md create mode 100644 sdk-output/roles/docs/Models/Attributedto.md create mode 100644 sdk-output/roles/docs/Models/Attributedtolist.md create mode 100644 sdk-output/roles/docs/Models/Attributevaluedto.md create mode 100644 sdk-output/roles/docs/Models/Dimensionattribute.md create mode 100644 sdk-output/roles/docs/Models/Dimensionref.md create mode 100644 sdk-output/roles/docs/Models/Dimensionschema.md create mode 100644 sdk-output/roles/docs/Models/Dtotype.md create mode 100644 sdk-output/roles/docs/Models/Entitlement.md create mode 100644 sdk-output/roles/docs/Models/EntitlementAccessModelMetadata.md create mode 100644 sdk-output/roles/docs/Models/EntitlementOwner.md create mode 100644 sdk-output/roles/docs/Models/EntitlementSource.md create mode 100644 sdk-output/roles/docs/Models/Entitlementref.md create mode 100644 sdk-output/roles/docs/Models/Errormessagedto.md create mode 100644 sdk-output/roles/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/roles/docs/Models/Index.md create mode 100644 sdk-output/roles/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/roles/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/roles/docs/Models/ListRolesV1401Response.md create mode 100644 sdk-output/roles/docs/Models/ListRolesV1429Response.md create mode 100644 sdk-output/roles/docs/Models/Localeorigin.md create mode 100644 sdk-output/roles/docs/Models/Ownerreference.md create mode 100644 sdk-output/roles/docs/Models/Permissiondto.md create mode 100644 sdk-output/roles/docs/Models/README.md create mode 100644 sdk-output/roles/docs/Models/Requestabilityforrole.md create mode 100644 sdk-output/roles/docs/Models/Revocabilityforrole.md create mode 100644 sdk-output/roles/docs/Models/Role.md create mode 100644 sdk-output/roles/docs/Models/Roleassignmentsourcetype.md create mode 100644 sdk-output/roles/docs/Models/Rolebulkdeleterequest.md create mode 100644 sdk-output/roles/docs/Models/Rolebulkupdateresponse.md create mode 100644 sdk-output/roles/docs/Models/Rolecriteriakey.md create mode 100644 sdk-output/roles/docs/Models/Rolecriteriakeytype.md create mode 100644 sdk-output/roles/docs/Models/Rolecriterialevel1.md create mode 100644 sdk-output/roles/docs/Models/Rolecriterialevel2.md create mode 100644 sdk-output/roles/docs/Models/Rolecriterialevel3.md create mode 100644 sdk-output/roles/docs/Models/Rolecriteriaoperation.md create mode 100644 sdk-output/roles/docs/Models/Rolegetallbulkupdateresponse.md create mode 100644 sdk-output/roles/docs/Models/Roleidentity.md create mode 100644 sdk-output/roles/docs/Models/Rolelistfilterdto.md create mode 100644 sdk-output/roles/docs/Models/RolelistfilterdtoAmmKeyValuesInner.md create mode 100644 sdk-output/roles/docs/Models/Rolemembershipidentity.md create mode 100644 sdk-output/roles/docs/Models/Rolemembershipselector.md create mode 100644 sdk-output/roles/docs/Models/Rolemembershipselectortype.md create mode 100644 sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyfilterrequest.md create mode 100644 sdk-output/roles/docs/Models/RolemetadatabulkupdatebyfilterrequestValuesInner.md create mode 100644 sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyidrequest.md create mode 100644 sdk-output/roles/docs/Models/RolemetadatabulkupdatebyidrequestValuesInner.md create mode 100644 sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyqueryrequest.md create mode 100644 sdk-output/roles/docs/Models/RolemetadatabulkupdatebyqueryrequestValuesInner.md create mode 100644 sdk-output/roles/docs/Models/Taskresultdto.md create mode 100644 sdk-output/saved_search/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/saved_search/docs/Methods/Index.md create mode 100644 sdk-output/saved_search/docs/Methods/SavedSearchV1Api.md create mode 100644 sdk-output/saved_search/docs/Models/Bound.md create mode 100644 sdk-output/saved_search/docs/Models/Column.md create mode 100644 sdk-output/saved_search/docs/Models/CreateSavedSearchV1Request.md create mode 100644 sdk-output/saved_search/docs/Models/Dtotype.md create mode 100644 sdk-output/saved_search/docs/Models/Errormessagedto.md create mode 100644 sdk-output/saved_search/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/saved_search/docs/Models/Filter.md create mode 100644 sdk-output/saved_search/docs/Models/Filtertype.md create mode 100644 sdk-output/saved_search/docs/Models/Index.md create mode 100644 sdk-output/saved_search/docs/Models/ListSavedSearchesV1401Response.md create mode 100644 sdk-output/saved_search/docs/Models/ListSavedSearchesV1429Response.md create mode 100644 sdk-output/saved_search/docs/Models/Localeorigin.md create mode 100644 sdk-output/saved_search/docs/Models/README.md create mode 100644 sdk-output/saved_search/docs/Models/Range.md create mode 100644 sdk-output/saved_search/docs/Models/Savedsearch.md create mode 100644 sdk-output/saved_search/docs/Models/Savedsearchdetail.md create mode 100644 sdk-output/saved_search/docs/Models/SavedsearchdetailFilters.md create mode 100644 sdk-output/saved_search/docs/Models/Savedsearchname.md create mode 100644 sdk-output/saved_search/docs/Models/Searcharguments.md create mode 100644 sdk-output/saved_search/docs/Models/Typedreference.md create mode 100644 sdk-output/scheduled_search/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/scheduled_search/docs/Methods/Index.md create mode 100644 sdk-output/scheduled_search/docs/Methods/ScheduledSearchV1Api.md create mode 100644 sdk-output/scheduled_search/docs/Models/CreateScheduledSearchV1Request.md create mode 100644 sdk-output/scheduled_search/docs/Models/Dtotype.md create mode 100644 sdk-output/scheduled_search/docs/Models/Errormessagedto.md create mode 100644 sdk-output/scheduled_search/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/scheduled_search/docs/Models/Index.md create mode 100644 sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1401Response.md create mode 100644 sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1429Response.md create mode 100644 sdk-output/scheduled_search/docs/Models/Localeorigin.md create mode 100644 sdk-output/scheduled_search/docs/Models/README.md create mode 100644 sdk-output/scheduled_search/docs/Models/Schedule.md create mode 100644 sdk-output/scheduled_search/docs/Models/ScheduleDays.md create mode 100644 sdk-output/scheduled_search/docs/Models/ScheduleHours.md create mode 100644 sdk-output/scheduled_search/docs/Models/ScheduleMonths.md create mode 100644 sdk-output/scheduled_search/docs/Models/Scheduledsearch.md create mode 100644 sdk-output/scheduled_search/docs/Models/ScheduledsearchAllOfOwner.md create mode 100644 sdk-output/scheduled_search/docs/Models/Scheduledsearchname.md create mode 100644 sdk-output/scheduled_search/docs/Models/Scheduletype.md create mode 100644 sdk-output/scheduled_search/docs/Models/Searchschedule.md create mode 100644 sdk-output/scheduled_search/docs/Models/SearchscheduleRecipientsInner.md create mode 100644 sdk-output/scheduled_search/docs/Models/Selector.md create mode 100644 sdk-output/scheduled_search/docs/Models/Selectortype.md create mode 100644 sdk-output/scheduled_search/docs/Models/Typedreference.md create mode 100644 sdk-output/search/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/search/docs/Methods/Index.md create mode 100644 sdk-output/search/docs/Methods/SearchV1Api.md create mode 100644 sdk-output/search/docs/Models/Aggregationresult.md create mode 100644 sdk-output/search/docs/Models/Aggregations.md create mode 100644 sdk-output/search/docs/Models/Aggregationtype.md create mode 100644 sdk-output/search/docs/Models/Bound.md create mode 100644 sdk-output/search/docs/Models/Bucketaggregation.md create mode 100644 sdk-output/search/docs/Models/Buckettype.md create mode 100644 sdk-output/search/docs/Models/Errormessagedto.md create mode 100644 sdk-output/search/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/search/docs/Models/Filter.md create mode 100644 sdk-output/search/docs/Models/Filteraggregation.md create mode 100644 sdk-output/search/docs/Models/Filtertype.md create mode 100644 sdk-output/search/docs/Models/Index.md create mode 100644 sdk-output/search/docs/Models/Innerhit.md create mode 100644 sdk-output/search/docs/Models/Localeorigin.md create mode 100644 sdk-output/search/docs/Models/Metricaggregation.md create mode 100644 sdk-output/search/docs/Models/Metrictype.md create mode 100644 sdk-output/search/docs/Models/Nestedaggregation.md create mode 100644 sdk-output/search/docs/Models/Query.md create mode 100644 sdk-output/search/docs/Models/Queryresultfilter.md create mode 100644 sdk-output/search/docs/Models/Querytype.md create mode 100644 sdk-output/search/docs/Models/README.md create mode 100644 sdk-output/search/docs/Models/Range.md create mode 100644 sdk-output/search/docs/Models/Search.md create mode 100644 sdk-output/search/docs/Models/SearchPostV1401Response.md create mode 100644 sdk-output/search/docs/Models/SearchPostV1429Response.md create mode 100644 sdk-output/search/docs/Models/Searchaggregationspecification.md create mode 100644 sdk-output/search/docs/Models/Searchfiltertype.md create mode 100644 sdk-output/search/docs/Models/Subsearchaggregationspecification.md create mode 100644 sdk-output/search/docs/Models/Textquery.md create mode 100644 sdk-output/search/docs/Models/Typeaheadquery.md create mode 100644 sdk-output/search_attribute_configuration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/search_attribute_configuration/docs/Methods/Index.md create mode 100644 sdk-output/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationV1Api.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/ArrayInner.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1401Response.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1429Response.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Index.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Localeorigin.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/README.md create mode 100644 sdk-output/search_attribute_configuration/docs/Models/Searchattributeconfig.md create mode 100644 sdk-output/segments/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/segments/docs/Methods/Index.md create mode 100644 sdk-output/segments/docs/Methods/SegmentsV1Api.md create mode 100644 sdk-output/segments/docs/Models/Errormessagedto.md create mode 100644 sdk-output/segments/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/segments/docs/Models/Expression.md create mode 100644 sdk-output/segments/docs/Models/ExpressionChildrenInner.md create mode 100644 sdk-output/segments/docs/Models/Index.md create mode 100644 sdk-output/segments/docs/Models/ListSegmentsV1401Response.md create mode 100644 sdk-output/segments/docs/Models/ListSegmentsV1429Response.md create mode 100644 sdk-output/segments/docs/Models/Localeorigin.md create mode 100644 sdk-output/segments/docs/Models/Ownerreferencesegments.md create mode 100644 sdk-output/segments/docs/Models/README.md create mode 100644 sdk-output/segments/docs/Models/Segment.md create mode 100644 sdk-output/segments/docs/Models/SegmentVisibilityCriteria.md create mode 100644 sdk-output/segments/docs/Models/Value.md create mode 100644 sdk-output/segments/docs/Models/Visibilitycriteria.md create mode 100644 sdk-output/service_desk_integration/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/service_desk_integration/docs/Methods/Index.md create mode 100644 sdk-output/service_desk_integration/docs/Methods/ServiceDeskIntegrationV1Api.md create mode 100644 sdk-output/service_desk_integration/docs/Models/ArrayInner.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Basecommondto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Beforeprovisioningruledto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Errormessagedto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1401Response.md create mode 100644 sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1429Response.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Index.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/service_desk_integration/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Localeorigin.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Ownerdto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Provisioningconfig.md create mode 100644 sdk-output/service_desk_integration/docs/Models/ProvisioningconfigPlanInitializerScript.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Queuedcheckconfigdetails.md create mode 100644 sdk-output/service_desk_integration/docs/Models/README.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationdto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatedto.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatetype.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Servicedesksource.md create mode 100644 sdk-output/service_desk_integration/docs/Models/Sourceclusterdto.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Methods/Index.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFV1Api.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Authorizationscheme.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamdeliveryrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryresponse.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Errormessagedto.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1401Response.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1429Response.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/GetStreamV1200Response.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Index.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Jwk.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Jwks.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Localeorigin.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/README.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Replacestreamconfigurationrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/ReplacestreamconfigurationrequestDelivery.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Streamconfigresponse.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Streamstatusresponse.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Transmittermetadata.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigresponse.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigurationrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamstatusrequest.md create mode 100644 sdk-output/shared_signals_framework_ssf/docs/Models/Verificationrequest.md create mode 100644 sdk-output/sim_integrations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/sim_integrations/docs/Methods/Index.md create mode 100644 sdk-output/sim_integrations/docs/Methods/SIMIntegrationsV1Api.md create mode 100644 sdk-output/sim_integrations/docs/Models/ArrayInner.md create mode 100644 sdk-output/sim_integrations/docs/Models/Basecommondto.md create mode 100644 sdk-output/sim_integrations/docs/Models/Beforeprovisioningruledto.md create mode 100644 sdk-output/sim_integrations/docs/Models/Dtotype.md create mode 100644 sdk-output/sim_integrations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/sim_integrations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1401Response.md create mode 100644 sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1429Response.md create mode 100644 sdk-output/sim_integrations/docs/Models/Index.md create mode 100644 sdk-output/sim_integrations/docs/Models/Jsonpatch.md create mode 100644 sdk-output/sim_integrations/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/sim_integrations/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/sim_integrations/docs/Models/Localeorigin.md create mode 100644 sdk-output/sim_integrations/docs/Models/Ownerdto.md create mode 100644 sdk-output/sim_integrations/docs/Models/Provisioningconfig.md create mode 100644 sdk-output/sim_integrations/docs/Models/ProvisioningconfigPlanInitializerScript.md create mode 100644 sdk-output/sim_integrations/docs/Models/README.md create mode 100644 sdk-output/sim_integrations/docs/Models/Servicedeskintegrationdto.md create mode 100644 sdk-output/sim_integrations/docs/Models/Servicedesksource.md create mode 100644 sdk-output/sim_integrations/docs/Models/Simintegrationdetails.md create mode 100644 sdk-output/sim_integrations/docs/Models/SimintegrationdetailsAllOfBeforeProvisioningRule.md create mode 100644 sdk-output/sim_integrations/docs/Models/Sourceclusterdto.md create mode 100644 sdk-output/sod_policies/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/sod_policies/docs/Methods/Index.md create mode 100644 sdk-output/sod_policies/docs/Methods/SODPoliciesV1Api.md create mode 100644 sdk-output/sod_policies/docs/Models/Accesscriteria.md create mode 100644 sdk-output/sod_policies/docs/Models/AccesscriteriaCriteriaListInner.md create mode 100644 sdk-output/sod_policies/docs/Models/ArrayInner.md create mode 100644 sdk-output/sod_policies/docs/Models/Conflictingaccesscriteria.md create mode 100644 sdk-output/sod_policies/docs/Models/Errormessagedto.md create mode 100644 sdk-output/sod_policies/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/sod_policies/docs/Models/Index.md create mode 100644 sdk-output/sod_policies/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/sod_policies/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/sod_policies/docs/Models/ListSodPoliciesV1401Response.md create mode 100644 sdk-output/sod_policies/docs/Models/ListSodPoliciesV1429Response.md create mode 100644 sdk-output/sod_policies/docs/Models/Localeorigin.md create mode 100644 sdk-output/sod_policies/docs/Models/Multipolicyrequest.md create mode 100644 sdk-output/sod_policies/docs/Models/README.md create mode 100644 sdk-output/sod_policies/docs/Models/Reportresultreference.md create mode 100644 sdk-output/sod_policies/docs/Models/Schedule.md create mode 100644 sdk-output/sod_policies/docs/Models/ScheduleDays.md create mode 100644 sdk-output/sod_policies/docs/Models/ScheduleHours.md create mode 100644 sdk-output/sod_policies/docs/Models/ScheduleMonths.md create mode 100644 sdk-output/sod_policies/docs/Models/Scheduletype.md create mode 100644 sdk-output/sod_policies/docs/Models/Selector.md create mode 100644 sdk-output/sod_policies/docs/Models/Selectortype.md create mode 100644 sdk-output/sod_policies/docs/Models/Sodpolicy.md create mode 100644 sdk-output/sod_policies/docs/Models/SodpolicyConflictingAccessCriteria.md create mode 100644 sdk-output/sod_policies/docs/Models/SodpolicyOwnerRef.md create mode 100644 sdk-output/sod_policies/docs/Models/Sodpolicyschedule.md create mode 100644 sdk-output/sod_policies/docs/Models/Sodrecipient.md create mode 100644 sdk-output/sod_policies/docs/Models/Sodreportresultdto.md create mode 100644 sdk-output/sod_policies/docs/Models/Violationownerassignmentconfig.md create mode 100644 sdk-output/sod_policies/docs/Models/ViolationownerassignmentconfigOwnerRef.md create mode 100644 sdk-output/sod_violations/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/sod_violations/docs/Methods/Index.md create mode 100644 sdk-output/sod_violations/docs/Methods/SODViolationsV1Api.md create mode 100644 sdk-output/sod_violations/docs/Models/Dtotype.md create mode 100644 sdk-output/sod_violations/docs/Models/Errormessagedto.md create mode 100644 sdk-output/sod_violations/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/sod_violations/docs/Models/Exceptionaccesscriteria.md create mode 100644 sdk-output/sod_violations/docs/Models/Exceptioncriteria.md create mode 100644 sdk-output/sod_violations/docs/Models/ExceptioncriteriaCriteriaListInner.md create mode 100644 sdk-output/sod_violations/docs/Models/Exceptioncriteriaaccess.md create mode 100644 sdk-output/sod_violations/docs/Models/Identitywithnewaccess.md create mode 100644 sdk-output/sod_violations/docs/Models/IdentitywithnewaccessAccessRefsInner.md create mode 100644 sdk-output/sod_violations/docs/Models/Index.md create mode 100644 sdk-output/sod_violations/docs/Models/Localeorigin.md create mode 100644 sdk-output/sod_violations/docs/Models/README.md create mode 100644 sdk-output/sod_violations/docs/Models/Sodpolicydto2.md create mode 100644 sdk-output/sod_violations/docs/Models/Sodviolationcheck.md create mode 100644 sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1401Response.md create mode 100644 sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1429Response.md create mode 100644 sdk-output/sod_violations/docs/Models/Violationcontext.md create mode 100644 sdk-output/sod_violations/docs/Models/ViolationcontextPolicy.md create mode 100644 sdk-output/sod_violations/docs/Models/Violationprediction.md create mode 100644 sdk-output/source_usages/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/source_usages/docs/Methods/Index.md create mode 100644 sdk-output/source_usages/docs/Methods/SourceUsagesV1Api.md create mode 100644 sdk-output/source_usages/docs/Models/Errormessagedto.md create mode 100644 sdk-output/source_usages/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1401Response.md create mode 100644 sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1429Response.md create mode 100644 sdk-output/source_usages/docs/Models/Index.md create mode 100644 sdk-output/source_usages/docs/Models/Localeorigin.md create mode 100644 sdk-output/source_usages/docs/Models/README.md create mode 100644 sdk-output/source_usages/docs/Models/Sourceusage.md create mode 100644 sdk-output/source_usages/docs/Models/Sourceusagestatus.md create mode 100644 sdk-output/sources/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/sources/docs/Methods/Index.md create mode 100644 sdk-output/sources/docs/Methods/SourcesV1Api.md create mode 100644 sdk-output/sources/docs/Models/Accountdeleteconfigdto.md create mode 100644 sdk-output/sources/docs/Models/Approvalconfig.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigCronTimezone.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigEscalationConfig.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigFallbackApprover.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigReminderConfig.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigSerialChainInner.md create mode 100644 sdk-output/sources/docs/Models/ApprovalconfigTimeoutConfig.md create mode 100644 sdk-output/sources/docs/Models/ArrayInner.md create mode 100644 sdk-output/sources/docs/Models/Attributedefinition.md create mode 100644 sdk-output/sources/docs/Models/AttributedefinitionSchema.md create mode 100644 sdk-output/sources/docs/Models/Attributedefinitiontype.md create mode 100644 sdk-output/sources/docs/Models/Attrsyncsource.md create mode 100644 sdk-output/sources/docs/Models/Attrsyncsourceattributeconfig.md create mode 100644 sdk-output/sources/docs/Models/Attrsyncsourceconfig.md create mode 100644 sdk-output/sources/docs/Models/Basereferencedto.md create mode 100644 sdk-output/sources/docs/Models/Connectordetail.md create mode 100644 sdk-output/sources/docs/Models/Correlationconfig.md create mode 100644 sdk-output/sources/docs/Models/CorrelationconfigAttributeAssignmentsInner.md create mode 100644 sdk-output/sources/docs/Models/DeleteSourceV1202Response.md create mode 100644 sdk-output/sources/docs/Models/Dependantappconnections.md create mode 100644 sdk-output/sources/docs/Models/DependantappconnectionsAccountSource.md create mode 100644 sdk-output/sources/docs/Models/DependantappconnectionsAccountSourcePasswordPoliciesInner.md create mode 100644 sdk-output/sources/docs/Models/Dependantconnectionsmissingdto.md create mode 100644 sdk-output/sources/docs/Models/Dtotype.md create mode 100644 sdk-output/sources/docs/Models/Entitlementaccessrequestconfig.md create mode 100644 sdk-output/sources/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md create mode 100644 sdk-output/sources/docs/Models/Entitlementapprovalscheme.md create mode 100644 sdk-output/sources/docs/Models/Entitlementrevocationrequestconfig.md create mode 100644 sdk-output/sources/docs/Models/Errormessagedto.md create mode 100644 sdk-output/sources/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/sources/docs/Models/Fielddetailsdto.md create mode 100644 sdk-output/sources/docs/Models/Identityprofilesconnections.md create mode 100644 sdk-output/sources/docs/Models/ImportAccountsSchemaV1Request.md create mode 100644 sdk-output/sources/docs/Models/ImportAccountsV1Request.md create mode 100644 sdk-output/sources/docs/Models/ImportEntitlementsV1Request.md create mode 100644 sdk-output/sources/docs/Models/Index.md create mode 100644 sdk-output/sources/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/sources/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/sources/docs/Models/ListSourcesV1401Response.md create mode 100644 sdk-output/sources/docs/Models/ListSourcesV1429Response.md create mode 100644 sdk-output/sources/docs/Models/Loadaccountstask.md create mode 100644 sdk-output/sources/docs/Models/LoadaccountstaskTask.md create mode 100644 sdk-output/sources/docs/Models/LoadaccountstaskTaskAttributes.md create mode 100644 sdk-output/sources/docs/Models/LoadaccountstaskTaskMessagesInner.md create mode 100644 sdk-output/sources/docs/Models/LoadaccountstaskTaskReturnsInner.md create mode 100644 sdk-output/sources/docs/Models/Loadentitlementtask.md create mode 100644 sdk-output/sources/docs/Models/LoadentitlementtaskReturnsInner.md create mode 100644 sdk-output/sources/docs/Models/Loaduncorrelatedaccountstask.md create mode 100644 sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTask.md create mode 100644 sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskAttributes.md create mode 100644 sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskMessagesInner.md create mode 100644 sdk-output/sources/docs/Models/Localeorigin.md create mode 100644 sdk-output/sources/docs/Models/Managercorrelationmapping.md create mode 100644 sdk-output/sources/docs/Models/Nativechangedetectionconfig.md create mode 100644 sdk-output/sources/docs/Models/PasswordpolicyholdersdtoInner.md create mode 100644 sdk-output/sources/docs/Models/Passwordpolicyholdersdtoattributes.md create mode 100644 sdk-output/sources/docs/Models/PasswordpolicyholdersdtoattributesIdentityAttrInner.md create mode 100644 sdk-output/sources/docs/Models/Provisioningpolicydto.md create mode 100644 sdk-output/sources/docs/Models/README.md create mode 100644 sdk-output/sources/docs/Models/Resourceobject.md create mode 100644 sdk-output/sources/docs/Models/Resourceobjectsrequest.md create mode 100644 sdk-output/sources/docs/Models/Resourceobjectsresponse.md create mode 100644 sdk-output/sources/docs/Models/Schedule3.md create mode 100644 sdk-output/sources/docs/Models/Schema.md create mode 100644 sdk-output/sources/docs/Models/Source.md create mode 100644 sdk-output/sources/docs/Models/SourceAccountCorrelationConfig.md create mode 100644 sdk-output/sources/docs/Models/SourceAccountCorrelationRule.md create mode 100644 sdk-output/sources/docs/Models/SourceBeforeProvisioningRule.md create mode 100644 sdk-output/sources/docs/Models/SourceCluster.md create mode 100644 sdk-output/sources/docs/Models/SourceManagementWorkgroup.md create mode 100644 sdk-output/sources/docs/Models/SourceManagerCorrelationMapping.md create mode 100644 sdk-output/sources/docs/Models/SourceManagerCorrelationRule.md create mode 100644 sdk-output/sources/docs/Models/SourceOwner.md create mode 100644 sdk-output/sources/docs/Models/SourcePasswordPoliciesInner.md create mode 100644 sdk-output/sources/docs/Models/SourceSchemasInner.md create mode 100644 sdk-output/sources/docs/Models/Sourceconnectionsdto.md create mode 100644 sdk-output/sources/docs/Models/Sourceentitlementrequestconfig.md create mode 100644 sdk-output/sources/docs/Models/Sourcehealthdto.md create mode 100644 sdk-output/sources/docs/Models/Sourcesyncjob.md create mode 100644 sdk-output/sources/docs/Models/Sourcesyncpayload.md create mode 100644 sdk-output/sources/docs/Models/Statusresponse.md create mode 100644 sdk-output/sources/docs/Models/Taskresultdto.md create mode 100644 sdk-output/sources/docs/Models/Transform.md create mode 100644 sdk-output/sources/docs/Models/Transformread.md create mode 100644 sdk-output/sources/docs/Models/Usagetype.md create mode 100644 sdk-output/sp_config/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/sp_config/docs/Methods/Index.md create mode 100644 sdk-output/sp_config/docs/Methods/SPConfigV1Api.md create mode 100644 sdk-output/sp_config/docs/Models/Configobject.md create mode 100644 sdk-output/sp_config/docs/Models/Errormessagedto.md create mode 100644 sdk-output/sp_config/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/sp_config/docs/Models/ExportSpConfigV1401Response.md create mode 100644 sdk-output/sp_config/docs/Models/ExportSpConfigV1429Response.md create mode 100644 sdk-output/sp_config/docs/Models/Exportoptions.md create mode 100644 sdk-output/sp_config/docs/Models/Exportpayload.md create mode 100644 sdk-output/sp_config/docs/Models/ImportSpConfigV1Request.md create mode 100644 sdk-output/sp_config/docs/Models/Importobject.md create mode 100644 sdk-output/sp_config/docs/Models/Importoptions.md create mode 100644 sdk-output/sp_config/docs/Models/Index.md create mode 100644 sdk-output/sp_config/docs/Models/Localeorigin.md create mode 100644 sdk-output/sp_config/docs/Models/Objectexportimportoptions.md create mode 100644 sdk-output/sp_config/docs/Models/Objectimportresult2.md create mode 100644 sdk-output/sp_config/docs/Models/README.md create mode 100644 sdk-output/sp_config/docs/Models/Selfimportexportdto.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigexportjob.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigexportjobstatus.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigexportresults.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigimportjobstatus.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigimportresults.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigjob.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigmessage2.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigobject.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigrule.md create mode 100644 sdk-output/sp_config/docs/Models/SpconfigruleValue.md create mode 100644 sdk-output/sp_config/docs/Models/Spconfigrules.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/suggested_entitlement_description/docs/Methods/Index.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionV1Api.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/ArrayInner.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Autowritesetting.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingpatch.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/AutowritesettingpatchValue.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingresponse.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationitem.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationrequest.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationresult.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/CreateAutoWriteSettingsV1409Response.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignee.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf1.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignrequest.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignresult.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationrecord.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Errormessagedto.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1401Response.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1429Response.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Index.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Localeorigin.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationgroup.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationinstance.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/README.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Searchcriteria.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValue.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRange.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeLower.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeUpper.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaQuery.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaTextQuery.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sed.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedapproval.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedapprovalstatus.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedassignee.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedassignment.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedassignmentresponse.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrecord.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrequest.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedbatchresponse.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedbatchstats.md create mode 100644 sdk-output/suggested_entitlement_description/docs/Models/Sedpatch.md create mode 100644 sdk-output/tagged_objects/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/tagged_objects/docs/Methods/Index.md create mode 100644 sdk-output/tagged_objects/docs/Methods/TaggedObjectsV1Api.md create mode 100644 sdk-output/tagged_objects/docs/Models/Bulkaddtaggedobject.md create mode 100644 sdk-output/tagged_objects/docs/Models/Bulkremovetaggedobject.md create mode 100644 sdk-output/tagged_objects/docs/Models/Bulktaggedobjectresponse.md create mode 100644 sdk-output/tagged_objects/docs/Models/Errormessagedto.md create mode 100644 sdk-output/tagged_objects/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/tagged_objects/docs/Models/Index.md create mode 100644 sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1401Response.md create mode 100644 sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1429Response.md create mode 100644 sdk-output/tagged_objects/docs/Models/Localeorigin.md create mode 100644 sdk-output/tagged_objects/docs/Models/README.md create mode 100644 sdk-output/tagged_objects/docs/Models/Taggedobject.md create mode 100644 sdk-output/tagged_objects/docs/Models/Taggedobjectdto.md create mode 100644 sdk-output/tags/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/tags/docs/Methods/Index.md create mode 100644 sdk-output/tags/docs/Methods/TagsV1Api.md create mode 100644 sdk-output/tags/docs/Models/Errormessagedto.md create mode 100644 sdk-output/tags/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/tags/docs/Models/Index.md create mode 100644 sdk-output/tags/docs/Models/ListTagsV1401Response.md create mode 100644 sdk-output/tags/docs/Models/ListTagsV1429Response.md create mode 100644 sdk-output/tags/docs/Models/Localeorigin.md create mode 100644 sdk-output/tags/docs/Models/README.md create mode 100644 sdk-output/tags/docs/Models/Tag2.md create mode 100644 sdk-output/tags/docs/Models/Tag2TagCategoryRefsInner.md create mode 100644 sdk-output/task_management/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/task_management/docs/Methods/Index.md create mode 100644 sdk-output/task_management/docs/Methods/TaskManagementV1Api.md create mode 100644 sdk-output/task_management/docs/Models/ArrayInner.md create mode 100644 sdk-output/task_management/docs/Models/Errormessagedto.md create mode 100644 sdk-output/task_management/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/task_management/docs/Models/GetTaskStatusV1401Response.md create mode 100644 sdk-output/task_management/docs/Models/GetTaskStatusV1429Response.md create mode 100644 sdk-output/task_management/docs/Models/Index.md create mode 100644 sdk-output/task_management/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/task_management/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/task_management/docs/Models/Localeorigin.md create mode 100644 sdk-output/task_management/docs/Models/Localizedmessage.md create mode 100644 sdk-output/task_management/docs/Models/README.md create mode 100644 sdk-output/task_management/docs/Models/Target.md create mode 100644 sdk-output/task_management/docs/Models/Taskdefinitionsummary.md create mode 100644 sdk-output/task_management/docs/Models/Taskreturndetails.md create mode 100644 sdk-output/task_management/docs/Models/Taskstatus.md create mode 100644 sdk-output/task_management/docs/Models/Taskstatusmessage.md create mode 100644 sdk-output/task_management/docs/Models/TaskstatusmessageParametersInner.md create mode 100644 sdk-output/tenant/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/tenant/docs/Methods/Index.md create mode 100644 sdk-output/tenant/docs/Methods/TenantV1Api.md create mode 100644 sdk-output/tenant/docs/Models/Errormessagedto.md create mode 100644 sdk-output/tenant/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/tenant/docs/Models/GetTenantV1401Response.md create mode 100644 sdk-output/tenant/docs/Models/GetTenantV1429Response.md create mode 100644 sdk-output/tenant/docs/Models/Index.md create mode 100644 sdk-output/tenant/docs/Models/License.md create mode 100644 sdk-output/tenant/docs/Models/Localeorigin.md create mode 100644 sdk-output/tenant/docs/Models/Product.md create mode 100644 sdk-output/tenant/docs/Models/README.md create mode 100644 sdk-output/tenant/docs/Models/Tenant.md create mode 100644 sdk-output/tenant_context/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/tenant_context/docs/Methods/Index.md create mode 100644 sdk-output/tenant_context/docs/Methods/TenantContextV1Api.md create mode 100644 sdk-output/tenant_context/docs/Models/ArrayInner.md create mode 100644 sdk-output/tenant_context/docs/Models/Errormessagedto.md create mode 100644 sdk-output/tenant_context/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/tenant_context/docs/Models/GetTenantContextV1200ResponseInner.md create mode 100644 sdk-output/tenant_context/docs/Models/GetTenantContextV1401Response.md create mode 100644 sdk-output/tenant_context/docs/Models/GetTenantContextV1429Response.md create mode 100644 sdk-output/tenant_context/docs/Models/Index.md create mode 100644 sdk-output/tenant_context/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/tenant_context/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/tenant_context/docs/Models/Localeorigin.md create mode 100644 sdk-output/tenant_context/docs/Models/README.md create mode 100644 sdk-output/transforms/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/transforms/docs/Methods/Index.md create mode 100644 sdk-output/transforms/docs/Methods/TransformsV1Api.md create mode 100644 sdk-output/transforms/docs/Models/Errormessagedto.md create mode 100644 sdk-output/transforms/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/transforms/docs/Models/Index.md create mode 100644 sdk-output/transforms/docs/Models/ListTransformsV1401Response.md create mode 100644 sdk-output/transforms/docs/Models/ListTransformsV1429Response.md create mode 100644 sdk-output/transforms/docs/Models/Localeorigin.md create mode 100644 sdk-output/transforms/docs/Models/README.md create mode 100644 sdk-output/transforms/docs/Models/Transform.md create mode 100644 sdk-output/transforms/docs/Models/Transformread.md create mode 100644 sdk-output/triggers/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/triggers/docs/Methods/Index.md create mode 100644 sdk-output/triggers/docs/Methods/TriggersV1Api.md create mode 100644 sdk-output/triggers/docs/Models/Accessitemapproverdto.md create mode 100644 sdk-output/triggers/docs/Models/Accessitemrequestedfordto.md create mode 100644 sdk-output/triggers/docs/Models/Accessitemrequesterdto.md create mode 100644 sdk-output/triggers/docs/Models/Accessrequestdynamicapprover.md create mode 100644 sdk-output/triggers/docs/Models/Accessrequestdynamicapprover2.md create mode 100644 sdk-output/triggers/docs/Models/AccessrequestdynamicapproverRequestedItemsInner.md create mode 100644 sdk-output/triggers/docs/Models/Accessrequestpostapproval.md create mode 100644 sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInner.md create mode 100644 sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInner.md create mode 100644 sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md create mode 100644 sdk-output/triggers/docs/Models/Accessrequestpreapproval.md create mode 100644 sdk-output/triggers/docs/Models/Accessrequestpreapproval2.md create mode 100644 sdk-output/triggers/docs/Models/AccessrequestpreapprovalRequestedItemsInner.md create mode 100644 sdk-output/triggers/docs/Models/Accountaggregationcompleted.md create mode 100644 sdk-output/triggers/docs/Models/AccountaggregationcompletedSource.md create mode 100644 sdk-output/triggers/docs/Models/AccountaggregationcompletedStats.md create mode 100644 sdk-output/triggers/docs/Models/Accountattributeschanged.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedAccount.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerNewValue.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerOldValue.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/AccountattributeschangedSource.md create mode 100644 sdk-output/triggers/docs/Models/Accountcorrelated.md create mode 100644 sdk-output/triggers/docs/Models/AccountcorrelatedAccount.md create mode 100644 sdk-output/triggers/docs/Models/AccountcorrelatedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/AccountcorrelatedSource.md create mode 100644 sdk-output/triggers/docs/Models/Accountcreated.md create mode 100644 sdk-output/triggers/docs/Models/AccountcreatedEvent.md create mode 100644 sdk-output/triggers/docs/Models/Accountdeleted.md create mode 100644 sdk-output/triggers/docs/Models/AccountdeletedEvent.md create mode 100644 sdk-output/triggers/docs/Models/Accountscollectedforaggregation.md create mode 100644 sdk-output/triggers/docs/Models/AccountscollectedforaggregationSource.md create mode 100644 sdk-output/triggers/docs/Models/AccountscollectedforaggregationStats.md create mode 100644 sdk-output/triggers/docs/Models/Accountsourcereference.md create mode 100644 sdk-output/triggers/docs/Models/AccountsourcereferenceGovernanceGroup.md create mode 100644 sdk-output/triggers/docs/Models/AccountsourcereferenceOwner.md create mode 100644 sdk-output/triggers/docs/Models/Accountuncorrelated.md create mode 100644 sdk-output/triggers/docs/Models/AccountuncorrelatedAccount.md create mode 100644 sdk-output/triggers/docs/Models/AccountuncorrelatedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/AccountuncorrelatedSource.md create mode 100644 sdk-output/triggers/docs/Models/Accountupdated.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInnerOwner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedEvent.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInnerAddedValuesInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerNewValue.md create mode 100644 sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerOldValue.md create mode 100644 sdk-output/triggers/docs/Models/Accountv2.md create mode 100644 sdk-output/triggers/docs/Models/Basicauthconfig.md create mode 100644 sdk-output/triggers/docs/Models/Bearertokenauthconfig.md create mode 100644 sdk-output/triggers/docs/Models/Campaignactivated.md create mode 100644 sdk-output/triggers/docs/Models/CampaignactivatedCampaign.md create mode 100644 sdk-output/triggers/docs/Models/CampaignactivatedCampaignCampaignOwner.md create mode 100644 sdk-output/triggers/docs/Models/Campaignended.md create mode 100644 sdk-output/triggers/docs/Models/CampaignendedCampaign.md create mode 100644 sdk-output/triggers/docs/Models/Campaigngenerated.md create mode 100644 sdk-output/triggers/docs/Models/CampaigngeneratedCampaign.md create mode 100644 sdk-output/triggers/docs/Models/CampaigngeneratedCampaignCampaignOwner.md create mode 100644 sdk-output/triggers/docs/Models/Campaignreference.md create mode 100644 sdk-output/triggers/docs/Models/Certificationdto.md create mode 100644 sdk-output/triggers/docs/Models/Certificationphase.md create mode 100644 sdk-output/triggers/docs/Models/Certificationreference.md create mode 100644 sdk-output/triggers/docs/Models/Certificationsignedoff.md create mode 100644 sdk-output/triggers/docs/Models/CertificationsignedoffCertification.md create mode 100644 sdk-output/triggers/docs/Models/Completeinvocation.md create mode 100644 sdk-output/triggers/docs/Models/Completeinvocationinput.md create mode 100644 sdk-output/triggers/docs/Models/Errormessagedto.md create mode 100644 sdk-output/triggers/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/triggers/docs/Models/Eventbridgeconfig.md create mode 100644 sdk-output/triggers/docs/Models/Httpauthenticationtype.md create mode 100644 sdk-output/triggers/docs/Models/Httpconfig.md create mode 100644 sdk-output/triggers/docs/Models/Httpdispatchmode.md create mode 100644 sdk-output/triggers/docs/Models/Identityattributeschanged.md create mode 100644 sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerNewValue.md create mode 100644 sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValue.md create mode 100644 sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValueOneOfValue.md create mode 100644 sdk-output/triggers/docs/Models/IdentityattributeschangedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Identitycreated.md create mode 100644 sdk-output/triggers/docs/Models/IdentitycreatedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Identitydeleted.md create mode 100644 sdk-output/triggers/docs/Models/IdentitydeletedIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Identityreference2.md create mode 100644 sdk-output/triggers/docs/Models/Index.md create mode 100644 sdk-output/triggers/docs/Models/Invocation.md create mode 100644 sdk-output/triggers/docs/Models/Invocationstatus.md create mode 100644 sdk-output/triggers/docs/Models/Invocationstatustype.md create mode 100644 sdk-output/triggers/docs/Models/ListTriggersV1401Response.md create mode 100644 sdk-output/triggers/docs/Models/ListTriggersV1429Response.md create mode 100644 sdk-output/triggers/docs/Models/Localeorigin.md create mode 100644 sdk-output/triggers/docs/Models/Localizedmessage.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentitycreated.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentitycreatedMachineIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentitydeleted.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentitydeletedMachineIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentityownerreference.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentitysourcereference.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentityupdated.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedMachineIdentity.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedOwnerChanges.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInner.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerNewValue.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerOldValue.md create mode 100644 sdk-output/triggers/docs/Models/MachineidentityupdatedUserEntitlementChanges.md create mode 100644 sdk-output/triggers/docs/Models/Machineidentityuserentitlements.md create mode 100644 sdk-output/triggers/docs/Models/Provisioningcompleted.md create mode 100644 sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInner.md create mode 100644 sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerAttributeRequestsInner.md create mode 100644 sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerSource.md create mode 100644 sdk-output/triggers/docs/Models/ProvisioningcompletedRecipient.md create mode 100644 sdk-output/triggers/docs/Models/ProvisioningcompletedRequester.md create mode 100644 sdk-output/triggers/docs/Models/README.md create mode 100644 sdk-output/triggers/docs/Models/Reassignment.md create mode 100644 sdk-output/triggers/docs/Models/Reviewer.md create mode 100644 sdk-output/triggers/docs/Models/Savedsearchcomplete.md create mode 100644 sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResults.md create mode 100644 sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsAccount.md create mode 100644 sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsEntitlement.md create mode 100644 sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsIdentity.md create mode 100644 sdk-output/triggers/docs/Models/Sourceaccountcreated.md create mode 100644 sdk-output/triggers/docs/Models/Sourceaccountdeleted.md create mode 100644 sdk-output/triggers/docs/Models/Sourceaccountupdated.md create mode 100644 sdk-output/triggers/docs/Models/Sourcecreated.md create mode 100644 sdk-output/triggers/docs/Models/SourcecreatedActor.md create mode 100644 sdk-output/triggers/docs/Models/Sourcedeleted.md create mode 100644 sdk-output/triggers/docs/Models/SourcedeletedActor.md create mode 100644 sdk-output/triggers/docs/Models/Sourceupdated.md create mode 100644 sdk-output/triggers/docs/Models/SourceupdatedActor.md create mode 100644 sdk-output/triggers/docs/Models/Startinvocationinput.md create mode 100644 sdk-output/triggers/docs/Models/Subscription.md create mode 100644 sdk-output/triggers/docs/Models/SubscriptionpatchrequestInner.md create mode 100644 sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValue.md create mode 100644 sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValueAnyOfInner.md create mode 100644 sdk-output/triggers/docs/Models/Subscriptionpostrequest.md create mode 100644 sdk-output/triggers/docs/Models/Subscriptionputrequest.md create mode 100644 sdk-output/triggers/docs/Models/Subscriptiontype.md create mode 100644 sdk-output/triggers/docs/Models/Testinvocation.md create mode 100644 sdk-output/triggers/docs/Models/Trigger.md create mode 100644 sdk-output/triggers/docs/Models/TriggerExampleInput.md create mode 100644 sdk-output/triggers/docs/Models/TriggerExampleOutput.md create mode 100644 sdk-output/triggers/docs/Models/Triggertype.md create mode 100644 sdk-output/triggers/docs/Models/Vaclusterstatuschangeevent.md create mode 100644 sdk-output/triggers/docs/Models/VaclusterstatuschangeeventApplication.md create mode 100644 sdk-output/triggers/docs/Models/VaclusterstatuschangeeventHealthCheckResult.md create mode 100644 sdk-output/triggers/docs/Models/VaclusterstatuschangeeventPreviousHealthCheckResult.md create mode 100644 sdk-output/triggers/docs/Models/Validatefilterinputdto.md create mode 100644 sdk-output/triggers/docs/Models/Validatefilteroutputdto.md create mode 100644 sdk-output/ui_metadata/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/ui_metadata/docs/Methods/Index.md create mode 100644 sdk-output/ui_metadata/docs/Methods/UIMetadataV1Api.md create mode 100644 sdk-output/ui_metadata/docs/Models/Errormessagedto.md create mode 100644 sdk-output/ui_metadata/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1401Response.md create mode 100644 sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1429Response.md create mode 100644 sdk-output/ui_metadata/docs/Models/Index.md create mode 100644 sdk-output/ui_metadata/docs/Models/Localeorigin.md create mode 100644 sdk-output/ui_metadata/docs/Models/README.md create mode 100644 sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemresponse.md create mode 100644 sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemupdaterequest.md create mode 100644 sdk-output/work_items/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/work_items/docs/Methods/Index.md create mode 100644 sdk-output/work_items/docs/Methods/WorkItemsV1Api.md create mode 100644 sdk-output/work_items/docs/Models/Approvalitemdetails.md create mode 100644 sdk-output/work_items/docs/Models/Errormessagedto.md create mode 100644 sdk-output/work_items/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/work_items/docs/Models/Formdetails.md create mode 100644 sdk-output/work_items/docs/Models/Formitemdetails.md create mode 100644 sdk-output/work_items/docs/Models/Index.md create mode 100644 sdk-output/work_items/docs/Models/ListWorkItemsV1401Response.md create mode 100644 sdk-output/work_items/docs/Models/ListWorkItemsV1429Response.md create mode 100644 sdk-output/work_items/docs/Models/Localeorigin.md create mode 100644 sdk-output/work_items/docs/Models/README.md create mode 100644 sdk-output/work_items/docs/Models/Remediationitemdetails.md create mode 100644 sdk-output/work_items/docs/Models/Sectiondetails.md create mode 100644 sdk-output/work_items/docs/Models/Workitemforward.md create mode 100644 sdk-output/work_items/docs/Models/Workitems.md create mode 100644 sdk-output/work_items/docs/Models/WorkitemsForm.md create mode 100644 sdk-output/work_items/docs/Models/Workitemscount.md create mode 100644 sdk-output/work_items/docs/Models/Workitemssummary.md create mode 100644 sdk-output/work_items/docs/Models/Workitemstate.md create mode 100644 sdk-output/work_items/docs/Models/Workitemstatemanualworkitems.md create mode 100644 sdk-output/work_items/docs/Models/Workitemtypemanualworkitems.md create mode 100644 sdk-output/work_reassignment/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/work_reassignment/docs/Methods/Index.md create mode 100644 sdk-output/work_reassignment/docs/Methods/WorkReassignmentV1Api.md create mode 100644 sdk-output/work_reassignment/docs/Models/Auditdetails.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configtype.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configtypeenum.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configtypeenumcamel.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configurationdetailsresponse.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configurationitemrequest.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configurationitemresponse.md create mode 100644 sdk-output/work_reassignment/docs/Models/Configurationresponse.md create mode 100644 sdk-output/work_reassignment/docs/Models/Errormessagedto.md create mode 100644 sdk-output/work_reassignment/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/work_reassignment/docs/Models/Evaluateresponse.md create mode 100644 sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1401Response.md create mode 100644 sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1429Response.md create mode 100644 sdk-output/work_reassignment/docs/Models/Identity2.md create mode 100644 sdk-output/work_reassignment/docs/Models/Index.md create mode 100644 sdk-output/work_reassignment/docs/Models/Localeorigin.md create mode 100644 sdk-output/work_reassignment/docs/Models/Lookupstep.md create mode 100644 sdk-output/work_reassignment/docs/Models/README.md create mode 100644 sdk-output/work_reassignment/docs/Models/Reassignmenttypeenum.md create mode 100644 sdk-output/work_reassignment/docs/Models/Tenantconfigurationdetails.md create mode 100644 sdk-output/work_reassignment/docs/Models/Tenantconfigurationrequest.md create mode 100644 sdk-output/work_reassignment/docs/Models/Tenantconfigurationresponse.md create mode 100644 sdk-output/workflows/docs/Examples/typescript_code_examples_overlay.yaml create mode 100644 sdk-output/workflows/docs/Methods/Index.md create mode 100644 sdk-output/workflows/docs/Methods/WorkflowsV1Api.md create mode 100644 sdk-output/workflows/docs/Models/ArrayInner.md create mode 100644 sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1200Response.md create mode 100644 sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1Request.md create mode 100644 sdk-output/workflows/docs/Models/CreateWorkflowV1Request.md create mode 100644 sdk-output/workflows/docs/Models/Errormessagedto.md create mode 100644 sdk-output/workflows/docs/Models/Errorresponsedto.md create mode 100644 sdk-output/workflows/docs/Models/Index.md create mode 100644 sdk-output/workflows/docs/Models/Jsonpatchoperation.md create mode 100644 sdk-output/workflows/docs/Models/JsonpatchoperationValue.md create mode 100644 sdk-output/workflows/docs/Models/ListCompleteWorkflowLibraryV1200ResponseInner.md create mode 100644 sdk-output/workflows/docs/Models/ListWorkflowsV1401Response.md create mode 100644 sdk-output/workflows/docs/Models/ListWorkflowsV1429Response.md create mode 100644 sdk-output/workflows/docs/Models/Localeorigin.md create mode 100644 sdk-output/workflows/docs/Models/README.md create mode 100644 sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1200Response.md create mode 100644 sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1Request.md create mode 100644 sdk-output/workflows/docs/Models/TestWorkflowV1200Response.md create mode 100644 sdk-output/workflows/docs/Models/TestWorkflowV1Request.md create mode 100644 sdk-output/workflows/docs/Models/Workflow.md create mode 100644 sdk-output/workflows/docs/Models/WorkflowAllOfCreator.md create mode 100644 sdk-output/workflows/docs/Models/Workflowbody.md create mode 100644 sdk-output/workflows/docs/Models/WorkflowbodyOwner.md create mode 100644 sdk-output/workflows/docs/Models/Workflowdefinition.md create mode 100644 sdk-output/workflows/docs/Models/Workflowexecution.md create mode 100644 sdk-output/workflows/docs/Models/Workflowexecutionevent.md create mode 100644 sdk-output/workflows/docs/Models/Workflowexecutionhistory.md create mode 100644 sdk-output/workflows/docs/Models/Workflowlibraryaction.md create mode 100644 sdk-output/workflows/docs/Models/WorkflowlibraryactionExampleOutput.md create mode 100644 sdk-output/workflows/docs/Models/Workflowlibraryformfields.md create mode 100644 sdk-output/workflows/docs/Models/Workflowlibraryoperator.md create mode 100644 sdk-output/workflows/docs/Models/Workflowlibrarytrigger.md create mode 100644 sdk-output/workflows/docs/Models/Workflowmodifiedby.md create mode 100644 sdk-output/workflows/docs/Models/Workflowoauthclient.md create mode 100644 sdk-output/workflows/docs/Models/Workflowtrigger.md create mode 100644 sdk-resources/resources/api_doc.mustache create mode 100644 sdk-resources/resources/developerSite_code_examples.mustache create mode 100644 sdk-resources/resources/docs_methods_index.mustache create mode 100644 sdk-resources/resources/docs_models_index.mustache create mode 100644 sdk-resources/resources/model_doc.mustache diff --git a/sdk-output/access_model_metadata/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/access_model_metadata/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bde8a803 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,175 @@ +- path: /access-model-metadata/v1/attributes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#create-access-model-metadata-attribute-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const attributedtoV1: AttributedtoV1 = ; // AttributedtoV1 | Attribute to create + const result = await apiInstance.createAccessModelMetadataAttributeV1(attributedtoV1); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key}/values + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#create-access-model-metadata-attribute-value-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const attributevaluedtoV1: AttributevaluedtoV1 = ; // AttributevaluedtoV1 | Attribute value to create + const result = await apiInstance.createAccessModelMetadataAttributeValueV1(key, attributevaluedtoV1); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#get-access-model-metadata-attribute-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const result = await apiInstance.getAccessModelMetadataAttributeV1(key); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#get-access-model-metadata-attribute-value-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const value: string = 'public'; // string | Technical name of the Attribute value. (default to undefined) + const result = await apiInstance.getAccessModelMetadataAttributeValueV1(key, value); + console.log(result); +- path: /access-model-metadata/v1/attributes + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#list-access-model-metadata-attribute-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const filters: string = 'name eq "Privacy"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* (optional) (default to undefined) + const sorters: string = 'name,-key'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listAccessModelMetadataAttributeV1(); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key}/values + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#list-access-model-metadata-attribute-value-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listAccessModelMetadataAttributeValueV1(key); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#update-access-model-metadata-attribute-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | JSON Patch array to apply + const result = await apiInstance.updateAccessModelMetadataAttributeV1(key, jsonpatchoperationV1); + console.log(result); +- path: /access-model-metadata/v1/attributes/{key}/values/{value} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#update-access-model-metadata-attribute-value-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const key: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const value: string = 'public'; // string | Technical name of the Attribute value. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | JSON Patch array to apply + const result = await apiInstance.updateAccessModelMetadataAttributeValueV1(key, value, jsonpatchoperationV1); + console.log(result); +- path: /access-model-metadata/v1/bulk-update/filter + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#update-access-model-metadata-by-filter-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const entitlementattributebulkupdatefilterrequestV1: EntitlementattributebulkupdatefilterrequestV1 = ; // EntitlementattributebulkupdatefilterrequestV1 | Attribute metadata bulk update request body. + const result = await apiInstance.updateAccessModelMetadataByFilterV1(entitlementattributebulkupdatefilterrequestV1); + console.log(result); +- path: /access-model-metadata/v1/bulk-update/ids + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#update-access-model-metadata-by-ids-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const entitlementattributebulkupdateidsrequestV1: EntitlementattributebulkupdateidsrequestV1 = ; // EntitlementattributebulkupdateidsrequestV1 | Attribute metadata bulk update request body. + const result = await apiInstance.updateAccessModelMetadataByIdsV1(entitlementattributebulkupdateidsrequestV1); + console.log(result); +- path: /access-model-metadata/v1/bulk-update/query + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_model_metadata/methods/access-model-metadata#update-access-model-metadata-by-query-v1 + source: | + import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessModelMetadataV1Api(configuration); + const entitlementattributebulkupdatequeryrequestV1: EntitlementattributebulkupdatequeryrequestV1 = ; // EntitlementattributebulkupdatequeryrequestV1 | Attribute metadata bulk update request body. + const result = await apiInstance.updateAccessModelMetadataByQueryV1(entitlementattributebulkupdatequeryrequestV1); + console.log(result); diff --git a/sdk-output/access_model_metadata/docs/Methods/AccessModelMetadataV1Api.md b/sdk-output/access_model_metadata/docs/Methods/AccessModelMetadataV1Api.md new file mode 100644 index 00000000..19c4a3c3 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Methods/AccessModelMetadataV1Api.md @@ -0,0 +1,493 @@ +--- +id: v1-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessModelMetadata', 'v1AccessModelMetadata'] +slug: /tools/sdk/typescript/access_model_metadata/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'v1AccessModelMetadata'] +--- + +# AccessModelMetadataV1Api + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-attribute-v1**](#create-access-model-metadata-attribute-v1) | **POST** `/access-model-metadata/v1/attributes` | Create access model metadata attribute +[**create-access-model-metadata-attribute-value-v1**](#create-access-model-metadata-attribute-value-v1) | **POST** `/access-model-metadata/v1/attributes/{key}/values` | Create access model metadata value +[**get-access-model-metadata-attribute-v1**](#get-access-model-metadata-attribute-v1) | **GET** `/access-model-metadata/v1/attributes/{key}` | Get access model metadata attribute +[**get-access-model-metadata-attribute-value-v1**](#get-access-model-metadata-attribute-value-v1) | **GET** `/access-model-metadata/v1/attributes/{key}/values/{value}` | Get access model metadata value +[**list-access-model-metadata-attribute-v1**](#list-access-model-metadata-attribute-v1) | **GET** `/access-model-metadata/v1/attributes` | List access model metadata attributes +[**list-access-model-metadata-attribute-value-v1**](#list-access-model-metadata-attribute-value-v1) | **GET** `/access-model-metadata/v1/attributes/{key}/values` | List access model metadata values +[**update-access-model-metadata-attribute-v1**](#update-access-model-metadata-attribute-v1) | **PATCH** `/access-model-metadata/v1/attributes/{key}` | Update access model metadata attribute +[**update-access-model-metadata-attribute-value-v1**](#update-access-model-metadata-attribute-value-v1) | **PATCH** `/access-model-metadata/v1/attributes/{key}/values/{value}` | Update access model metadata value +[**update-access-model-metadata-by-filter-v1**](#update-access-model-metadata-by-filter-v1) | **POST** `/access-model-metadata/v1/bulk-update/filter` | Metadata Attribute update by filter +[**update-access-model-metadata-by-ids-v1**](#update-access-model-metadata-by-ids-v1) | **POST** `/access-model-metadata/v1/bulk-update/ids` | Metadata Attribute update by ids +[**update-access-model-metadata-by-query-v1**](#update-access-model-metadata-by-query-v1) | **POST** `/access-model-metadata/v1/bulk-update/query` | Metadata Attribute update by query + + +## create-access-model-metadata-attribute-v1 +Create access model metadata attribute +Create a new Access Model Metadata Attribute. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-access-model-metadata-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**attributedtoV1** | **AttributedtoV1** | Attribute to create | + +### Return type + +**AttributedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const attributedtoV1: AttributedtoV1 = ; // Attribute to create +const result = await apiInstance.createAccessModelMetadataAttributeV1(attributedtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-access-model-metadata-attribute-value-v1 +Create access model metadata value +Create a new value for an existing Access Model Metadata Attribute. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-access-model-metadata-attribute-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] +**attributevaluedtoV1** | **AttributevaluedtoV1** | Attribute value to create | + +### Return type + +**AttributevaluedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const attributevaluedtoV1: AttributevaluedtoV1 = ; // Attribute value to create +const result = await apiInstance.createAccessModelMetadataAttributeValueV1(key, attributevaluedtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-model-metadata-attribute-v1 +Get access model metadata attribute +Get single Access Model Metadata Attribute + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-model-metadata-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] + +### Return type + +**AttributedtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const result = await apiInstance.getAccessModelMetadataAttributeV1(key); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-model-metadata-attribute-value-v1 +Get access model metadata value +Get single Access Model Metadata Attribute Value + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-model-metadata-attribute-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] +**value** | **string** | Technical name of the Attribute value. | [default to undefined] + +### Return type + +**AttributevaluedtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const value: string = public; // Technical name of the Attribute value. +const result = await apiInstance.getAccessModelMetadataAttributeValueV1(key, value); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute-v1 +List access model metadata attributes +Get a list of Access Model Metadata Attributes + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-model-metadata-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const filters: string = name eq "Privacy"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* (optional) +const sorters: string = name,-key; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listAccessModelMetadataAttributeV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-model-metadata-attribute-value-v1 +List access model metadata values +Get a list of Access Model Metadata Attribute Values + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-model-metadata-attribute-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listAccessModelMetadataAttributeValueV1(key); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-model-metadata-attribute-v1 +Update access model metadata attribute +Update an existing Access Model Metadata Attribute. +The following fields are patchable: **name**, **description**, **multiselect**, **values** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-model-metadata-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | JSON Patch array to apply | + +### Return type + +**AttributedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // JSON Patch array to apply +const result = await apiInstance.updateAccessModelMetadataAttributeV1(key, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-model-metadata-attribute-value-v1 +Update access model metadata value +Update an existing Access Model Metadata Attribute Value. +The following fields are patchable: **name** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-model-metadata-attribute-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Technical name of the Attribute. | [default to undefined] +**value** | **string** | Technical name of the Attribute value. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | JSON Patch array to apply | + +### Return type + +**AttributevaluedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const key: string = iscPrivacy; // Technical name of the Attribute. +const value: string = public; // Technical name of the Attribute value. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // JSON Patch array to apply +const result = await apiInstance.updateAccessModelMetadataAttributeValueV1(key, value, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-model-metadata-by-filter-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Metadata Attribute update by filter +Bulk update Access Model Metadata Attribute Values using a filter + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-model-metadata-by-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementattributebulkupdatefilterrequestV1** | **EntitlementattributebulkupdatefilterrequestV1** | Attribute metadata bulk update request body. | + +### Return type + +**AccessmodelmetadatabulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const entitlementattributebulkupdatefilterrequestV1: EntitlementattributebulkupdatefilterrequestV1 = ; // Attribute metadata bulk update request body. +const result = await apiInstance.updateAccessModelMetadataByFilterV1(entitlementattributebulkupdatefilterrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-model-metadata-by-ids-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Metadata Attribute update by ids +Bulk update Access Model Metadata Attribute Values using ids. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-model-metadata-by-ids-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementattributebulkupdateidsrequestV1** | **EntitlementattributebulkupdateidsrequestV1** | Attribute metadata bulk update request body. | + +### Return type + +**AccessmodelmetadatabulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const entitlementattributebulkupdateidsrequestV1: EntitlementattributebulkupdateidsrequestV1 = ; // Attribute metadata bulk update request body. +const result = await apiInstance.updateAccessModelMetadataByIdsV1(entitlementattributebulkupdateidsrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-model-metadata-by-query-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Metadata Attribute update by query +Bulk update Access Model Metadata Attribute Values using a query + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-model-metadata-by-query-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementattributebulkupdatequeryrequestV1** | **EntitlementattributebulkupdatequeryrequestV1** | Attribute metadata bulk update request body. | + +### Return type + +**AccessmodelmetadatabulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessModelMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessModelMetadataV1Api(configuration); +const entitlementattributebulkupdatequeryrequestV1: EntitlementattributebulkupdatequeryrequestV1 = ; // Attribute metadata bulk update request body. +const result = await apiInstance.updateAccessModelMetadataByQueryV1(entitlementattributebulkupdatequeryrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/access_model_metadata/docs/Methods/Index.md b/sdk-output/access_model_metadata/docs/Methods/Index.md new file mode 100644 index 00000000..e81bf88c --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: access_model_metadata-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: access_model_metadata-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'access_model_metadata', 'methods'] +slug: /tools/sdk/typescript/access_model_metadata/methods +tags: ['SDK', 'Software Development Kit', 'access_model_metadata', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/access_model_metadata/docs/Models/Accessmodelmetadatabulkupdateresponse.md b/sdk-output/access_model_metadata/docs/Models/Accessmodelmetadatabulkupdateresponse.md new file mode 100644 index 00000000..81525afb --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Accessmodelmetadatabulkupdateresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-accessmodelmetadatabulkupdateresponse-v1 +title: AccessmodelmetadatabulkupdateresponseV1 +pagination_label: AccessmodelmetadatabulkupdateresponseV1 +sidebar_label: AccessmodelmetadatabulkupdateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadatabulkupdateresponseV1', 'v1AccessmodelmetadatabulkupdateresponseV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/accessmodelmetadatabulkupdateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadatabulkupdateresponseV1', 'v1AccessmodelmetadatabulkupdateresponseV1'] +--- + +# AccessmodelmetadatabulkupdateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the task which is executing the bulk update. | [default to undefined] +**type** | **(optional)** **string** | Type of the bulk update object. | [default to undefined] +**status** | **(optional)** **string** | The status of the bulk update request, only list unfinished request\'s status. | [default to undefined] +**created** | **(optional)** **string** | Time when the bulk update request was created | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Aggregations.md b/sdk-output/access_model_metadata/docs/Models/Aggregations.md new file mode 100644 index 00000000..ebc210c0 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Aggregations.md @@ -0,0 +1,22 @@ +--- +id: v1-aggregations-v1 +title: AggregationsV1 +pagination_label: AggregationsV1 +sidebar_label: AggregationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AggregationsV1', 'v1AggregationsV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/aggregations-v1 +tags: ['SDK', 'Software Development Kit', 'AggregationsV1', 'v1AggregationsV1'] +--- + +# AggregationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Aggregationtype.md b/sdk-output/access_model_metadata/docs/Models/Aggregationtype.md new file mode 100644 index 00000000..3e83e214 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Aggregationtype.md @@ -0,0 +1,21 @@ +--- +id: v1-aggregationtype-v1 +title: AggregationtypeV1 +pagination_label: AggregationtypeV1 +sidebar_label: AggregationtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AggregationtypeV1', 'v1AggregationtypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/aggregationtype-v1 +tags: ['SDK', 'Software Development Kit', 'AggregationtypeV1', 'v1AggregationtypeV1'] +--- + +# AggregationtypeV1 + +## Enum + + +* `Dsl` (value: `'DSL'`) + +* `Sailpoint` (value: `'SAILPOINT'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/ArrayInner.md b/sdk-output/access_model_metadata/docs/Models/ArrayInner.md new file mode 100644 index 00000000..2ea77577 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/access_model_metadata/docs/Models/Attributedto.md b/sdk-output/access_model_metadata/docs/Models/Attributedto.md new file mode 100644 index 00000000..bc01b7ba --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Attributedto.md @@ -0,0 +1,26 @@ +--- +id: v1-attributedto-v1 +title: AttributedtoV1 +pagination_label: AttributedtoV1 +sidebar_label: AttributedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtoV1', 'v1AttributedtoV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/attributedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtoV1', 'v1AttributedtoV1'] +--- + +# AttributedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the key. | [default to undefined] +**multiselect** | **(optional)** **boolean** | Indicates whether the attribute can have multiple values. | [default to false] +**status** | **(optional)** **string** | The status of the Attribute. | [default to undefined] +**type** | **(optional)** **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [default to undefined] +**description** | **(optional)** **string** | The description of the Attribute. | [default to undefined] +**values** | **(optional)** **Array<AttributevaluedtoV1>** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Attributevaluedto.md b/sdk-output/access_model_metadata/docs/Models/Attributevaluedto.md new file mode 100644 index 00000000..83b708d7 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Attributevaluedto.md @@ -0,0 +1,21 @@ +--- +id: v1-attributevaluedto-v1 +title: AttributevaluedtoV1 +pagination_label: AttributevaluedtoV1 +sidebar_label: AttributevaluedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/attributevaluedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +--- + +# AttributevaluedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the Attribute value. | [default to undefined] +**status** | **(optional)** **string** | The status of the Attribute value. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Bound.md b/sdk-output/access_model_metadata/docs/Models/Bound.md new file mode 100644 index 00000000..541af783 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Bound.md @@ -0,0 +1,20 @@ +--- +id: v1-bound-v1 +title: BoundV1 +pagination_label: BoundV1 +sidebar_label: BoundV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BoundV1', 'v1BoundV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/bound-v1 +tags: ['SDK', 'Software Development Kit', 'BoundV1', 'v1BoundV1'] +--- + +# BoundV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **string** | The value of the range\'s endpoint. | [default to undefined] +**inclusive** | **(optional)** **boolean** | Indicates if the endpoint is included in the range. | [default to false] + diff --git a/sdk-output/access_model_metadata/docs/Models/Bucketaggregation.md b/sdk-output/access_model_metadata/docs/Models/Bucketaggregation.md new file mode 100644 index 00000000..84152673 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Bucketaggregation.md @@ -0,0 +1,23 @@ +--- +id: v1-bucketaggregation-v1 +title: BucketaggregationV1 +pagination_label: BucketaggregationV1 +sidebar_label: BucketaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BucketaggregationV1', 'v1BucketaggregationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/bucketaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'BucketaggregationV1', 'v1BucketaggregationV1'] +--- + +# BucketaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the bucket aggregate to be included in the result. | [default to undefined] +**type** | **(optional)** **BuckettypeV1** | | [default to undefined] +**field** | **string** | The field to bucket on. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] +**size** | **(optional)** **number** | Maximum number of buckets to include. | [default to undefined] +**minDocCount** | **(optional)** **number** | Minimum number of documents a bucket should have. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Buckettype.md b/sdk-output/access_model_metadata/docs/Models/Buckettype.md new file mode 100644 index 00000000..517c4272 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Buckettype.md @@ -0,0 +1,19 @@ +--- +id: v1-buckettype-v1 +title: BuckettypeV1 +pagination_label: BuckettypeV1 +sidebar_label: BuckettypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BuckettypeV1', 'v1BuckettypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/buckettype-v1 +tags: ['SDK', 'Software Development Kit', 'BuckettypeV1', 'v1BuckettypeV1'] +--- + +# BuckettypeV1 + +## Enum + + +* `Terms` (value: `'TERMS'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/BulkupdateammkeyvalueInner.md b/sdk-output/access_model_metadata/docs/Models/BulkupdateammkeyvalueInner.md new file mode 100644 index 00000000..da2e771b --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/BulkupdateammkeyvalueInner.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkupdateammkeyvalue-inner-v1 +title: BulkupdateammkeyvalueInnerV1 +pagination_label: BulkupdateammkeyvalueInnerV1 +sidebar_label: BulkupdateammkeyvalueInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkupdateammkeyvalueInnerV1', 'v1BulkupdateammkeyvalueInnerV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/bulkupdateammkeyvalue-inner-v1 +tags: ['SDK', 'Software Development Kit', 'BulkupdateammkeyvalueInnerV1', 'v1BulkupdateammkeyvalueInnerV1'] +--- + +# BulkupdateammkeyvalueInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **string** | the key of metadata attribute | [default to undefined] +**values** | **Array<string>** | the values of attribute to be updated | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatefilterrequest.md b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatefilterrequest.md new file mode 100644 index 00000000..cda144f9 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatefilterrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-entitlementattributebulkupdatefilterrequest-v1 +title: EntitlementattributebulkupdatefilterrequestV1 +pagination_label: EntitlementattributebulkupdatefilterrequestV1 +sidebar_label: EntitlementattributebulkupdatefilterrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementattributebulkupdatefilterrequestV1', 'v1EntitlementattributebulkupdatefilterrequestV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/entitlementattributebulkupdatefilterrequest-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementattributebulkupdatefilterrequestV1', 'v1EntitlementattributebulkupdatefilterrequestV1'] +--- + +# EntitlementattributebulkupdatefilterrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **(optional)** **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* | [default to undefined] +**operation** | **(optional)** **string** | Operation to perform on the attributes in the bulk update request. | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **(optional)** **Array<BulkupdateammkeyvalueInnerV1>** | The metadata to be updated, including attribute and values. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdateidsrequest.md b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdateidsrequest.md new file mode 100644 index 00000000..3a1501d8 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdateidsrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-entitlementattributebulkupdateidsrequest-v1 +title: EntitlementattributebulkupdateidsrequestV1 +pagination_label: EntitlementattributebulkupdateidsrequestV1 +sidebar_label: EntitlementattributebulkupdateidsrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementattributebulkupdateidsrequestV1', 'v1EntitlementattributebulkupdateidsrequestV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/entitlementattributebulkupdateidsrequest-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementattributebulkupdateidsrequestV1', 'v1EntitlementattributebulkupdateidsrequestV1'] +--- + +# EntitlementattributebulkupdateidsrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlements** | **(optional)** **Array<string>** | List of entitlement IDs to update. | [default to undefined] +**operation** | **(optional)** **string** | Operation to perform on the attributes in the bulk update request. | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **(optional)** **Array<BulkupdateammkeyvalueInnerV1>** | The metadata to be updated, including attribute and values. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatequeryrequest.md b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatequeryrequest.md new file mode 100644 index 00000000..8d5dabcd --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Entitlementattributebulkupdatequeryrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-entitlementattributebulkupdatequeryrequest-v1 +title: EntitlementattributebulkupdatequeryrequestV1 +pagination_label: EntitlementattributebulkupdatequeryrequestV1 +sidebar_label: EntitlementattributebulkupdatequeryrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementattributebulkupdatequeryrequestV1', 'v1EntitlementattributebulkupdatequeryrequestV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/entitlementattributebulkupdatequeryrequest-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementattributebulkupdatequeryrequestV1', 'v1EntitlementattributebulkupdatequeryrequestV1'] +--- + +# EntitlementattributebulkupdatequeryrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **(optional)** **SearchV1** | | [default to undefined] +**operation** | **(optional)** **string** | Operation to perform on the attributes in the bulk update request. | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **(optional)** **Array<BulkupdateammkeyvalueInnerV1>** | The metadata to be updated, including attribute and values. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Errormessagedto.md b/sdk-output/access_model_metadata/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..6c5332ef --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Errorresponsedto.md b/sdk-output/access_model_metadata/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..19be03a2 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Filter.md b/sdk-output/access_model_metadata/docs/Models/Filter.md new file mode 100644 index 00000000..03f06cf9 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Filter.md @@ -0,0 +1,22 @@ +--- +id: v1-filter-v1 +title: FilterV1 +pagination_label: FilterV1 +sidebar_label: FilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FilterV1', 'v1FilterV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/filter-v1 +tags: ['SDK', 'Software Development Kit', 'FilterV1', 'v1FilterV1'] +--- + +# FilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **FiltertypeV1** | | [default to undefined] +**range** | **(optional)** **RangeV1** | | [default to undefined] +**terms** | **(optional)** **Array<string>** | The terms to be filtered. | [default to undefined] +**exclude** | **(optional)** **boolean** | Indicates if the filter excludes results. | [default to false] + diff --git a/sdk-output/access_model_metadata/docs/Models/Filteraggregation.md b/sdk-output/access_model_metadata/docs/Models/Filteraggregation.md new file mode 100644 index 00000000..92971fb5 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Filteraggregation.md @@ -0,0 +1,22 @@ +--- +id: v1-filteraggregation-v1 +title: FilteraggregationV1 +pagination_label: FilteraggregationV1 +sidebar_label: FilteraggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FilteraggregationV1', 'v1FilteraggregationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/filteraggregation-v1 +tags: ['SDK', 'Software Development Kit', 'FilteraggregationV1', 'v1FilteraggregationV1'] +--- + +# FilteraggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the filter aggregate to be included in the result. | [default to undefined] +**type** | **(optional)** **SearchfiltertypeV1** | | [default to undefined] +**field** | **string** | The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] +**value** | **string** | The value to filter on. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Filtertype.md b/sdk-output/access_model_metadata/docs/Models/Filtertype.md new file mode 100644 index 00000000..4a877c48 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Filtertype.md @@ -0,0 +1,23 @@ +--- +id: v1-filtertype-v1 +title: FiltertypeV1 +pagination_label: FiltertypeV1 +sidebar_label: FiltertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FiltertypeV1', 'v1FiltertypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/filtertype-v1 +tags: ['SDK', 'Software Development Kit', 'FiltertypeV1', 'v1FiltertypeV1'] +--- + +# FiltertypeV1 + +## Enum + + +* `Exists` (value: `'EXISTS'`) + +* `Range` (value: `'RANGE'`) + +* `Terms` (value: `'TERMS'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/Index.md b/sdk-output/access_model_metadata/docs/Models/Index.md new file mode 100644 index 00000000..77de59f9 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: access_model_metadata-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: access_model_metadata-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'access_model_metadata', 'models'] +slug: /tools/sdk/typescript/access_model_metadata/models +tags: ['SDK', 'Software Development Kit', 'access_model_metadata', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/access_model_metadata/docs/Models/Innerhit.md b/sdk-output/access_model_metadata/docs/Models/Innerhit.md new file mode 100644 index 00000000..59b42689 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Innerhit.md @@ -0,0 +1,20 @@ +--- +id: v1-innerhit-v1 +title: InnerhitV1 +pagination_label: InnerhitV1 +sidebar_label: InnerhitV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InnerhitV1', 'v1InnerhitV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/innerhit-v1 +tags: ['SDK', 'Software Development Kit', 'InnerhitV1', 'v1InnerhitV1'] +--- + +# InnerhitV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **string** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**type** | **string** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Jsonpatchoperation.md b/sdk-output/access_model_metadata/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..222921ce --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/JsonpatchoperationValue.md b/sdk-output/access_model_metadata/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..5975ef45 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1401Response.md b/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1401Response.md new file mode 100644 index 00000000..ca0fdc6b --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-access-model-metadata-attribute-v1401-response-v1 +title: ListAccessModelMetadataAttributeV1401ResponseV1 +pagination_label: ListAccessModelMetadataAttributeV1401ResponseV1 +sidebar_label: ListAccessModelMetadataAttributeV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccessModelMetadataAttributeV1401ResponseV1', 'v1ListAccessModelMetadataAttributeV1401ResponseV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/list-access-model-metadata-attribute-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttributeV1401ResponseV1', 'v1ListAccessModelMetadataAttributeV1401ResponseV1'] +--- + +# ListAccessModelMetadataAttributeV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1429Response.md b/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1429Response.md new file mode 100644 index 00000000..7e7de2bb --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/ListAccessModelMetadataAttributeV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-access-model-metadata-attribute-v1429-response-v1 +title: ListAccessModelMetadataAttributeV1429ResponseV1 +pagination_label: ListAccessModelMetadataAttributeV1429ResponseV1 +sidebar_label: ListAccessModelMetadataAttributeV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccessModelMetadataAttributeV1429ResponseV1', 'v1ListAccessModelMetadataAttributeV1429ResponseV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/list-access-model-metadata-attribute-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttributeV1429ResponseV1', 'v1ListAccessModelMetadataAttributeV1429ResponseV1'] +--- + +# ListAccessModelMetadataAttributeV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Localeorigin.md b/sdk-output/access_model_metadata/docs/Models/Localeorigin.md new file mode 100644 index 00000000..310ceb02 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/Metricaggregation.md b/sdk-output/access_model_metadata/docs/Models/Metricaggregation.md new file mode 100644 index 00000000..ebeb77e7 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Metricaggregation.md @@ -0,0 +1,21 @@ +--- +id: v1-metricaggregation-v1 +title: MetricaggregationV1 +pagination_label: MetricaggregationV1 +sidebar_label: MetricaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MetricaggregationV1', 'v1MetricaggregationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/metricaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'MetricaggregationV1', 'v1MetricaggregationV1'] +--- + +# MetricaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | [default to undefined] +**type** | **(optional)** **MetrictypeV1** | | [default to undefined] +**field** | **string** | The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Metrictype.md b/sdk-output/access_model_metadata/docs/Models/Metrictype.md new file mode 100644 index 00000000..6ebfc526 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Metrictype.md @@ -0,0 +1,31 @@ +--- +id: v1-metrictype-v1 +title: MetrictypeV1 +pagination_label: MetrictypeV1 +sidebar_label: MetrictypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MetrictypeV1', 'v1MetrictypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/metrictype-v1 +tags: ['SDK', 'Software Development Kit', 'MetrictypeV1', 'v1MetrictypeV1'] +--- + +# MetrictypeV1 + +## Enum + + +* `Count` (value: `'COUNT'`) + +* `UniqueCount` (value: `'UNIQUE_COUNT'`) + +* `Avg` (value: `'AVG'`) + +* `Sum` (value: `'SUM'`) + +* `Median` (value: `'MEDIAN'`) + +* `Min` (value: `'MIN'`) + +* `Max` (value: `'MAX'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/Nestedaggregation.md b/sdk-output/access_model_metadata/docs/Models/Nestedaggregation.md new file mode 100644 index 00000000..c821a7e4 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Nestedaggregation.md @@ -0,0 +1,20 @@ +--- +id: v1-nestedaggregation-v1 +title: NestedaggregationV1 +pagination_label: NestedaggregationV1 +sidebar_label: NestedaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NestedaggregationV1', 'v1NestedaggregationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/nestedaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'NestedaggregationV1', 'v1NestedaggregationV1'] +--- + +# NestedaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the nested aggregate to be included in the result. | [default to undefined] +**type** | **string** | The type of the nested object. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Query.md b/sdk-output/access_model_metadata/docs/Models/Query.md new file mode 100644 index 00000000..92ed4e54 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Query.md @@ -0,0 +1,22 @@ +--- +id: v1-query-v1 +title: QueryV1 +pagination_label: QueryV1 +sidebar_label: QueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryV1', 'v1QueryV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/query-v1 +tags: ['SDK', 'Software Development Kit', 'QueryV1', 'v1QueryV1'] +--- + +# QueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **(optional)** **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**fields** | **(optional)** **string** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. | [default to undefined] +**timeZone** | **(optional)** **string** | The time zone to be applied to any range query related to dates. | [default to undefined] +**innerHit** | **(optional)** **InnerhitV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Queryresultfilter.md b/sdk-output/access_model_metadata/docs/Models/Queryresultfilter.md new file mode 100644 index 00000000..7195c1f4 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Queryresultfilter.md @@ -0,0 +1,20 @@ +--- +id: v1-queryresultfilter-v1 +title: QueryresultfilterV1 +pagination_label: QueryresultfilterV1 +sidebar_label: QueryresultfilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryresultfilterV1', 'v1QueryresultfilterV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/queryresultfilter-v1 +tags: ['SDK', 'Software Development Kit', 'QueryresultfilterV1', 'v1QueryresultfilterV1'] +--- + +# QueryresultfilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includes** | **(optional)** **Array<string>** | The list of field names to include in the result documents. | [default to undefined] +**excludes** | **(optional)** **Array<string>** | The list of field names to exclude from the result documents. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Querytype.md b/sdk-output/access_model_metadata/docs/Models/Querytype.md new file mode 100644 index 00000000..0a7b3ab4 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Querytype.md @@ -0,0 +1,25 @@ +--- +id: v1-querytype-v1 +title: QuerytypeV1 +pagination_label: QuerytypeV1 +sidebar_label: QuerytypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QuerytypeV1', 'v1QuerytypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/querytype-v1 +tags: ['SDK', 'Software Development Kit', 'QuerytypeV1', 'v1QuerytypeV1'] +--- + +# QuerytypeV1 + +## Enum + + +* `Dsl` (value: `'DSL'`) + +* `Sailpoint` (value: `'SAILPOINT'`) + +* `Text` (value: `'TEXT'`) + +* `Typeahead` (value: `'TYPEAHEAD'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/README.md b/sdk-output/access_model_metadata/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_model_metadata/docs/Models/Range.md b/sdk-output/access_model_metadata/docs/Models/Range.md new file mode 100644 index 00000000..fe149597 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Range.md @@ -0,0 +1,20 @@ +--- +id: v1-range-v1 +title: RangeV1 +pagination_label: RangeV1 +sidebar_label: RangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RangeV1', 'v1RangeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/range-v1 +tags: ['SDK', 'Software Development Kit', 'RangeV1', 'v1RangeV1'] +--- + +# RangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | **(optional)** **BoundV1** | | [default to undefined] +**upper** | **(optional)** **BoundV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Search.md b/sdk-output/access_model_metadata/docs/Models/Search.md new file mode 100644 index 00000000..39e483ff --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Search.md @@ -0,0 +1,34 @@ +--- +id: v1-search-v1 +title: SearchV1 +pagination_label: SearchV1 +sidebar_label: SearchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchV1', 'v1SearchV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/search-v1 +tags: ['SDK', 'Software Development Kit', 'SearchV1', 'v1SearchV1'] +--- + +# SearchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | **(optional)** **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [default to undefined] +**queryType** | **(optional)** **QuerytypeV1** | | [default to undefined] +**queryVersion** | **(optional)** **string** | | [default to undefined] +**query** | **(optional)** **QueryV1** | | [default to undefined] +**queryDsl** | **(optional)** **object** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [default to undefined] +**textQuery** | **(optional)** **TextqueryV1** | | [default to undefined] +**typeAheadQuery** | **(optional)** **TypeaheadqueryV1** | | [default to undefined] +**includeNested** | **(optional)** **boolean** | Indicates whether nested objects from returned search results should be included. | [default to true] +**queryResultFilter** | **(optional)** **QueryresultfilterV1** | | [default to undefined] +**aggregationType** | **(optional)** **AggregationtypeV1** | | [default to undefined] +**aggregationsVersion** | **(optional)** **string** | | [default to undefined] +**aggregationsDsl** | **(optional)** **object** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [default to undefined] +**aggregations** | **(optional)** **SearchaggregationspecificationV1** | | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [default to undefined] +**searchAfter** | **(optional)** **Array<string>** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] | [default to undefined] +**filters** | **(optional)** | The filters to be applied for each filtered field name. | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Searchaggregationspecification.md b/sdk-output/access_model_metadata/docs/Models/Searchaggregationspecification.md new file mode 100644 index 00000000..3051dae5 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Searchaggregationspecification.md @@ -0,0 +1,23 @@ +--- +id: v1-searchaggregationspecification-v1 +title: SearchaggregationspecificationV1 +pagination_label: SearchaggregationspecificationV1 +sidebar_label: SearchaggregationspecificationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchaggregationspecificationV1', 'v1SearchaggregationspecificationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/searchaggregationspecification-v1 +tags: ['SDK', 'Software Development Kit', 'SearchaggregationspecificationV1', 'v1SearchaggregationspecificationV1'] +--- + +# SearchaggregationspecificationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] +**subAggregation** | **(optional)** **SubsearchaggregationspecificationV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Searchfiltertype.md b/sdk-output/access_model_metadata/docs/Models/Searchfiltertype.md new file mode 100644 index 00000000..60ee526e --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Searchfiltertype.md @@ -0,0 +1,19 @@ +--- +id: v1-searchfiltertype-v1 +title: SearchfiltertypeV1 +pagination_label: SearchfiltertypeV1 +sidebar_label: SearchfiltertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchfiltertypeV1', 'v1SearchfiltertypeV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/searchfiltertype-v1 +tags: ['SDK', 'Software Development Kit', 'SearchfiltertypeV1', 'v1SearchfiltertypeV1'] +--- + +# SearchfiltertypeV1 + +## Enum + + +* `Term` (value: `'TERM'`) + + diff --git a/sdk-output/access_model_metadata/docs/Models/Subsearchaggregationspecification.md b/sdk-output/access_model_metadata/docs/Models/Subsearchaggregationspecification.md new file mode 100644 index 00000000..1868e47a --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Subsearchaggregationspecification.md @@ -0,0 +1,23 @@ +--- +id: v1-subsearchaggregationspecification-v1 +title: SubsearchaggregationspecificationV1 +pagination_label: SubsearchaggregationspecificationV1 +sidebar_label: SubsearchaggregationspecificationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubsearchaggregationspecificationV1', 'v1SubsearchaggregationspecificationV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/subsearchaggregationspecification-v1 +tags: ['SDK', 'Software Development Kit', 'SubsearchaggregationspecificationV1', 'v1SubsearchaggregationspecificationV1'] +--- + +# SubsearchaggregationspecificationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] +**subAggregation** | **(optional)** **AggregationsV1** | | [default to undefined] + diff --git a/sdk-output/access_model_metadata/docs/Models/Textquery.md b/sdk-output/access_model_metadata/docs/Models/Textquery.md new file mode 100644 index 00000000..3c979873 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Textquery.md @@ -0,0 +1,22 @@ +--- +id: v1-textquery-v1 +title: TextqueryV1 +pagination_label: TextqueryV1 +sidebar_label: TextqueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TextqueryV1', 'v1TextqueryV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/textquery-v1 +tags: ['SDK', 'Software Development Kit', 'TextqueryV1', 'v1TextqueryV1'] +--- + +# TextqueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terms** | **Array<string>** | Words or characters that specify a particular thing to be searched for. | [default to undefined] +**fields** | **Array<string>** | The fields to be searched. | [default to undefined] +**matchAny** | **(optional)** **boolean** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [default to false] +**contains** | **(optional)** **boolean** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [default to false] + diff --git a/sdk-output/access_model_metadata/docs/Models/Typeaheadquery.md b/sdk-output/access_model_metadata/docs/Models/Typeaheadquery.md new file mode 100644 index 00000000..999a6d35 --- /dev/null +++ b/sdk-output/access_model_metadata/docs/Models/Typeaheadquery.md @@ -0,0 +1,25 @@ +--- +id: v1-typeaheadquery-v1 +title: TypeaheadqueryV1 +pagination_label: TypeaheadqueryV1 +sidebar_label: TypeaheadqueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TypeaheadqueryV1', 'v1TypeaheadqueryV1'] +slug: /tools/sdk/typescript/access_model_metadata/models/typeaheadquery-v1 +tags: ['SDK', 'Software Development Kit', 'TypeaheadqueryV1', 'v1TypeaheadqueryV1'] +--- + +# TypeaheadqueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **string** | The type ahead query string used to construct a phrase prefix match query. | [default to undefined] +**field** | **string** | The field on which to perform the type ahead search. | [default to undefined] +**nestedType** | **(optional)** **string** | The nested type. | [default to undefined] +**maxExpansions** | **(optional)** **number** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [default to 10] +**size** | **(optional)** **number** | The max amount of records the search will return. | [default to 100] +**sort** | **(optional)** **string** | The sort order of the returned records. | [default to 'desc'] +**sortByValue** | **(optional)** **boolean** | The flag that defines the sort type, by count or value. | [default to false] + diff --git a/sdk-output/access_profiles/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/access_profiles/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a2096082 --- /dev/null +++ b/sdk-output/access_profiles/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,134 @@ +- path: /access-profiles/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#create-access-profile-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const accessprofileV1: AccessprofileV1 = ; // AccessprofileV1 | + const result = await apiInstance.createAccessProfileV1(accessprofileV1); + console.log(result); +- path: /access-profiles/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#delete-access-profile-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Access Profile to delete (default to undefined) + const result = await apiInstance.deleteAccessProfileV1(id); + console.log(result); +- path: /access-profiles/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#delete-access-profiles-in-bulk-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const accessprofilebulkdeleterequestV1: AccessprofilebulkdeleterequestV1 = {"bestEffortOnly":true,"accessProfileIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // AccessprofilebulkdeleterequestV1 | + const result = await apiInstance.deleteAccessProfilesInBulkV1(accessprofilebulkdeleterequestV1); + console.log(result); +- path: /access-profiles/v1/{id}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#get-access-profile-entitlements-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of the access profile containing the entitlements. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) (default to undefined) + const result = await apiInstance.getAccessProfileEntitlementsV1(id); + console.log(result); +- path: /access-profiles/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#get-access-profile-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const id: string = '2c9180837ca6693d017ca8d097500149'; // string | ID of the Access Profile (default to undefined) + const result = await apiInstance.getAccessProfileV1(id); + console.log(result); +- path: /access-profiles/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#list-access-profiles-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const forSubadmin: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq "SailPoint Support"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const forSegmentIds: string = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d'; // string | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) (default to undefined) + const includeUnsegmented: boolean = false; // boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to true) + const result = await apiInstance.listAccessProfilesV1(); + console.log(result); +- path: /access-profiles/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#patch-access-profile-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Access Profile to patch (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]; // Array | + const result = await apiInstance.patchAccessProfileV1(id, jsonpatchoperationV1); + console.log(result); +- path: /access-profiles/v1/bulk-update-requestable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_profiles/methods/access-profiles#update-access-profiles-in-bulk-v1 + source: | + import { AccessProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessProfilesV1Api(configuration); + const accessprofilebulkupdaterequestInnerV1: Array<AccessprofilebulkupdaterequestInnerV1> = [{"id":"464ae7bf-791e-49fd-b746-06a2e4a89635","requestable":false}]; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateAccessProfilesInBulkV1(accessprofilebulkupdaterequestInnerV1); + console.log(result); diff --git a/sdk-output/access_profiles/docs/Methods/AccessProfilesV1Api.md b/sdk-output/access_profiles/docs/Methods/AccessProfilesV1Api.md new file mode 100644 index 00000000..2e9bd705 --- /dev/null +++ b/sdk-output/access_profiles/docs/Methods/AccessProfilesV1Api.md @@ -0,0 +1,447 @@ +--- +id: v1-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessProfiles', 'v1AccessProfiles'] +slug: /tools/sdk/typescript/access_profiles/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'v1AccessProfiles'] +--- + +# AccessProfilesV1Api + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-profile-v1**](#create-access-profile-v1) | **POST** `/access-profiles/v1` | Create access profile +[**delete-access-profile-v1**](#delete-access-profile-v1) | **DELETE** `/access-profiles/v1/{id}` | Delete the specified access profile +[**delete-access-profiles-in-bulk-v1**](#delete-access-profiles-in-bulk-v1) | **POST** `/access-profiles/v1/bulk-delete` | Delete access profile(s) +[**get-access-profile-entitlements-v1**](#get-access-profile-entitlements-v1) | **GET** `/access-profiles/v1/{id}/entitlements` | List access profile\'s entitlements +[**get-access-profile-v1**](#get-access-profile-v1) | **GET** `/access-profiles/v1/{id}` | Get an access profile +[**list-access-profiles-v1**](#list-access-profiles-v1) | **GET** `/access-profiles/v1` | List access profiles +[**patch-access-profile-v1**](#patch-access-profile-v1) | **PATCH** `/access-profiles/v1/{id}` | Patch a specified access profile +[**update-access-profiles-in-bulk-v1**](#update-access-profiles-in-bulk-v1) | **POST** `/access-profiles/v1/bulk-update-requestable` | Update access profile(s) requestable field. + + +## create-access-profile-v1 +Create access profile +Create an access profile. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-access-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessprofileV1** | **AccessprofileV1** | | + +### Return type + +**AccessprofileV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const accessprofileV1: AccessprofileV1 = ; // +const result = await apiInstance.createAccessProfileV1(accessprofileV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-access-profile-v1 +Delete the specified access profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-access-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Access Profile to delete | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of the Access Profile to delete +const result = await apiInstance.deleteAccessProfileV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-access-profiles-in-bulk-v1 +Delete access profile(s) +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-access-profiles-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessprofilebulkdeleterequestV1** | **AccessprofilebulkdeleterequestV1** | | + +### Return type + +**AccessprofilebulkdeleteresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const accessprofilebulkdeleterequestV1: AccessprofilebulkdeleterequestV1 = {"bestEffortOnly":true,"accessProfileIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // +const result = await apiInstance.deleteAccessProfilesInBulkV1(accessprofilebulkdeleterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-profile-entitlements-v1 +List access profile\'s entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-profile-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the access profile containing the entitlements. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of the access profile containing the entitlements. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) +const result = await apiInstance.getAccessProfileEntitlementsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-profile-v1 +Get an access profile +This API returns an Access Profile by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Access Profile | [default to undefined] + +### Return type + +**AccessprofileV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Access Profile +const result = await apiInstance.getAccessProfileV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-profiles-v1 +List access profiles +Get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**forSubadmin** | **string** | Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] +**forSegmentIds** | **string** | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | [optional] [default to undefined] +**includeUnsegmented** | **boolean** | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. | [optional] [default to true] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const forSubadmin: string = 8c190e6787aa4ed9a90bd9d5344523fb; // Filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID or the special value **me**, which is shorthand for the calling identity\'s ID. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "SailPoint Support"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const forSegmentIds: string = 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d; // Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +const includeUnsegmented: boolean = false; // Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) +const result = await apiInstance.listAccessProfilesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-access-profile-v1 +Patch a specified access profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**additionalOwners** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-access-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Access Profile to patch | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**AccessprofileV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of the Access Profile to patch +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/entitlements","value":[{"id":"2c9180857725c14301772a93bb77242d","type":"ENTITLEMENT","name":"AD User Group"}]}]; // +const result = await apiInstance.patchAccessProfileV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-access-profiles-in-bulk-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update access profile(s) requestable field. +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. + A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-access-profiles-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessprofilebulkupdaterequestInnerV1** | **Array<AccessprofilebulkupdaterequestInnerV1>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessProfilesV1Api(configuration); +const accessprofilebulkupdaterequestInnerV1: Array<AccessprofilebulkupdaterequestInnerV1> = [{"id":"464ae7bf-791e-49fd-b746-06a2e4a89635","requestable":false}]; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateAccessProfilesInBulkV1(accessprofilebulkupdaterequestInnerV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/access_profiles/docs/Methods/Index.md b/sdk-output/access_profiles/docs/Methods/Index.md new file mode 100644 index 00000000..86b9cedc --- /dev/null +++ b/sdk-output/access_profiles/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: access_profiles-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: access_profiles-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'access_profiles', 'methods'] +slug: /tools/sdk/typescript/access_profiles/methods +tags: ['SDK', 'Software Development Kit', 'access_profiles', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/access_profiles/docs/Models/Accessduration.md b/sdk-output/access_profiles/docs/Models/Accessduration.md new file mode 100644 index 00000000..7704ca67 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessduration.md @@ -0,0 +1,20 @@ +--- +id: v1-accessduration-v1 +title: AccessdurationV1 +pagination_label: AccessdurationV1 +sidebar_label: AccessdurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessdurationV1', 'v1AccessdurationV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessduration-v1 +tags: ['SDK', 'Software Development Kit', 'AccessdurationV1', 'v1AccessdurationV1'] +--- + +# AccessdurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value representing the amount of time, which is defined in the **timeUnit**. | [default to undefined] +**timeUnit** | **(optional)** **string** | The unit of time that corresponds to the **value**. It defines the scale of the time period. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessmodelmetadata.md b/sdk-output/access_profiles/docs/Models/Accessmodelmetadata.md new file mode 100644 index 00000000..57e3cf02 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessmodelmetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-accessmodelmetadata-v1 +title: AccessmodelmetadataV1 +pagination_label: AccessmodelmetadataV1 +sidebar_label: AccessmodelmetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessmodelmetadata-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +--- + +# AccessmodelmetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Unique identifier for the metadata type | [default to undefined] +**name** | **(optional)** **string** | Human readable name of the metadata type | [default to undefined] +**multiselect** | **(optional)** **boolean** | Allows selecting multiple values | [default to false] +**status** | **(optional)** **string** | The state of the metadata item | [default to undefined] +**type** | **(optional)** **string** | The type of the metadata item | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | The types of objects | [default to undefined] +**description** | **(optional)** **string** | Describes the metadata item | [default to undefined] +**values** | **(optional)** **Array<AccessmodelmetadataValuesInnerV1>** | The value to assign to the metadata item | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/AccessmodelmetadataValuesInner.md b/sdk-output/access_profiles/docs/Models/AccessmodelmetadataValuesInner.md new file mode 100644 index 00000000..7dd7f52d --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/AccessmodelmetadataValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessmodelmetadata-values-inner-v1 +title: AccessmodelmetadataValuesInnerV1 +pagination_label: AccessmodelmetadataValuesInnerV1 +sidebar_label: AccessmodelmetadataValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessmodelmetadata-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +--- + +# AccessmodelmetadataValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The value to assign to the metdata item | [default to undefined] +**name** | **(optional)** **string** | Display name of the value | [default to undefined] +**status** | **(optional)** **string** | The status of the individual value | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofile.md b/sdk-output/access_profiles/docs/Models/Accessprofile.md new file mode 100644 index 00000000..39a77cd0 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofile.md @@ -0,0 +1,34 @@ +--- +id: v1-accessprofile-v1 +title: AccessprofileV1 +pagination_label: AccessprofileV1 +sidebar_label: AccessprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileV1', 'v1AccessprofileV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofile-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileV1', 'v1AccessprofileV1'] +--- + +# AccessprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Access profile ID. | [readonly] [default to undefined] +**name** | **string** | Access profile name. | [default to undefined] +**description** | **(optional)** **string** | Access profile description. | [default to undefined] +**created** | **(optional)** **string** | Date and time when the access profile was created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Date and time when the access profile was last modified. | [readonly] [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. | [default to false] +**owner** | **OwnerreferenceV1** | | [default to undefined] +**source** | **AccessprofilesourcerefV1** | | [default to undefined] +**entitlements** | **(optional)** **Array<EntitlementrefV1>** | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [default to undefined] +**requestable** | **(optional)** **boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [default to true] +**accessRequestConfig** | **(optional)** **RequestabilityV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **RevocabilityV1** | | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of segment IDs, if any, that the access profile is assigned to. | [default to undefined] +**accessModelMetadata** | **(optional)** **AttributedtolistV1** | | [default to undefined] +**provisioningCriteria** | **(optional)** **Provisioningcriterialevel1V1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofileapprovalscheme.md b/sdk-output/access_profiles/docs/Models/Accessprofileapprovalscheme.md new file mode 100644 index 00000000..e6e4145b --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofileapprovalscheme.md @@ -0,0 +1,20 @@ +--- +id: v1-accessprofileapprovalscheme-v1 +title: AccessprofileapprovalschemeV1 +pagination_label: AccessprofileapprovalschemeV1 +sidebar_label: AccessprofileapprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileapprovalschemeV1', 'v1AccessprofileapprovalschemeV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofileapprovalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileapprovalschemeV1', 'v1AccessprofileapprovalschemeV1'] +--- + +# AccessprofileapprovalschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleterequest.md b/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleterequest.md new file mode 100644 index 00000000..7edd5732 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleterequest.md @@ -0,0 +1,20 @@ +--- +id: v1-accessprofilebulkdeleterequest-v1 +title: AccessprofilebulkdeleterequestV1 +pagination_label: AccessprofilebulkdeleterequestV1 +sidebar_label: AccessprofilebulkdeleterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilebulkdeleterequestV1', 'v1AccessprofilebulkdeleterequestV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofilebulkdeleterequest-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilebulkdeleterequestV1', 'v1AccessprofilebulkdeleterequestV1'] +--- + +# AccessprofilebulkdeleterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessProfileIds** | **(optional)** **Array<string>** | List of IDs of Access Profiles to be deleted. | [default to undefined] +**bestEffortOnly** | **(optional)** **boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleteresponse.md b/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleteresponse.md new file mode 100644 index 00000000..660c292b --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofilebulkdeleteresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofilebulkdeleteresponse-v1 +title: AccessprofilebulkdeleteresponseV1 +pagination_label: AccessprofilebulkdeleteresponseV1 +sidebar_label: AccessprofilebulkdeleteresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilebulkdeleteresponseV1', 'v1AccessprofilebulkdeleteresponseV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofilebulkdeleteresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilebulkdeleteresponseV1', 'v1AccessprofilebulkdeleteresponseV1'] +--- + +# AccessprofilebulkdeleteresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taskId** | **(optional)** **string** | ID of the task which is executing the bulk deletion. This can be passed to the **_/task-status** API to track status. | [default to undefined] +**pending** | **(optional)** **Array<string>** | List of IDs of Access Profiles which are pending deletion. | [default to undefined] +**inUse** | **(optional)** **Array<AccessprofileusageV1>** | List of usages of Access Profiles targeted for deletion. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/AccessprofilebulkupdaterequestInner.md b/sdk-output/access_profiles/docs/Models/AccessprofilebulkupdaterequestInner.md new file mode 100644 index 00000000..3f8f7348 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/AccessprofilebulkupdaterequestInner.md @@ -0,0 +1,20 @@ +--- +id: v1-accessprofilebulkupdaterequest-inner-v1 +title: AccessprofilebulkupdaterequestInnerV1 +pagination_label: AccessprofilebulkupdaterequestInnerV1 +sidebar_label: AccessprofilebulkupdaterequestInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilebulkupdaterequestInnerV1', 'v1AccessprofilebulkupdaterequestInnerV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofilebulkupdaterequest-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilebulkupdaterequestInnerV1', 'v1AccessprofilebulkupdaterequestInnerV1'] +--- + +# AccessprofilebulkupdaterequestInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Access Profile ID. | [default to undefined] +**requestable** | **(optional)** **boolean** | Access Profile is requestable or not. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofilesourceref.md b/sdk-output/access_profiles/docs/Models/Accessprofilesourceref.md new file mode 100644 index 00000000..6fcd422c --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofilesourceref.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofilesourceref-v1 +title: AccessprofilesourcerefV1 +pagination_label: AccessprofilesourcerefV1 +sidebar_label: AccessprofilesourcerefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilesourcerefV1', 'v1AccessprofilesourcerefV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofilesourceref-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilesourcerefV1', 'v1AccessprofilesourcerefV1'] +--- + +# AccessprofilesourcerefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the source the access profile is associated with. | [default to undefined] +**type** | **(optional)** **string** | Source\'s DTO type. | [default to undefined] +**name** | **(optional)** **string** | Source name. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofileupdateitem.md b/sdk-output/access_profiles/docs/Models/Accessprofileupdateitem.md new file mode 100644 index 00000000..8c4b992f --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofileupdateitem.md @@ -0,0 +1,22 @@ +--- +id: v1-accessprofileupdateitem-v1 +title: AccessprofileupdateitemV1 +pagination_label: AccessprofileupdateitemV1 +sidebar_label: AccessprofileupdateitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileupdateitemV1', 'v1AccessprofileupdateitemV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofileupdateitem-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileupdateitemV1', 'v1AccessprofileupdateitemV1'] +--- + +# AccessprofileupdateitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Identifier of Access Profile in bulk update request. | [default to undefined] +**requestable** | **boolean** | Access Profile requestable or not. | [default to undefined] +**status** | **string** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [default to undefined] +**description** | **(optional)** **string** | Human readable status description and containing additional context information about success or failures etc. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Accessprofileusage.md b/sdk-output/access_profiles/docs/Models/Accessprofileusage.md new file mode 100644 index 00000000..559ddb0a --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Accessprofileusage.md @@ -0,0 +1,20 @@ +--- +id: v1-accessprofileusage-v1 +title: AccessprofileusageV1 +pagination_label: AccessprofileusageV1 +sidebar_label: AccessprofileusageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileusageV1', 'v1AccessprofileusageV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofileusage-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileusageV1', 'v1AccessprofileusageV1'] +--- + +# AccessprofileusageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessProfileId** | **(optional)** **string** | ID of the Access Profile that is in use | [default to undefined] +**usedBy** | **(optional)** **Array<AccessprofileusageUsedByInnerV1>** | List of references to objects which are using the indicated Access Profile | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/AccessprofileusageUsedByInner.md b/sdk-output/access_profiles/docs/Models/AccessprofileusageUsedByInner.md new file mode 100644 index 00000000..cd5e7c59 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/AccessprofileusageUsedByInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofileusage-used-by-inner-v1 +title: AccessprofileusageUsedByInnerV1 +pagination_label: AccessprofileusageUsedByInnerV1 +sidebar_label: AccessprofileusageUsedByInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileusageUsedByInnerV1', 'v1AccessprofileusageUsedByInnerV1'] +slug: /tools/sdk/typescript/access_profiles/models/accessprofileusage-used-by-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileusageUsedByInnerV1', 'v1AccessprofileusageUsedByInnerV1'] +--- + +# AccessprofileusageUsedByInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of role using the access profile. | [default to undefined] +**id** | **(optional)** **string** | ID of role using the access profile. | [default to undefined] +**name** | **(optional)** **string** | Display name of role using the access profile. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Additionalownerref.md b/sdk-output/access_profiles/docs/Models/Additionalownerref.md new file mode 100644 index 00000000..cb3780ca --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Additionalownerref.md @@ -0,0 +1,21 @@ +--- +id: v1-additionalownerref-v1 +title: AdditionalownerrefV1 +pagination_label: AdditionalownerrefV1 +sidebar_label: AdditionalownerrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +slug: /tools/sdk/typescript/access_profiles/models/additionalownerref-v1 +tags: ['SDK', 'Software Development Kit', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +--- + +# AdditionalownerrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity or governance group. | [default to undefined] +**name** | **(optional)** **string** | Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/ArrayInner.md b/sdk-output/access_profiles/docs/Models/ArrayInner.md new file mode 100644 index 00000000..a1988573 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/access_profiles/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/access_profiles/docs/Models/Attributedto.md b/sdk-output/access_profiles/docs/Models/Attributedto.md new file mode 100644 index 00000000..46b7bf25 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Attributedto.md @@ -0,0 +1,26 @@ +--- +id: v1-attributedto-v1 +title: AttributedtoV1 +pagination_label: AttributedtoV1 +sidebar_label: AttributedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtoV1', 'v1AttributedtoV1'] +slug: /tools/sdk/typescript/access_profiles/models/attributedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtoV1', 'v1AttributedtoV1'] +--- + +# AttributedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the key. | [default to undefined] +**multiselect** | **(optional)** **boolean** | Indicates whether the attribute can have multiple values. | [default to false] +**status** | **(optional)** **string** | The status of the Attribute. | [default to undefined] +**type** | **(optional)** **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [default to undefined] +**description** | **(optional)** **string** | The description of the Attribute. | [default to undefined] +**values** | **(optional)** **Array<AttributevaluedtoV1>** | | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Attributedtolist.md b/sdk-output/access_profiles/docs/Models/Attributedtolist.md new file mode 100644 index 00000000..08ddb1b6 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Attributedtolist.md @@ -0,0 +1,19 @@ +--- +id: v1-attributedtolist-v1 +title: AttributedtolistV1 +pagination_label: AttributedtolistV1 +sidebar_label: AttributedtolistV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtolistV1', 'v1AttributedtolistV1'] +slug: /tools/sdk/typescript/access_profiles/models/attributedtolist-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtolistV1', 'v1AttributedtolistV1'] +--- + +# AttributedtolistV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AttributedtoV1>** | | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Attributevaluedto.md b/sdk-output/access_profiles/docs/Models/Attributevaluedto.md new file mode 100644 index 00000000..a2fe0ee9 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Attributevaluedto.md @@ -0,0 +1,21 @@ +--- +id: v1-attributevaluedto-v1 +title: AttributevaluedtoV1 +pagination_label: AttributevaluedtoV1 +sidebar_label: AttributevaluedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +slug: /tools/sdk/typescript/access_profiles/models/attributevaluedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +--- + +# AttributevaluedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the Attribute value. | [default to undefined] +**status** | **(optional)** **string** | The status of the Attribute value. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Entitlement.md b/sdk-output/access_profiles/docs/Models/Entitlement.md new file mode 100644 index 00000000..6339da71 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Entitlement.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlement-v1 +title: EntitlementV1 +pagination_label: EntitlementV1 +sidebar_label: EntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementV1', 'v1EntitlementV1'] +slug: /tools/sdk/typescript/access_profiles/models/entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementV1', 'v1EntitlementV1'] +--- + +# EntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | True if the entitlement is privileged | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **EntitlementOwnerV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **EntitlementAccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **EntitlementSourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/EntitlementAccessModelMetadata.md b/sdk-output/access_profiles/docs/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 00000000..f836a011 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlement-access-model-metadata-v1 +title: EntitlementAccessModelMetadataV1 +pagination_label: EntitlementAccessModelMetadataV1 +sidebar_label: EntitlementAccessModelMetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +slug: /tools/sdk/typescript/access_profiles/models/entitlement-access-model-metadata-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +--- + +# EntitlementAccessModelMetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AccessmodelmetadataV1>** | | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/EntitlementOwner.md b/sdk-output/access_profiles/docs/Models/EntitlementOwner.md new file mode 100644 index 00000000..26d08585 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/EntitlementOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-owner-v1 +title: EntitlementOwnerV1 +pagination_label: EntitlementOwnerV1 +sidebar_label: EntitlementOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +slug: /tools/sdk/typescript/access_profiles/models/entitlement-owner-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +--- + +# EntitlementOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | The type of object | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/EntitlementSource.md b/sdk-output/access_profiles/docs/Models/EntitlementSource.md new file mode 100644 index 00000000..fa20c02c --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/EntitlementSource.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-source-v1 +title: EntitlementSourceV1 +pagination_label: EntitlementSourceV1 +sidebar_label: EntitlementSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +slug: /tools/sdk/typescript/access_profiles/models/entitlement-source-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +--- + +# EntitlementSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Entitlementref.md b/sdk-output/access_profiles/docs/Models/Entitlementref.md new file mode 100644 index 00000000..bde29cef --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Entitlementref.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementref-v1 +title: EntitlementrefV1 +pagination_label: EntitlementrefV1 +sidebar_label: EntitlementrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrefV1', 'v1EntitlementrefV1'] +slug: /tools/sdk/typescript/access_profiles/models/entitlementref-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrefV1', 'v1EntitlementrefV1'] +--- + +# EntitlementrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Entitlement\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Entitlement\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Entitlement\'s display name. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Errormessagedto.md b/sdk-output/access_profiles/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..72cb2f22 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/access_profiles/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Errorresponsedto.md b/sdk-output/access_profiles/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..63a7daee --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/access_profiles/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Index.md b/sdk-output/access_profiles/docs/Models/Index.md new file mode 100644 index 00000000..18e7f358 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: access_profiles-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: access_profiles-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'access_profiles', 'models'] +slug: /tools/sdk/typescript/access_profiles/models +tags: ['SDK', 'Software Development Kit', 'access_profiles', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/access_profiles/docs/Models/Jsonpatchoperation.md b/sdk-output/access_profiles/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..ca128c47 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/access_profiles/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/JsonpatchoperationValue.md b/sdk-output/access_profiles/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..44124009 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/access_profiles/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1401Response.md b/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1401Response.md new file mode 100644 index 00000000..1476dd9a --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-access-profiles-v1401-response-v1 +title: ListAccessProfilesV1401ResponseV1 +pagination_label: ListAccessProfilesV1401ResponseV1 +sidebar_label: ListAccessProfilesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccessProfilesV1401ResponseV1', 'v1ListAccessProfilesV1401ResponseV1'] +slug: /tools/sdk/typescript/access_profiles/models/list-access-profiles-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccessProfilesV1401ResponseV1', 'v1ListAccessProfilesV1401ResponseV1'] +--- + +# ListAccessProfilesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1429Response.md b/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1429Response.md new file mode 100644 index 00000000..ada6f9e1 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/ListAccessProfilesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-access-profiles-v1429-response-v1 +title: ListAccessProfilesV1429ResponseV1 +pagination_label: ListAccessProfilesV1429ResponseV1 +sidebar_label: ListAccessProfilesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccessProfilesV1429ResponseV1', 'v1ListAccessProfilesV1429ResponseV1'] +slug: /tools/sdk/typescript/access_profiles/models/list-access-profiles-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccessProfilesV1429ResponseV1', 'v1ListAccessProfilesV1429ResponseV1'] +--- + +# ListAccessProfilesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Localeorigin.md b/sdk-output/access_profiles/docs/Models/Localeorigin.md new file mode 100644 index 00000000..da4e0219 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/access_profiles/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/access_profiles/docs/Models/Ownerreference.md b/sdk-output/access_profiles/docs/Models/Ownerreference.md new file mode 100644 index 00000000..81a25bea --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Ownerreference.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerreference-v1 +title: OwnerreferenceV1 +pagination_label: OwnerreferenceV1 +sidebar_label: OwnerreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +slug: /tools/sdk/typescript/access_profiles/models/ownerreference-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +--- + +# OwnerreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Permissiondto.md b/sdk-output/access_profiles/docs/Models/Permissiondto.md new file mode 100644 index 00000000..746e7e90 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/access_profiles/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel1.md b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel1.md new file mode 100644 index 00000000..353e12cb --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel1.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel1-v1 +title: Provisioningcriterialevel1V1 +pagination_label: Provisioningcriterialevel1V1 +sidebar_label: Provisioningcriterialevel1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel1V1', 'v1Provisioningcriterialevel1V1'] +slug: /tools/sdk/typescript/access_profiles/models/provisioningcriterialevel1-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel1V1', 'v1Provisioningcriterialevel1V1'] +--- + +# Provisioningcriterialevel1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **Array<Provisioningcriterialevel2V1>** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel2.md b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel2.md new file mode 100644 index 00000000..781abb49 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel2.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel2-v1 +title: Provisioningcriterialevel2V1 +pagination_label: Provisioningcriterialevel2V1 +sidebar_label: Provisioningcriterialevel2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel2V1', 'v1Provisioningcriterialevel2V1'] +slug: /tools/sdk/typescript/access_profiles/models/provisioningcriterialevel2-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel2V1', 'v1Provisioningcriterialevel2V1'] +--- + +# Provisioningcriterialevel2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **Array<Provisioningcriterialevel3V1>** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel3.md b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel3.md new file mode 100644 index 00000000..e2f92560 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Provisioningcriterialevel3.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel3-v1 +title: Provisioningcriterialevel3V1 +pagination_label: Provisioningcriterialevel3V1 +sidebar_label: Provisioningcriterialevel3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel3V1', 'v1Provisioningcriterialevel3V1'] +slug: /tools/sdk/typescript/access_profiles/models/provisioningcriterialevel3-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel3V1', 'v1Provisioningcriterialevel3V1'] +--- + +# Provisioningcriterialevel3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **string** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Provisioningcriteriaoperation.md b/sdk-output/access_profiles/docs/Models/Provisioningcriteriaoperation.md new file mode 100644 index 00000000..dc30cb48 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Provisioningcriteriaoperation.md @@ -0,0 +1,29 @@ +--- +id: v1-provisioningcriteriaoperation-v1 +title: ProvisioningcriteriaoperationV1 +pagination_label: ProvisioningcriteriaoperationV1 +sidebar_label: ProvisioningcriteriaoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcriteriaoperationV1', 'v1ProvisioningcriteriaoperationV1'] +slug: /tools/sdk/typescript/access_profiles/models/provisioningcriteriaoperation-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcriteriaoperationV1', 'v1ProvisioningcriteriaoperationV1'] +--- + +# ProvisioningcriteriaoperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `NotEquals` (value: `'NOT_EQUALS'`) + +* `Contains` (value: `'CONTAINS'`) + +* `Has` (value: `'HAS'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/access_profiles/docs/Models/README.md b/sdk-output/access_profiles/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_profiles/docs/Models/Requestability.md b/sdk-output/access_profiles/docs/Models/Requestability.md new file mode 100644 index 00000000..2ed05721 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Requestability.md @@ -0,0 +1,24 @@ +--- +id: v1-requestability-v1 +title: RequestabilityV1 +pagination_label: RequestabilityV1 +sidebar_label: RequestabilityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestabilityV1', 'v1RequestabilityV1'] +slug: /tools/sdk/typescript/access_profiles/models/requestability-v1 +tags: ['SDK', 'Software Development Kit', 'RequestabilityV1', 'v1RequestabilityV1'] +--- + +# RequestabilityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentsRequired** | **(optional)** **boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [default to false] +**denialCommentsRequired** | **(optional)** **boolean** | Indicates whether an approver must provide comments when denying the request. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Indicates whether reauthorization is required for the request. | [default to false] +**requireEndDate** | **(optional)** **boolean** | Indicates whether the requester of the containing object must provide access end date. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **AccessdurationV1** | | [default to undefined] +**approvalSchemes** | **(optional)** **Array<AccessprofileapprovalschemeV1>** | List describing the steps involved in approving the request. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/Revocability.md b/sdk-output/access_profiles/docs/Models/Revocability.md new file mode 100644 index 00000000..72f18c6e --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/Revocability.md @@ -0,0 +1,19 @@ +--- +id: v1-revocability-v1 +title: RevocabilityV1 +pagination_label: RevocabilityV1 +sidebar_label: RevocabilityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RevocabilityV1', 'v1RevocabilityV1'] +slug: /tools/sdk/typescript/access_profiles/models/revocability-v1 +tags: ['SDK', 'Software Development Kit', 'RevocabilityV1', 'v1RevocabilityV1'] +--- + +# RevocabilityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<AccessprofileapprovalschemeV1>** | List describing the steps involved in approving the revocation request. | [default to undefined] + diff --git a/sdk-output/access_profiles/docs/Models/UpdateAccessProfilesInBulkV1412Response.md b/sdk-output/access_profiles/docs/Models/UpdateAccessProfilesInBulkV1412Response.md new file mode 100644 index 00000000..af96cf46 --- /dev/null +++ b/sdk-output/access_profiles/docs/Models/UpdateAccessProfilesInBulkV1412Response.md @@ -0,0 +1,19 @@ +--- +id: v1-update-access-profiles-in-bulk-v1412-response-v1 +title: UpdateAccessProfilesInBulkV1412ResponseV1 +pagination_label: UpdateAccessProfilesInBulkV1412ResponseV1 +sidebar_label: UpdateAccessProfilesInBulkV1412ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdateAccessProfilesInBulkV1412ResponseV1', 'v1UpdateAccessProfilesInBulkV1412ResponseV1'] +slug: /tools/sdk/typescript/access_profiles/models/update-access-profiles-in-bulk-v1412-response-v1 +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulkV1412ResponseV1', 'v1UpdateAccessProfilesInBulkV1412ResponseV1'] +--- + +# UpdateAccessProfilesInBulkV1412ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/access_request_approvals/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..7dac0163 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,122 @@ +- path: /access-request-approvals/v1/{approvalId}/approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#approve-access-request-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const approvalId: string = '2c91808b7294bea301729568c68c002e'; // string | Approval ID. (default to undefined) + const commentdtoV1: CommentdtoV1 = ; // CommentdtoV1 | Reviewer\'s comment. (optional) + const result = await apiInstance.approveAccessRequestV1(approvalId); + console.log(result); +- path: /access-request-approvals/v1/{approvalId}/forward + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#forward-access-request-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const approvalId: string = '2c91808b7294bea301729568c68c002e'; // string | Approval ID. (default to undefined) + const forwardapprovaldtoV1: ForwardapprovaldtoV1 = ; // ForwardapprovaldtoV1 | Information about the forwarded approval. + const result = await apiInstance.forwardAccessRequestV1(approvalId, forwardapprovaldtoV1); + console.log(result); +- path: /access-request-approvals/v1/approval-summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#get-access-request-approval-summary-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const ownerId: string = '2c91808568c529c60168cca6f90c1313'; // string | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) (default to undefined) + const fromDate: string = 'from-date=2020-03-19T19:59:11Z'; // string | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) (default to undefined) + const result = await apiInstance.getAccessRequestApprovalSummaryV1(); + console.log(result); +- path: /access-request-approvals/v1/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#list-access-request-approvers-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const accessRequestId: string = '2c91808568c529c60168cca6f90c1313'; // string | Access Request ID. (default to undefined) + const limit: number = 100; // number | Max number of results to return. (optional) (default to 250) + const offset: number = 10; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) (default to undefined) + const count: boolean = false; // boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + const result = await apiInstance.listAccessRequestApproversV1(accessRequestId); + console.log(result); +- path: /access-request-approvals/v1/completed + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#list-completed-approvals-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const ownerId: string = '2c91808568c529c60168cca6f90c1313'; // string | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "2c91808568c529c60168cca6f90c1313"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) (default to undefined) + const sorters: string = 'modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) (default to undefined) + const result = await apiInstance.listCompletedApprovalsV1(); + console.log(result); +- path: /access-request-approvals/v1/pending + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#list-pending-approvals-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const ownerId: string = '2c91808568c529c60168cca6f90c1313'; // string | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "2c91808568c529c60168cca6f90c1313"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) (default to undefined) + const sorters: string = 'modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) (default to undefined) + const result = await apiInstance.listPendingApprovalsV1(); + console.log(result); +- path: /access-request-approvals/v1/{approvalId}/reject + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_approvals/methods/access-request-approvals#reject-access-request-v1 + source: | + import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestApprovalsV1Api(configuration); + const approvalId: string = '2c91808b7294bea301729568c68c002e'; // string | Approval ID. (default to undefined) + const commentdtoV1: CommentdtoV1 = ; // CommentdtoV1 | Reviewer\'s comment. + const result = await apiInstance.rejectAccessRequestV1(approvalId, commentdtoV1); + console.log(result); diff --git a/sdk-output/access_request_approvals/docs/Methods/AccessRequestApprovalsV1Api.md b/sdk-output/access_request_approvals/docs/Methods/AccessRequestApprovalsV1Api.md new file mode 100644 index 00000000..31a8297c --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Methods/AccessRequestApprovalsV1Api.md @@ -0,0 +1,344 @@ +--- +id: v1-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessRequestApprovals', 'v1AccessRequestApprovals'] +slug: /tools/sdk/typescript/access_request_approvals/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'v1AccessRequestApprovals'] +--- + +# AccessRequestApprovalsV1Api + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-access-request-v1**](#approve-access-request-v1) | **POST** `/access-request-approvals/v1/{approvalId}/approve` | Approve access request approval +[**forward-access-request-v1**](#forward-access-request-v1) | **POST** `/access-request-approvals/v1/{approvalId}/forward` | Forward access request approval +[**get-access-request-approval-summary-v1**](#get-access-request-approval-summary-v1) | **GET** `/access-request-approvals/v1/approval-summary` | Get access requests approvals number +[**list-access-request-approvers-v1**](#list-access-request-approvers-v1) | **GET** `/access-request-approvals/v1/{accessRequestId}/approvers` | Access request approvers +[**list-completed-approvals-v1**](#list-completed-approvals-v1) | **GET** `/access-request-approvals/v1/completed` | Completed access request approvals list +[**list-pending-approvals-v1**](#list-pending-approvals-v1) | **GET** `/access-request-approvals/v1/pending` | Pending access request approvals list +[**reject-access-request-v1**](#reject-access-request-v1) | **POST** `/access-request-approvals/v1/{approvalId}/reject` | Reject access request approval + + +## approve-access-request-v1 +Approve access request approval +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**approvalId** | **string** | Approval ID. | [default to undefined] +**commentdtoV1** | **CommentdtoV1** | Reviewer\'s comment. | [optional] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const approvalId: string = 2c91808b7294bea301729568c68c002e; // Approval ID. +const commentdtoV1: CommentdtoV1 = ; // Reviewer\'s comment. (optional) +const result = await apiInstance.approveAccessRequestV1(approvalId); +console.log(result); +``` + +[[Back to top]](#) + +## forward-access-request-v1 +Forward access request approval +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/forward-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**approvalId** | **string** | Approval ID. | [default to undefined] +**forwardapprovaldtoV1** | **ForwardapprovaldtoV1** | Information about the forwarded approval. | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const approvalId: string = 2c91808b7294bea301729568c68c002e; // Approval ID. +const forwardapprovaldtoV1: ForwardapprovaldtoV1 = ; // Information about the forwarded approval. +const result = await apiInstance.forwardAccessRequestV1(approvalId, forwardapprovaldtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-approval-summary-v1 +Get access requests approvals number +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-approval-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. | [optional] [default to undefined] +**fromDate** | **string** | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. | [optional] [default to undefined] + +### Return type + +**ApprovalsummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const ownerId: string = 2c91808568c529c60168cca6f90c1313; // The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +const fromDate: string = from-date=2020-03-19T19:59:11Z; // This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) +const result = await apiInstance.getAccessRequestApprovalSummaryV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-request-approvers-v1 +Access request approvers +This API endpoint returns the list of approvers for the given access request id. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-request-approvers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessRequestId** | **string** | Access Request ID. | [default to undefined] +**limit** | **number** | Max number of results to return. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | [optional] [default to undefined] +**count** | **boolean** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const accessRequestId: string = 2c91808568c529c60168cca6f90c1313; // Access Request ID. +const limit: number = 100; // Max number of results to return. (optional) +const offset: number = 10; // Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +const count: boolean = false; // If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) +const result = await apiInstance.listAccessRequestApproversV1(accessRequestId); +console.log(result); +``` + +[[Back to top]](#) + +## list-completed-approvals-v1 +Completed access request approvals list +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-completed-approvals-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const ownerId: string = 2c91808568c529c60168cca6f90c1313; // If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "2c91808568c529c60168cca6f90c1313"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) +const sorters: string = modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) +const result = await apiInstance.listCompletedApprovalsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-pending-approvals-v1 +Pending access request approvals list +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-pending-approvals-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const ownerId: string = 2c91808568c529c60168cca6f90c1313; // If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "2c91808568c529c60168cca6f90c1313"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) +const sorters: string = modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) +const result = await apiInstance.listPendingApprovalsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## reject-access-request-v1 +Reject access request approval +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**approvalId** | **string** | Approval ID. | [default to undefined] +**commentdtoV1** | **CommentdtoV1** | Reviewer\'s comment. | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestApprovalsV1Api(configuration); +const approvalId: string = 2c91808b7294bea301729568c68c002e; // Approval ID. +const commentdtoV1: CommentdtoV1 = ; // Reviewer\'s comment. +const result = await apiInstance.rejectAccessRequestV1(approvalId, commentdtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/access_request_approvals/docs/Methods/Index.md b/sdk-output/access_request_approvals/docs/Methods/Index.md new file mode 100644 index 00000000..6aef7ad5 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: access_request_approvals-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: access_request_approvals-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'access_request_approvals', 'methods'] +slug: /tools/sdk/typescript/access_request_approvals/methods +tags: ['SDK', 'Software Development Kit', 'access_request_approvals', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/access_request_approvals/docs/Models/Accessitemrequestedfor.md b/sdk-output/access_request_approvals/docs/Models/Accessitemrequestedfor.md new file mode 100644 index 00000000..8f692e27 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Accessitemrequestedfor.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemrequestedfor-v1 +title: AccessitemrequestedforV1 +pagination_label: AccessitemrequestedforV1 +sidebar_label: AccessitemrequestedforV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrequestedforV1', 'v1AccessitemrequestedforV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/accessitemrequestedfor-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrequestedforV1', 'v1AccessitemrequestedforV1'] +--- + +# AccessitemrequestedforV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity the access item is requested for. | [default to undefined] +**id** | **(optional)** **string** | ID of identity the access item is requested for. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity the access item is requested for. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Accessitemrequester.md b/sdk-output/access_request_approvals/docs/Models/Accessitemrequester.md new file mode 100644 index 00000000..3917b56b --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Accessitemrequester.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemrequester-v1 +title: AccessitemrequesterV1 +pagination_label: AccessitemrequesterV1 +sidebar_label: AccessitemrequesterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrequesterV1', 'v1AccessitemrequesterV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/accessitemrequester-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrequesterV1', 'v1AccessitemrequesterV1'] +--- + +# AccessitemrequesterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Access item requester\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Access item requester\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Access item owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Accessitemreviewedby.md b/sdk-output/access_request_approvals/docs/Models/Accessitemreviewedby.md new file mode 100644 index 00000000..96b41ad3 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Accessitemreviewedby.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemreviewedby-v1 +title: AccessitemreviewedbyV1 +pagination_label: AccessitemreviewedbyV1 +sidebar_label: AccessitemreviewedbyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemreviewedbyV1', 'v1AccessitemreviewedbyV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/accessitemreviewedby-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemreviewedbyV1', 'v1AccessitemreviewedbyV1'] +--- + +# AccessitemreviewedbyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity who reviewed the access item request. | [default to undefined] +**id** | **(optional)** **string** | ID of identity who reviewed the access item request. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity who reviewed the access item request. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Accessrequestapproverslistresponse.md b/sdk-output/access_request_approvals/docs/Models/Accessrequestapproverslistresponse.md new file mode 100644 index 00000000..10909205 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Accessrequestapproverslistresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-accessrequestapproverslistresponse-v1 +title: AccessrequestapproverslistresponseV1 +pagination_label: AccessrequestapproverslistresponseV1 +sidebar_label: AccessrequestapproverslistresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestapproverslistresponseV1', 'v1AccessrequestapproverslistresponseV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/accessrequestapproverslistresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestapproverslistresponseV1', 'v1AccessrequestapproverslistresponseV1'] +--- + +# AccessrequestapproverslistresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Approver id. | [default to undefined] +**email** | **(optional)** **string** | Email of the approver. | [default to undefined] +**name** | **(optional)** **string** | Name of the approver. | [default to undefined] +**approvalId** | **(optional)** **string** | Id of the approval item. | [default to undefined] +**type** | **(optional)** **string** | Type of the object returned. In this case, the value for this field will always Identity. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Accessrequesttype.md b/sdk-output/access_request_approvals/docs/Models/Accessrequesttype.md new file mode 100644 index 00000000..f9c7252f --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Accessrequesttype.md @@ -0,0 +1,23 @@ +--- +id: v1-accessrequesttype-v1 +title: AccessrequesttypeV1 +pagination_label: AccessrequesttypeV1 +sidebar_label: AccessrequesttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequesttypeV1', 'v1AccessrequesttypeV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/accessrequesttype-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequesttypeV1', 'v1AccessrequesttypeV1'] +--- + +# AccessrequesttypeV1 + +## Enum + + +* `GrantAccess` (value: `'GRANT_ACCESS'`) + +* `RevokeAccess` (value: `'REVOKE_ACCESS'`) + +* `ModifyAccess` (value: `'MODIFY_ACCESS'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/Approvalforwardhistory.md b/sdk-output/access_request_approvals/docs/Models/Approvalforwardhistory.md new file mode 100644 index 00000000..f5d4d0ff --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Approvalforwardhistory.md @@ -0,0 +1,24 @@ +--- +id: v1-approvalforwardhistory-v1 +title: ApprovalforwardhistoryV1 +pagination_label: ApprovalforwardhistoryV1 +sidebar_label: ApprovalforwardhistoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalforwardhistoryV1', 'v1ApprovalforwardhistoryV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/approvalforwardhistory-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalforwardhistoryV1', 'v1ApprovalforwardhistoryV1'] +--- + +# ApprovalforwardhistoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**oldApproverName** | **(optional)** **string** | Display name of approver from whom the approval was forwarded. | [default to undefined] +**newApproverName** | **(optional)** **string** | Display name of approver to whom the approval was forwarded. | [default to undefined] +**comment** | **(optional)** **string** | Comment made while forwarding. | [default to undefined] +**modified** | **(optional)** **string** | Time at which approval was forwarded. | [default to undefined] +**forwarderName** | **(optional)** **string** | Display name of forwarder who forwarded the approval. | [default to undefined] +**reassignmentType** | **(optional)** **ReassignmenttypeV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Approvalsummary.md b/sdk-output/access_request_approvals/docs/Models/Approvalsummary.md new file mode 100644 index 00000000..f676c0fa --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Approvalsummary.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalsummary-v1 +title: ApprovalsummaryV1 +pagination_label: ApprovalsummaryV1 +sidebar_label: ApprovalsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalsummaryV1', 'v1ApprovalsummaryV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/approvalsummary-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalsummaryV1', 'v1ApprovalsummaryV1'] +--- + +# ApprovalsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pending** | **(optional)** **number** | The number of pending access requests approvals. | [default to undefined] +**approved** | **(optional)** **number** | The number of approved access requests approvals. | [default to undefined] +**rejected** | **(optional)** **number** | The number of rejected access requests approvals. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Commentdto.md b/sdk-output/access_request_approvals/docs/Models/Commentdto.md new file mode 100644 index 00000000..965d3af7 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Commentdto.md @@ -0,0 +1,21 @@ +--- +id: v1-commentdto-v1 +title: CommentdtoV1 +pagination_label: CommentdtoV1 +sidebar_label: CommentdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommentdtoV1', 'v1CommentdtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/commentdto-v1 +tags: ['SDK', 'Software Development Kit', 'CommentdtoV1', 'v1CommentdtoV1'] +--- + +# CommentdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment content. | [default to undefined] +**created** | **(optional)** **string** | Date and time comment was created. | [default to undefined] +**author** | **(optional)** **CommentdtoAuthorV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/CommentdtoAuthor.md b/sdk-output/access_request_approvals/docs/Models/CommentdtoAuthor.md new file mode 100644 index 00000000..b3133fde --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/CommentdtoAuthor.md @@ -0,0 +1,21 @@ +--- +id: v1-commentdto-author-v1 +title: CommentdtoAuthorV1 +pagination_label: CommentdtoAuthorV1 +sidebar_label: CommentdtoAuthorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommentdtoAuthorV1', 'v1CommentdtoAuthorV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/commentdto-author-v1 +tags: ['SDK', 'Software Development Kit', 'CommentdtoAuthorV1', 'v1CommentdtoAuthorV1'] +--- + +# CommentdtoAuthorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object | [default to undefined] +**id** | **(optional)** **string** | The unique ID of the object | [default to undefined] +**name** | **(optional)** **string** | The display name of the object | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Completedapproval.md b/sdk-output/access_request_approvals/docs/Models/Completedapproval.md new file mode 100644 index 00000000..2e58784e --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Completedapproval.md @@ -0,0 +1,47 @@ +--- +id: v1-completedapproval-v1 +title: CompletedapprovalV1 +pagination_label: CompletedapprovalV1 +sidebar_label: CompletedapprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalV1', 'v1CompletedapprovalV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapproval-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalV1', 'v1CompletedapprovalV1'] +--- + +# CompletedapprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The approval id. | [default to undefined] +**name** | **(optional)** **string** | The name of the approval. | [default to undefined] +**created** | **(optional)** **string** | When the approval was created. | [default to undefined] +**modified** | **(optional)** **string** | When the approval was modified last time. | [default to undefined] +**requestCreated** | **(optional)** **string** | When the access-request was created. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**requester** | **(optional)** **AccessitemrequesterV1** | | [default to undefined] +**requestedFor** | **(optional)** **CompletedapprovalRequestedForV1** | | [default to undefined] +**reviewedBy** | **(optional)** **AccessitemreviewedbyV1** | | [default to undefined] +**owner** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**requestedObject** | **(optional)** **RequestableobjectreferenceV1** | | [default to undefined] +**requesterComment** | **(optional)** **CompletedapprovalRequesterCommentV1** | | [default to undefined] +**reviewerComment** | **(optional)** **CompletedapprovalReviewerCommentV1** | | [default to undefined] +**previousReviewersComments** | **(optional)** **Array<CommentdtoV1>** | The history of the previous reviewers comments. | [default to undefined] +**forwardHistory** | **(optional)** **Array<ApprovalforwardhistoryV1>** | The history of approval forward action. | [default to undefined] +**commentRequiredWhenRejected** | **(optional)** **boolean** | When true the rejector has to provide comments when rejecting | [default to false] +**state** | **(optional)** **CompletedapprovalstateV1** | | [default to undefined] +**removeDate** | **(optional)** **string** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [default to undefined] +**removeDateUpdateRequested** | **(optional)** **boolean** | If true, then the request was to change the remove date or sunset date. | [default to false] +**currentRemoveDate** | **(optional)** **string** | The remove date or sunset date that was assigned at the time of the request. | [default to undefined] +**startDate** | **(optional)** **string** | The date the role or access profile or entitlement is/will assigned to the specified identity. | [default to undefined] +**startUpdateRequested** | **(optional)** **boolean** | If true, then the request is to change the start date or sunrise date. | [default to false] +**currentStartDate** | **(optional)** **string** | The start date or sunrise date that was assigned at the time of the request. | [default to undefined] +**sodViolationContext** | **(optional)** **SodviolationcontextcheckcompletedV1** | | [default to undefined] +**preApprovalTriggerResult** | **(optional)** **CompletedapprovalPreApprovalTriggerResultV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs provided during the request. | [default to undefined] +**requestedAccounts** | **(optional)** **Array<RequestedaccountrefV1>** | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level of the requested access item, if applicable. | [default to undefined] +**maxPermittedAccessDuration** | **(optional)** **PendingapprovalMaxPermittedAccessDurationV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/CompletedapprovalPreApprovalTriggerResult.md b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalPreApprovalTriggerResult.md new file mode 100644 index 00000000..6ee011ac --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalPreApprovalTriggerResult.md @@ -0,0 +1,22 @@ +--- +id: v1-completedapproval-pre-approval-trigger-result-v1 +title: CompletedapprovalPreApprovalTriggerResultV1 +pagination_label: CompletedapprovalPreApprovalTriggerResultV1 +sidebar_label: CompletedapprovalPreApprovalTriggerResultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalPreApprovalTriggerResultV1', 'v1CompletedapprovalPreApprovalTriggerResultV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapproval-pre-approval-trigger-result-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalPreApprovalTriggerResultV1', 'v1CompletedapprovalPreApprovalTriggerResultV1'] +--- + +# CompletedapprovalPreApprovalTriggerResultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | The comment from the trigger | [default to undefined] +**decision** | **(optional)** **CompletedapprovalstateV1** | | [default to undefined] +**reviewer** | **(optional)** **string** | The name of the approver | [default to undefined] +**date** | **(optional)** **string** | The date and time the trigger decided on the request | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequestedFor.md b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequestedFor.md new file mode 100644 index 00000000..a5e66537 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequestedFor.md @@ -0,0 +1,21 @@ +--- +id: v1-completedapproval-requested-for-v1 +title: CompletedapprovalRequestedForV1 +pagination_label: CompletedapprovalRequestedForV1 +sidebar_label: CompletedapprovalRequestedForV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalRequestedForV1', 'v1CompletedapprovalRequestedForV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapproval-requested-for-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalRequestedForV1', 'v1CompletedapprovalRequestedForV1'] +--- + +# CompletedapprovalRequestedForV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the object to which this reference applies | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequesterComment.md b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequesterComment.md new file mode 100644 index 00000000..cae95da2 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalRequesterComment.md @@ -0,0 +1,21 @@ +--- +id: v1-completedapproval-requester-comment-v1 +title: CompletedapprovalRequesterCommentV1 +pagination_label: CompletedapprovalRequesterCommentV1 +sidebar_label: CompletedapprovalRequesterCommentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalRequesterCommentV1', 'v1CompletedapprovalRequesterCommentV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapproval-requester-comment-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalRequesterCommentV1', 'v1CompletedapprovalRequesterCommentV1'] +--- + +# CompletedapprovalRequesterCommentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment content. | [default to undefined] +**created** | **(optional)** **string** | Date and time comment was created. | [default to undefined] +**author** | **(optional)** **CommentdtoAuthorV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/CompletedapprovalReviewerComment.md b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalReviewerComment.md new file mode 100644 index 00000000..5e7a4c64 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/CompletedapprovalReviewerComment.md @@ -0,0 +1,21 @@ +--- +id: v1-completedapproval-reviewer-comment-v1 +title: CompletedapprovalReviewerCommentV1 +pagination_label: CompletedapprovalReviewerCommentV1 +sidebar_label: CompletedapprovalReviewerCommentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalReviewerCommentV1', 'v1CompletedapprovalReviewerCommentV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapproval-reviewer-comment-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalReviewerCommentV1', 'v1CompletedapprovalReviewerCommentV1'] +--- + +# CompletedapprovalReviewerCommentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment content. | [default to undefined] +**created** | **(optional)** **string** | Date and time comment was created. | [default to undefined] +**author** | **(optional)** **CommentdtoAuthorV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Completedapprovalstate.md b/sdk-output/access_request_approvals/docs/Models/Completedapprovalstate.md new file mode 100644 index 00000000..b0cc3107 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Completedapprovalstate.md @@ -0,0 +1,21 @@ +--- +id: v1-completedapprovalstate-v1 +title: CompletedapprovalstateV1 +pagination_label: CompletedapprovalstateV1 +sidebar_label: CompletedapprovalstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletedapprovalstateV1', 'v1CompletedapprovalstateV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/completedapprovalstate-v1 +tags: ['SDK', 'Software Development Kit', 'CompletedapprovalstateV1', 'v1CompletedapprovalstateV1'] +--- + +# CompletedapprovalstateV1 + +## Enum + + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/Dtotype.md b/sdk-output/access_request_approvals/docs/Models/Dtotype.md new file mode 100644 index 00000000..77a46a5b --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/Errormessagedto.md b/sdk-output/access_request_approvals/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..56e0e62d --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Errorresponsedto.md b/sdk-output/access_request_approvals/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..aa2d1913 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Forwardapprovaldto.md b/sdk-output/access_request_approvals/docs/Models/Forwardapprovaldto.md new file mode 100644 index 00000000..557acd12 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Forwardapprovaldto.md @@ -0,0 +1,20 @@ +--- +id: v1-forwardapprovaldto-v1 +title: ForwardapprovaldtoV1 +pagination_label: ForwardapprovaldtoV1 +sidebar_label: ForwardapprovaldtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ForwardapprovaldtoV1', 'v1ForwardapprovaldtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/forwardapprovaldto-v1 +tags: ['SDK', 'Software Development Kit', 'ForwardapprovaldtoV1', 'v1ForwardapprovaldtoV1'] +--- + +# ForwardapprovaldtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**newOwnerId** | **string** | The Id of the new owner | [default to undefined] +**comment** | **string** | The comment provided by the forwarder | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Index.md b/sdk-output/access_request_approvals/docs/Models/Index.md new file mode 100644 index 00000000..2b22911f --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: access_request_approvals-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: access_request_approvals-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'access_request_approvals', 'models'] +slug: /tools/sdk/typescript/access_request_approvals/models +tags: ['SDK', 'Software Development Kit', 'access_request_approvals', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1401Response.md b/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1401Response.md new file mode 100644 index 00000000..9ddb8b53 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-pending-approvals-v1401-response-v1 +title: ListPendingApprovalsV1401ResponseV1 +pagination_label: ListPendingApprovalsV1401ResponseV1 +sidebar_label: ListPendingApprovalsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPendingApprovalsV1401ResponseV1', 'v1ListPendingApprovalsV1401ResponseV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/list-pending-approvals-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPendingApprovalsV1401ResponseV1', 'v1ListPendingApprovalsV1401ResponseV1'] +--- + +# ListPendingApprovalsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1429Response.md b/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1429Response.md new file mode 100644 index 00000000..93fc168a --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/ListPendingApprovalsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-pending-approvals-v1429-response-v1 +title: ListPendingApprovalsV1429ResponseV1 +pagination_label: ListPendingApprovalsV1429ResponseV1 +sidebar_label: ListPendingApprovalsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPendingApprovalsV1429ResponseV1', 'v1ListPendingApprovalsV1429ResponseV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/list-pending-approvals-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPendingApprovalsV1429ResponseV1', 'v1ListPendingApprovalsV1429ResponseV1'] +--- + +# ListPendingApprovalsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Localeorigin.md b/sdk-output/access_request_approvals/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e7149ead --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/Ownerdto.md b/sdk-output/access_request_approvals/docs/Models/Ownerdto.md new file mode 100644 index 00000000..10f3e699 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Ownerdto.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerdto-v1 +title: OwnerdtoV1 +pagination_label: OwnerdtoV1 +sidebar_label: OwnerdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerdtoV1', 'v1OwnerdtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/ownerdto-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerdtoV1', 'v1OwnerdtoV1'] +--- + +# OwnerdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Pendingapproval.md b/sdk-output/access_request_approvals/docs/Models/Pendingapproval.md new file mode 100644 index 00000000..539adf60 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Pendingapproval.md @@ -0,0 +1,45 @@ +--- +id: v1-pendingapproval-v1 +title: PendingapprovalV1 +pagination_label: PendingapprovalV1 +sidebar_label: PendingapprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PendingapprovalV1', 'v1PendingapprovalV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/pendingapproval-v1 +tags: ['SDK', 'Software Development Kit', 'PendingapprovalV1', 'v1PendingapprovalV1'] +--- + +# PendingapprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The approval id. | [default to undefined] +**accessRequestId** | **(optional)** **string** | This is the access request id. | [default to undefined] +**name** | **(optional)** **string** | The name of the approval. | [default to undefined] +**created** | **(optional)** **string** | When the approval was created. | [default to undefined] +**modified** | **(optional)** **string** | When the approval was modified last time. | [default to undefined] +**requestCreated** | **(optional)** **string** | When the access-request was created. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**requester** | **(optional)** **AccessitemrequesterV1** | | [default to undefined] +**requestedFor** | **(optional)** **AccessitemrequestedforV1** | | [default to undefined] +**owner** | **(optional)** **PendingapprovalOwnerV1** | | [default to undefined] +**requestedObject** | **(optional)** **RequestableobjectreferenceV1** | | [default to undefined] +**requesterComment** | **(optional)** **CommentdtoV1** | | [default to undefined] +**previousReviewersComments** | **(optional)** **Array<CommentdtoV1>** | The history of the previous reviewers comments. | [default to undefined] +**forwardHistory** | **(optional)** **Array<ApprovalforwardhistoryV1>** | The history of approval forward action. | [default to undefined] +**commentRequiredWhenRejected** | **(optional)** **boolean** | When true the rejector has to provide comments when rejecting | [default to false] +**actionInProcess** | **(optional)** **PendingapprovalactionV1** | | [default to undefined] +**removeDate** | **(optional)** **string** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [default to undefined] +**removeDateUpdateRequested** | **(optional)** **boolean** | If true, then the request is to change the remove date or sunset date. | [default to false] +**currentRemoveDate** | **(optional)** **string** | The remove date or sunset date that was assigned at the time of the request. | [default to undefined] +**startDate** | **(optional)** **string** | The date the role or access profile or entitlement is/will assigned to the specified identity. | [default to undefined] +**startUpdateRequested** | **(optional)** **boolean** | If true, then the request is to change the start date or sunrise date. | [default to false] +**currentStartDate** | **(optional)** **string** | The start date or sunrise date that was assigned at the time of the request. | [default to undefined] +**sodViolationContext** | **(optional)** **SodviolationcontextcheckcompletedV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [default to undefined] +**requestedAccounts** | **(optional)** **Array<RequestedaccountrefV1>** | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level of the requested access item, if applicable. | [default to undefined] +**maxPermittedAccessDuration** | **(optional)** **PendingapprovalMaxPermittedAccessDurationV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/PendingapprovalMaxPermittedAccessDuration.md b/sdk-output/access_request_approvals/docs/Models/PendingapprovalMaxPermittedAccessDuration.md new file mode 100644 index 00000000..233ecc5c --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/PendingapprovalMaxPermittedAccessDuration.md @@ -0,0 +1,20 @@ +--- +id: v1-pendingapproval-max-permitted-access-duration-v1 +title: PendingapprovalMaxPermittedAccessDurationV1 +pagination_label: PendingapprovalMaxPermittedAccessDurationV1 +sidebar_label: PendingapprovalMaxPermittedAccessDurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PendingapprovalMaxPermittedAccessDurationV1', 'v1PendingapprovalMaxPermittedAccessDurationV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/pendingapproval-max-permitted-access-duration-v1 +tags: ['SDK', 'Software Development Kit', 'PendingapprovalMaxPermittedAccessDurationV1', 'v1PendingapprovalMaxPermittedAccessDurationV1'] +--- + +# PendingapprovalMaxPermittedAccessDurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value of the duration. | [default to undefined] +**timeUnit** | **(optional)** **string** | The time unit for the duration. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/PendingapprovalOwner.md b/sdk-output/access_request_approvals/docs/Models/PendingapprovalOwner.md new file mode 100644 index 00000000..62068533 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/PendingapprovalOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-pendingapproval-owner-v1 +title: PendingapprovalOwnerV1 +pagination_label: PendingapprovalOwnerV1 +sidebar_label: PendingapprovalOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PendingapprovalOwnerV1', 'v1PendingapprovalOwnerV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/pendingapproval-owner-v1 +tags: ['SDK', 'Software Development Kit', 'PendingapprovalOwnerV1', 'v1PendingapprovalOwnerV1'] +--- + +# PendingapprovalOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Access item owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Access item owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Access item owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Pendingapprovalaction.md b/sdk-output/access_request_approvals/docs/Models/Pendingapprovalaction.md new file mode 100644 index 00000000..8da6faf7 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Pendingapprovalaction.md @@ -0,0 +1,23 @@ +--- +id: v1-pendingapprovalaction-v1 +title: PendingapprovalactionV1 +pagination_label: PendingapprovalactionV1 +sidebar_label: PendingapprovalactionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PendingapprovalactionV1', 'v1PendingapprovalactionV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/pendingapprovalaction-v1 +tags: ['SDK', 'Software Development Kit', 'PendingapprovalactionV1', 'v1PendingapprovalactionV1'] +--- + +# PendingapprovalactionV1 + +## Enum + + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Forwarded` (value: `'FORWARDED'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/README.md b/sdk-output/access_request_approvals/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_request_approvals/docs/Models/Reassignmenttype.md b/sdk-output/access_request_approvals/docs/Models/Reassignmenttype.md new file mode 100644 index 00000000..ec0c495e --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Reassignmenttype.md @@ -0,0 +1,25 @@ +--- +id: v1-reassignmenttype-v1 +title: ReassignmenttypeV1 +pagination_label: ReassignmenttypeV1 +sidebar_label: ReassignmenttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmenttypeV1', 'v1ReassignmenttypeV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/reassignmenttype-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmenttypeV1', 'v1ReassignmenttypeV1'] +--- + +# ReassignmenttypeV1 + +## Enum + + +* `ManualReassignment` (value: `'MANUAL_REASSIGNMENT'`) + +* `AutomaticReassignment` (value: `'AUTOMATIC_REASSIGNMENT'`) + +* `AutoEscalation` (value: `'AUTO_ESCALATION'`) + +* `SelfReviewDelegation` (value: `'SELF_REVIEW_DELEGATION'`) + + diff --git a/sdk-output/access_request_approvals/docs/Models/Requestableobjectreference.md b/sdk-output/access_request_approvals/docs/Models/Requestableobjectreference.md new file mode 100644 index 00000000..91b3140f --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Requestableobjectreference.md @@ -0,0 +1,22 @@ +--- +id: v1-requestableobjectreference-v1 +title: RequestableobjectreferenceV1 +pagination_label: RequestableobjectreferenceV1 +sidebar_label: RequestableobjectreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableobjectreferenceV1', 'v1RequestableobjectreferenceV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/requestableobjectreference-v1 +tags: ['SDK', 'Software Development Kit', 'RequestableobjectreferenceV1', 'v1RequestableobjectreferenceV1'] +--- + +# RequestableobjectreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the object. | [default to undefined] +**name** | **(optional)** **string** | Name of the object. | [default to undefined] +**description** | **(optional)** **string** | Description of the object. | [default to undefined] +**type** | **(optional)** **string** | Type of the object. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Requestedaccountref.md b/sdk-output/access_request_approvals/docs/Models/Requestedaccountref.md new file mode 100644 index 00000000..40cdf024 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Requestedaccountref.md @@ -0,0 +1,23 @@ +--- +id: v1-requestedaccountref-v1 +title: RequestedaccountrefV1 +pagination_label: RequestedaccountrefV1 +sidebar_label: RequestedaccountrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestedaccountrefV1', 'v1RequestedaccountrefV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/requestedaccountref-v1 +tags: ['SDK', 'Software Development Kit', 'RequestedaccountrefV1', 'v1RequestedaccountrefV1'] +--- + +# RequestedaccountrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Display name of the account for the user | [default to undefined] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**accountUuid** | **(optional)** **string** | The uuid for the account | [default to undefined] +**accountId** | **(optional)** **string** | The native identity for the account | [default to undefined] +**sourceName** | **(optional)** **string** | Display name of the source for the account | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Sodexemptcriteria.md b/sdk-output/access_request_approvals/docs/Models/Sodexemptcriteria.md new file mode 100644 index 00000000..631e92f0 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Sodexemptcriteria.md @@ -0,0 +1,22 @@ +--- +id: v1-sodexemptcriteria-v1 +title: SodexemptcriteriaV1 +pagination_label: SodexemptcriteriaV1 +sidebar_label: SodexemptcriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodexemptcriteriaV1', 'v1SodexemptcriteriaV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodexemptcriteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodexemptcriteriaV1', 'v1SodexemptcriteriaV1'] +--- + +# SodexemptcriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **(optional)** **boolean** | If the entitlement already belonged to the user or not. | [default to false] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Entitlement ID | [default to undefined] +**name** | **(optional)** **string** | Entitlement name | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Sodpolicydto.md b/sdk-output/access_request_approvals/docs/Models/Sodpolicydto.md new file mode 100644 index 00000000..70d725f5 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Sodpolicydto.md @@ -0,0 +1,21 @@ +--- +id: v1-sodpolicydto-v1 +title: SodpolicydtoV1 +pagination_label: SodpolicydtoV1 +sidebar_label: SodpolicydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicydtoV1', 'v1SodpolicydtoV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodpolicydto-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicydtoV1', 'v1SodpolicydtoV1'] +--- + +# SodpolicydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy ID. | [default to undefined] +**name** | **(optional)** **string** | SOD policy display name. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Sodviolationcheckresult.md b/sdk-output/access_request_approvals/docs/Models/Sodviolationcheckresult.md new file mode 100644 index 00000000..a0704897 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Sodviolationcheckresult.md @@ -0,0 +1,22 @@ +--- +id: v1-sodviolationcheckresult-v1 +title: SodviolationcheckresultV1 +pagination_label: SodviolationcheckresultV1 +sidebar_label: SodviolationcheckresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcheckresultV1', 'v1SodviolationcheckresultV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodviolationcheckresult-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcheckresultV1', 'v1SodviolationcheckresultV1'] +--- + +# SodviolationcheckresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **ErrormessagedtoV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [default to undefined] +**violationContexts** | **(optional)** **Array<SodviolationcontextV1>** | | [default to undefined] +**violatedPolicies** | **(optional)** **Array<SodpolicydtoV1>** | A list of the SOD policies that were violated. | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Sodviolationcontext.md b/sdk-output/access_request_approvals/docs/Models/Sodviolationcontext.md new file mode 100644 index 00000000..286846e0 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Sodviolationcontext.md @@ -0,0 +1,20 @@ +--- +id: v1-sodviolationcontext-v1 +title: SodviolationcontextV1 +pagination_label: SodviolationcontextV1 +sidebar_label: SodviolationcontextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextV1', 'v1SodviolationcontextV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodviolationcontext-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextV1', 'v1SodviolationcontextV1'] +--- + +# SodviolationcontextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | **(optional)** **SodpolicydtoV1** | | [default to undefined] +**conflictingAccessCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteria.md b/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteria.md new file mode 100644 index 00000000..4f175b87 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-sodviolationcontext-conflicting-access-criteria-v1 +title: SodviolationcontextConflictingAccessCriteriaV1 +pagination_label: SodviolationcontextConflictingAccessCriteriaV1 +sidebar_label: SodviolationcontextConflictingAccessCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextConflictingAccessCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodviolationcontext-conflicting-access-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextConflictingAccessCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaV1'] +--- + +# SodviolationcontextConflictingAccessCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leftCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1** | | [default to undefined] +**rightCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md b/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 00000000..7994e915 --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-sodviolationcontext-conflicting-access-criteria-left-criteria-v1 +title: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +pagination_label: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +sidebar_label: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodviolationcontext-conflicting-access-criteria-left-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1'] +--- + +# SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteriaList** | **(optional)** **Array<SodexemptcriteriaV1>** | | [default to undefined] + diff --git a/sdk-output/access_request_approvals/docs/Models/Sodviolationcontextcheckcompleted.md b/sdk-output/access_request_approvals/docs/Models/Sodviolationcontextcheckcompleted.md new file mode 100644 index 00000000..4324ac9a --- /dev/null +++ b/sdk-output/access_request_approvals/docs/Models/Sodviolationcontextcheckcompleted.md @@ -0,0 +1,21 @@ +--- +id: v1-sodviolationcontextcheckcompleted-v1 +title: SodviolationcontextcheckcompletedV1 +pagination_label: SodviolationcontextcheckcompletedV1 +sidebar_label: SodviolationcontextcheckcompletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextcheckcompletedV1', 'v1SodviolationcontextcheckcompletedV1'] +slug: /tools/sdk/typescript/access_request_approvals/models/sodviolationcontextcheckcompleted-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextcheckcompletedV1', 'v1SodviolationcontextcheckcompletedV1'] +--- + +# SodviolationcontextcheckcompletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **(optional)** **string** | The status of SOD violation check | [default to undefined] +**uuid** | **(optional)** **string** | The id of the Violation check event | [default to undefined] +**violationCheckResult** | **(optional)** **SodviolationcheckresultV1** | | [default to undefined] + diff --git a/sdk-output/access_request_identity_metrics/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/access_request_identity_metrics/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..c982554b --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,17 @@ +- path: /access-request-identity-metrics/v1/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_request_identity_metrics/methods/access-request-identity-metrics#get-access-request-identity-metrics-v1 + source: | + import { AccessRequestIdentityMetricsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestIdentityMetricsV1Api(configuration); + const identityId: string = '7025c863-c270-4ba6-beea-edf3cb091573'; // string | Manager\'s identity ID. (default to undefined) + const requestedObjectId: string = '2db501be-f0fb-4cc5-a695-334133c52891'; // string | Requested access item\'s ID. (default to undefined) + const type: string = 'ENTITLEMENT'; // 'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE' | Requested access item\'s type. (default to undefined) + const result = await apiInstance.getAccessRequestIdentityMetricsV1(identityId, requestedObjectId, type); + console.log(result); diff --git a/sdk-output/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsV1Api.md b/sdk-output/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsV1Api.md new file mode 100644 index 00000000..a90a51d6 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsV1Api.md @@ -0,0 +1,66 @@ +--- +id: v1-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessRequestIdentityMetrics', 'v1AccessRequestIdentityMetrics'] +slug: /tools/sdk/typescript/access_request_identity_metrics/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'v1AccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetricsV1Api + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-access-request-identity-metrics-v1**](#get-access-request-identity-metrics-v1) | **GET** `/access-request-identity-metrics/v1/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + + +## get-access-request-identity-metrics-v1 +Return access request identity metrics +Use this API to return information access metrics. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-identity-metrics-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | Manager\'s identity ID. | [default to undefined] +**requestedObjectId** | **string** | Requested access item\'s ID. | [default to undefined] +**type** | **'ENTITLEMENT' | 'ROLE' | 'ACCESS_PROFILE'** | Requested access item\'s type. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestIdentityMetricsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestIdentityMetricsV1Api(configuration); +const identityId: string = 7025c863-c270-4ba6-beea-edf3cb091573; // Manager\'s identity ID. +const requestedObjectId: string = 2db501be-f0fb-4cc5-a695-334133c52891; // Requested access item\'s ID. +const type: string = ENTITLEMENT; // Requested access item\'s type. +const result = await apiInstance.getAccessRequestIdentityMetricsV1(identityId, requestedObjectId, type); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/access_request_identity_metrics/docs/Methods/Index.md b/sdk-output/access_request_identity_metrics/docs/Methods/Index.md new file mode 100644 index 00000000..0873d536 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: access_request_identity_metrics-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: access_request_identity_metrics-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'access_request_identity_metrics', 'methods'] +slug: /tools/sdk/typescript/access_request_identity_metrics/methods +tags: ['SDK', 'Software Development Kit', 'access_request_identity_metrics', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/access_request_identity_metrics/docs/Models/Errormessagedto.md b/sdk-output/access_request_identity_metrics/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..2925d66a --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/access_request_identity_metrics/docs/Models/Errorresponsedto.md b/sdk-output/access_request_identity_metrics/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..a87f7a8d --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1401Response.md b/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1401Response.md new file mode 100644 index 00000000..3675d70c --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-identity-metrics-v1401-response-v1 +title: GetAccessRequestIdentityMetricsV1401ResponseV1 +pagination_label: GetAccessRequestIdentityMetricsV1401ResponseV1 +sidebar_label: GetAccessRequestIdentityMetricsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestIdentityMetricsV1401ResponseV1', 'v1GetAccessRequestIdentityMetricsV1401ResponseV1'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models/get-access-request-identity-metrics-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestIdentityMetricsV1401ResponseV1', 'v1GetAccessRequestIdentityMetricsV1401ResponseV1'] +--- + +# GetAccessRequestIdentityMetricsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1429Response.md b/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1429Response.md new file mode 100644 index 00000000..034b6647 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/GetAccessRequestIdentityMetricsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-identity-metrics-v1429-response-v1 +title: GetAccessRequestIdentityMetricsV1429ResponseV1 +pagination_label: GetAccessRequestIdentityMetricsV1429ResponseV1 +sidebar_label: GetAccessRequestIdentityMetricsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestIdentityMetricsV1429ResponseV1', 'v1GetAccessRequestIdentityMetricsV1429ResponseV1'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models/get-access-request-identity-metrics-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestIdentityMetricsV1429ResponseV1', 'v1GetAccessRequestIdentityMetricsV1429ResponseV1'] +--- + +# GetAccessRequestIdentityMetricsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_request_identity_metrics/docs/Models/Index.md b/sdk-output/access_request_identity_metrics/docs/Models/Index.md new file mode 100644 index 00000000..894bb39f --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: access_request_identity_metrics-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: access_request_identity_metrics-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'access_request_identity_metrics', 'models'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models +tags: ['SDK', 'Software Development Kit', 'access_request_identity_metrics', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/access_request_identity_metrics/docs/Models/Localeorigin.md b/sdk-output/access_request_identity_metrics/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dbf67854 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/access_request_identity_metrics/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/access_request_identity_metrics/docs/Models/README.md b/sdk-output/access_request_identity_metrics/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_request_identity_metrics/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_requests/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/access_requests/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..98787413 --- /dev/null +++ b/sdk-output/access_requests/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,214 @@ +- path: /access-request-approvals/v1/bulk-approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#approve-bulk-access-request-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const bulkapproveaccessrequestV1: BulkapproveaccessrequestV1 = {"accessRequestIds":["2c91808568c529c60168cca6f90c1313","2c91808568c529c60168cca6f90c1314"],"comment":"I approve these request items"}; // BulkapproveaccessrequestV1 | + const result = await apiInstance.approveBulkAccessRequestV1(bulkapproveaccessrequestV1); + console.log(result); +- path: /access-requests/v1/bulk-cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#cancel-access-request-in-bulk-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const bulkcancelaccessrequestV1: BulkcancelaccessrequestV1 = {"accessRequestIds":["2c91808568c529c60168cca6f90c1313","2c91808568c529c60168cca6f90c1314"],"comment":"I requested this role by mistake."}; // BulkcancelaccessrequestV1 | + const result = await apiInstance.cancelAccessRequestInBulkV1(bulkcancelaccessrequestV1); + console.log(result); +- path: /access-requests/v1/cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#cancel-access-request-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const cancelaccessrequestV1: CancelaccessrequestV1 = {"accountActivityId":"2c91808568c529c60168cca6f90c1313","comment":"I requested this role by mistake."}; // CancelaccessrequestV1 | + const result = await apiInstance.cancelAccessRequestV1(cancelaccessrequestV1); + console.log(result); +- path: /access-requests/v1/close + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#close-access-request-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const closeaccessrequestV1: CloseaccessrequestV1 = {"accessRequestIds":["2c90ad2a70ace7d50170acf22ca90010"],"executionStatus":"Terminated","completionStatus":"Failure","message":"The IdentityNow Administrator manually closed this request."}; // CloseaccessrequestV1 | + const result = await apiInstance.closeAccessRequestV1(closeaccessrequestV1); + console.log(result); +- path: /access-requests/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#create-access-request-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const accessrequestV1: AccessrequestV1 = ; // AccessrequestV1 | + const result = await apiInstance.createAccessRequestV1(accessrequestV1); + console.log(result); +- path: /access-request-config/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#get-access-request-config-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const result = await apiInstance.getAccessRequestConfigV1(); + console.log(result); +- path: /access-request-config/v2 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#get-access-request-config-v2 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const result = await apiInstance.getAccessRequestConfigV2(); + console.log(result); +- path: /revocable-objects/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#get-entitlement-details-for-identity-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const identityId: string = '7025c863c2704ba6beeaedf3cb091573'; // string | The identity ID. (default to undefined) + const entitlementId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The entitlement ID (default to undefined) + const result = await apiInstance.getEntitlementDetailsForIdentityV1(identityId, entitlementId); + console.log(result); +- path: /access-request-status/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#list-access-request-status-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const requestedFor: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const requestedBy: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const regardingIdentity: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) (default to undefined) + const assignedTo: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) (default to undefined) + const count: boolean = false; // boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + const limit: number = 100; // number | Max number of results to return. (optional) (default to 250) + const offset: number = 10; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) (default to undefined) + const filters: string = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* (optional) (default to undefined) + const sorters: string = 'created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) (default to undefined) + const requestState: string = 'request-state=EXECUTING'; // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) (default to undefined) + const result = await apiInstance.listAccessRequestStatusV1(); + console.log(result); +- path: /access-request-administration/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#list-administrators-access-request-status-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const requestedFor: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const requestedBy: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const regardingIdentity: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) (default to undefined) + const assignedTo: string = '2c9180877b2b6ea4017b2c545f971429'; // string | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) (default to undefined) + const count: boolean = false; // boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to false) + const limit: number = 100; // number | Max number of results to return. (optional) (default to 250) + const offset: number = 10; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) (default to undefined) + const filters: string = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) (default to undefined) + const sorters: string = 'created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) (default to undefined) + const requestState: string = 'request-state=EXECUTING'; // string | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) (default to undefined) + const result = await apiInstance.listAdministratorsAccessRequestStatusV1(xSailPointExperimental); + console.log(result); +- path: /access-requests/v1/accounts-selection + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#load-account-selections-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const accountsselectionrequestV1: AccountsselectionrequestV1 = ; // AccountsselectionrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.loadAccountSelectionsV1(accountsselectionrequestV1); + console.log(result); +- path: /access-request-config/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#set-access-request-config-v1 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const accessrequestconfigV1: AccessrequestconfigV1 = ; // AccessrequestconfigV1 | + const result = await apiInstance.setAccessRequestConfigV1(accessrequestconfigV1); + console.log(result); +- path: /access-request-config/v2 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/access_requests/methods/access-requests#set-access-request-config-v2 + source: | + import { AccessRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccessRequestsV1Api(configuration); + const accessrequestconfigv2V1: Accessrequestconfigv2V1 = ; // Accessrequestconfigv2V1 | + const result = await apiInstance.setAccessRequestConfigV2(accessrequestconfigv2V1); + console.log(result); diff --git a/sdk-output/access_requests/docs/Methods/AccessRequestsV1Api.md b/sdk-output/access_requests/docs/Methods/AccessRequestsV1Api.md new file mode 100644 index 00000000..cd0112c8 --- /dev/null +++ b/sdk-output/access_requests/docs/Methods/AccessRequestsV1Api.md @@ -0,0 +1,641 @@ +--- +id: v1-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessRequests', 'v1AccessRequests'] +slug: /tools/sdk/typescript/access_requests/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'v1AccessRequests'] +--- + +# AccessRequestsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-bulk-access-request-v1**](#approve-bulk-access-request-v1) | **POST** `/access-request-approvals/v1/bulk-approve` | Bulk approve access request +[**cancel-access-request-in-bulk-v1**](#cancel-access-request-in-bulk-v1) | **POST** `/access-requests/v1/bulk-cancel` | Bulk cancel access request +[**cancel-access-request-v1**](#cancel-access-request-v1) | **POST** `/access-requests/v1/cancel` | Cancel access request +[**close-access-request-v1**](#close-access-request-v1) | **POST** `/access-requests/v1/close` | Close access request +[**create-access-request-v1**](#create-access-request-v1) | **POST** `/access-requests/v1` | Submit access request +[**get-access-request-config-v1**](#get-access-request-config-v1) | **GET** `/access-request-config/v1` | Get access request configuration +[**get-access-request-config-v2**](#get-access-request-config-v2) | **GET** `/access-request-config/v2` | Get access request configuration +[**get-entitlement-details-for-identity-v1**](#get-entitlement-details-for-identity-v1) | **GET** `/revocable-objects/v1` | Identity entitlement details +[**list-access-request-status-v1**](#list-access-request-status-v1) | **GET** `/access-request-status/v1` | Access request status +[**list-administrators-access-request-status-v1**](#list-administrators-access-request-status-v1) | **GET** `/access-request-administration/v1` | Access request status for administrators +[**load-account-selections-v1**](#load-account-selections-v1) | **POST** `/access-requests/v1/accounts-selection` | Get accounts selections for identity +[**set-access-request-config-v1**](#set-access-request-config-v1) | **PUT** `/access-request-config/v1` | Update access request configuration +[**set-access-request-config-v2**](#set-access-request-config-v2) | **PUT** `/access-request-config/v2` | Update access request configuration + + +## approve-bulk-access-request-v1 +Bulk approve access request +This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-bulk-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkapproveaccessrequestV1** | **BulkapproveaccessrequestV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const bulkapproveaccessrequestV1: BulkapproveaccessrequestV1 = {"accessRequestIds":["2c91808568c529c60168cca6f90c1313","2c91808568c529c60168cca6f90c1314"],"comment":"I approve these request items"}; // +const result = await apiInstance.approveBulkAccessRequestV1(bulkapproveaccessrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## cancel-access-request-in-bulk-v1 +Bulk cancel access request +This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. +Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-access-request-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkcancelaccessrequestV1** | **BulkcancelaccessrequestV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const bulkcancelaccessrequestV1: BulkcancelaccessrequestV1 = {"accessRequestIds":["2c91808568c529c60168cca6f90c1313","2c91808568c529c60168cca6f90c1314"],"comment":"I requested this role by mistake."}; // +const result = await apiInstance.cancelAccessRequestInBulkV1(bulkcancelaccessrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## cancel-access-request-v1 +Cancel access request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**cancelaccessrequestV1** | **CancelaccessrequestV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const cancelaccessrequestV1: CancelaccessrequestV1 = {"accountActivityId":"2c91808568c529c60168cca6f90c1313","comment":"I requested this role by mistake."}; // +const result = await apiInstance.cancelAccessRequestV1(cancelaccessrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## close-access-request-v1 +Close access request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/close-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**closeaccessrequestV1** | **CloseaccessrequestV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const closeaccessrequestV1: CloseaccessrequestV1 = {"accessRequestIds":["2c90ad2a70ace7d50170acf22ca90010"],"executionStatus":"Terminated","completionStatus":"Failure","message":"The IdentityNow Administrator manually closed this request."}; // +const result = await apiInstance.closeAccessRequestV1(closeaccessrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-access-request-v1 +Submit access request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +>**Security:** idn:access-request:manage is for ORG_ADMIN level. idn:access-request-self:manage is for USER level. + +:::info +The ability to request access using this API is constrained by the Access Request Segments defined in the API token's user context. +::: + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it does not return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, +without changing the account details or end date information from the existing assignment, +the API will cancel the request as a duplicate. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* You can specify a `startDate` to set or alter a sunrise date-time on an assignment. The startDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunrise date and its yet to be provisioned, you can also submit a request without a `startDate` to request immediate provisioning after approval. +* If a `startDate` is specified, then the requested role, access profile, or entitlement will be provisioned on that date and time. +* You can specify a `removeDate` to set or alter a sunset date-time on an assignment. The removeDate must be a future date-time, in the UTC timezone. Additionally, if the user already has the access assigned with a sunset date, you can also submit a request without a `removeDate` to request removal of the sunset date and time. +* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. + +:::caution + +If any entitlements are being requested, then the maximum number of entitlements that can be requested is 25, and the maximum number of identities that can be requested for is 10. If you exceed these limits, the request will fail with a 400 error. If you are not requesting any entitlements, then there are no limits. + +::: + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the requested role, access profile, or entitlement will be removed on that date and time. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You cannot specify a 'startDate' in a REVOKE_ACCESS request, as startDate is only applicable for GRANT_ACCESS requests to indicate when the access should be provisioned, and it does not make sense in the context of revoking access. +* You can specify a `removeDate` to add or alter a sunset date and time on an assignment. The `removeDate` must be a future date-time, in the UTC timezone. If the user already has the access assigned with a sunset date and time, the removeDate must be a date-time earlier than the existing sunset date and time. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. These fields should be used within the 'requestedItems' section for the revoke requests. +* Usage of 'requestedForWithRequestedItems' field is not supported for revoke requests. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-access-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestV1** | **AccessrequestV1** | | + +### Return type + +**AccessrequestresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const accessrequestV1: AccessrequestV1 = ; // +const result = await apiInstance.createAccessRequestV1(accessrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-config-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Get access request configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**AccessrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const result = await apiInstance.getAccessRequestConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-config-v2 +Get access request configuration +This endpoint returns the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-config-v2) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Accessrequestconfigv2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const result = await apiInstance.getAccessRequestConfigV2(); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-details-for-identity-v1 +Identity entitlement details +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-details-for-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | The identity ID. | [default to undefined] +**entitlementId** | **string** | The entitlement ID | [default to undefined] + +### Return type + +**IdentityentitlementdetailsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const identityId: string = 7025c863c2704ba6beeaedf3cb091573; // The identity ID. +const entitlementId: string = ef38f94347e94562b5bb8424a56397d8; // The entitlement ID +const result = await apiInstance.getEntitlementDetailsForIdentityV1(identityId, entitlementId); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-request-status-v1 +Access request status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-request-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | [optional] [default to undefined] +**assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | [optional] [default to undefined] +**count** | **boolean** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [optional] [default to false] +**limit** | **number** | Max number of results to return. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** | [optional] [default to undefined] +**requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const requestedFor: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const requestedBy: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const regardingIdentity: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +const assignedTo: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +const count: boolean = false; // If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) +const limit: number = 100; // Max number of results to return. (optional) +const offset: number = 10; // Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +const filters: string = accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *eq, ge, gt, le, lt, ne, sw* **accountActivityItemId**: *eq, in, ge, gt, le, ne, sw* **created**: *eq, ge, gt, le, lt, ne* (optional) +const sorters: string = created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) +const requestState: string = request-state=EXECUTING; // Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) +const result = await apiInstance.listAccessRequestStatusV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-administrators-access-request-status-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Access request status for administrators +Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. +Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-administrators-access-request-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**requestedFor** | **string** | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**requestedBy** | **string** | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**regardingIdentity** | **string** | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | [optional] [default to undefined] +**assignedTo** | **string** | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. | [optional] [default to undefined] +**count** | **boolean** | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. | [optional] [default to false] +**limit** | **number** | Max number of results to return. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** | [optional] [default to undefined] +**requestState** | **string** | Filter the results by the state of the request. The only valid value is *EXECUTING*. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const requestedFor: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const requestedBy: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const regardingIdentity: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +const assignedTo: string = 2c9180877b2b6ea4017b2c545f971429; // Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +const count: boolean = false; // If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) +const limit: number = 100; // Max number of results to return. (optional) +const offset: number = 10; // Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +const filters: string = accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in, eq, ne, ge, gt, le, lt, sw* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) +const sorters: string = created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) +const requestState: string = request-state=EXECUTING; // Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) +const result = await apiInstance.listAdministratorsAccessRequestStatusV1(xSailPointExperimental); +console.log(result); +``` + +[[Back to top]](#) + +## load-account-selections-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/load-account-selections-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accountsselectionrequestV1** | **AccountsselectionrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccountsselectionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const accountsselectionrequestV1: AccountsselectionrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.loadAccountSelectionsV1(accountsselectionrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-access-request-config-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Update access request configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-access-request-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestconfigV1** | **AccessrequestconfigV1** | | + +### Return type + +**AccessrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const accessrequestconfigV1: AccessrequestconfigV1 = ; // +const result = await apiInstance.setAccessRequestConfigV1(accessrequestconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-access-request-config-v2 +Update access request configuration +This endpoint replaces the current access-request configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-access-request-config-v2) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestconfigv2V1** | **Accessrequestconfigv2V1** | | + +### Return type + +**Accessrequestconfigv2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccessRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccessRequestsV1Api(configuration); +const accessrequestconfigv2V1: Accessrequestconfigv2V1 = ; // +const result = await apiInstance.setAccessRequestConfigV2(accessrequestconfigv2V1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/access_requests/docs/Methods/Index.md b/sdk-output/access_requests/docs/Methods/Index.md new file mode 100644 index 00000000..6b8b55fd --- /dev/null +++ b/sdk-output/access_requests/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: access_requests-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: access_requests-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'access_requests', 'methods'] +slug: /tools/sdk/typescript/access_requests/methods +tags: ['SDK', 'Software Development Kit', 'access_requests', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/access_requests/docs/Models/Accessitemrequester.md b/sdk-output/access_requests/docs/Models/Accessitemrequester.md new file mode 100644 index 00000000..17ef553d --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessitemrequester.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemrequester-v1 +title: AccessitemrequesterV1 +pagination_label: AccessitemrequesterV1 +sidebar_label: AccessitemrequesterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrequesterV1', 'v1AccessitemrequesterV1'] +slug: /tools/sdk/typescript/access_requests/models/accessitemrequester-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrequesterV1', 'v1AccessitemrequesterV1'] +--- + +# AccessitemrequesterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Access item requester\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Access item requester\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Access item owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessitemreviewedby.md b/sdk-output/access_requests/docs/Models/Accessitemreviewedby.md new file mode 100644 index 00000000..8a0f26e6 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessitemreviewedby.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemreviewedby-v1 +title: AccessitemreviewedbyV1 +pagination_label: AccessitemreviewedbyV1 +sidebar_label: AccessitemreviewedbyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemreviewedbyV1', 'v1AccessitemreviewedbyV1'] +slug: /tools/sdk/typescript/access_requests/models/accessitemreviewedby-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemreviewedbyV1', 'v1AccessitemreviewedbyV1'] +--- + +# AccessitemreviewedbyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity who reviewed the access item request. | [default to undefined] +**id** | **(optional)** **string** | ID of identity who reviewed the access item request. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity who reviewed the access item request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequest.md b/sdk-output/access_requests/docs/Models/Accessrequest.md new file mode 100644 index 00000000..8bb383a4 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequest.md @@ -0,0 +1,23 @@ +--- +id: v1-accessrequest-v1 +title: AccessrequestV1 +pagination_label: AccessrequestV1 +sidebar_label: AccessrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestV1', 'v1AccessrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequest-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestV1', 'v1AccessrequestV1'] +--- + +# AccessrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestedFor** | **Array<string>** | A list of Identity IDs for whom the Access is requested. If it\'s a Revoke request, there can only be one Identity ID. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**requestedItems** | **Array<AccessrequestitemV1>** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [default to undefined] +**requestedForWithRequestedItems** | **(optional)** **Array<RequestedfordtorefV1>** | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when \'requestedFor\' and \'requestedItems\' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different start dates * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request * Only for use in GRANT_ACCESS type requests | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestadminitemstatus.md b/sdk-output/access_requests/docs/Models/Accessrequestadminitemstatus.md new file mode 100644 index 00000000..504c8c02 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestadminitemstatus.md @@ -0,0 +1,44 @@ +--- +id: v1-accessrequestadminitemstatus-v1 +title: AccessrequestadminitemstatusV1 +pagination_label: AccessrequestadminitemstatusV1 +sidebar_label: AccessrequestadminitemstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestadminitemstatusV1', 'v1AccessrequestadminitemstatusV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestadminitemstatus-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestadminitemstatusV1', 'v1AccessrequestadminitemstatusV1'] +--- + +# AccessrequestadminitemstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the item being requested. | [default to undefined] +**type** | **(optional)** **string** | Type of requested object. | [default to undefined] +**cancelledRequestDetails** | **(optional)** **RequesteditemstatusCancelledRequestDetailsV1** | | [default to undefined] +**errorMessages** | **(optional)** **Array<Array<ErrormessagedtoV1>>** | List of localized error messages, if any, encountered during the approval/provisioning process. | [default to undefined] +**state** | **(optional)** **RequesteditemstatusrequeststateV1** | | [default to undefined] +**approvalDetails** | **(optional)** **Array<ApprovalstatusdtoV1>** | Approval details for each item. | [default to undefined] +**manualWorkItemDetails** | **(optional)** **Array<ManualworkitemdetailsV1>** | Manual work items created for provisioning the item. | [default to undefined] +**accountActivityItemId** | **(optional)** **string** | Id of associated account activity item. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**requester** | **(optional)** **AccessitemrequesterV1** | | [default to undefined] +**requestedFor** | **(optional)** **RequesteditemstatusRequestedForV1** | | [default to undefined] +**requesterComment** | **(optional)** **RequesteditemstatusRequesterCommentV1** | | [default to undefined] +**sodViolationContext** | **(optional)** **RequesteditemstatusSodViolationContextV1** | | [default to undefined] +**provisioningDetails** | **(optional)** **RequesteditemstatusProvisioningDetailsV1** | | [default to undefined] +**preApprovalTriggerDetails** | **(optional)** **RequesteditemstatusPreApprovalTriggerDetailsV1** | | [default to undefined] +**accessRequestPhases** | **(optional)** **Array<AccessrequestphasesV1>** | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [default to undefined] +**description** | **(optional)** **string** | Description associated to the requested object. | [default to undefined] +**startDate** | **(optional)** **string** | When the role access is scheduled for provisioning. | [default to undefined] +**removeDate** | **(optional)** **string** | When the role access is scheduled for removal. | [default to undefined] +**cancelable** | **(optional)** **boolean** | True if the request can be canceled. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | True if re-auth is required. | [default to false] +**accessRequestId** | **(optional)** **string** | This is the account activity id. | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs, if any were included in the corresponding access request | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestconfig.md b/sdk-output/access_requests/docs/Models/Accessrequestconfig.md new file mode 100644 index 00000000..5ef2ba8d --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-accessrequestconfig-v1 +title: AccessrequestconfigV1 +pagination_label: AccessrequestconfigV1 +sidebar_label: AccessrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestconfigV1', 'v1AccessrequestconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestconfigV1', 'v1AccessrequestconfigV1'] +--- + +# AccessrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalsMustBeExternal** | **(optional)** **boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. | [default to false] +**autoApprovalEnabled** | **(optional)** **boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [default to false] +**reauthorizationEnabled** | **(optional)** **boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [default to false] +**requestOnBehalfOfConfig** | **(optional)** **RequestonbehalfofconfigV1** | | [default to undefined] +**approvalReminderAndEscalationConfig** | **(optional)** **ApprovalreminderandescalationconfigV1** | | [default to undefined] +**entitlementRequestConfig** | **(optional)** **EntitlementrequestconfigV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestconfigv2.md b/sdk-output/access_requests/docs/Models/Accessrequestconfigv2.md new file mode 100644 index 00000000..915a25e3 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestconfigv2.md @@ -0,0 +1,23 @@ +--- +id: v1-accessrequestconfigv2-v1 +title: Accessrequestconfigv2V1 +pagination_label: Accessrequestconfigv2V1 +sidebar_label: Accessrequestconfigv2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accessrequestconfigv2V1', 'v1Accessrequestconfigv2V1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestconfigv2-v1 +tags: ['SDK', 'Software Development Kit', 'Accessrequestconfigv2V1', 'v1Accessrequestconfigv2V1'] +--- + +# Accessrequestconfigv2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalsMustBeExternal** | **(optional)** **boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn\'t an org admin. | [default to false] +**reauthorizationEnabled** | **(optional)** **boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [default to false] +**requestOnBehalfOfConfig** | **(optional)** **Requestonbehalfofconfigv2V1** | | [default to undefined] +**entitlementRequestConfig** | **(optional)** **Entitlementrequestconfigv2V1** | | [default to undefined] +**govGroupVisibilityEnabled** | **(optional)** **boolean** | If this is true, requesters and requested-for users will be able to see the names of governance group members when a request is awaiting the group\'s approval. Up to the first 10 members of the group will be listed. | [default to false] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestitem.md b/sdk-output/access_requests/docs/Models/Accessrequestitem.md new file mode 100644 index 00000000..a484a1ea --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestitem.md @@ -0,0 +1,26 @@ +--- +id: v1-accessrequestitem-v1 +title: AccessrequestitemV1 +pagination_label: AccessrequestitemV1 +sidebar_label: AccessrequestitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestitemV1', 'v1AccessrequestitemV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestitem-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestitemV1', 'v1AccessrequestitemV1'] +--- + +# AccessrequestitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of the item being requested. | [default to undefined] +**id** | **string** | ID of Role, Access Profile or Entitlement being requested. | [default to undefined] +**comment** | **(optional)** **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [default to undefined] +**startDate** | **(optional)** **string** | The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. | [default to undefined] +**removeDate** | **(optional)** **string** | The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. | [default to undefined] +**assignmentId** | **(optional)** **string** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [default to undefined] +**nativeIdentity** | **(optional)** **string** | The unique identifier for an account on the identity, designated as the account ID attribute in the source\'s account schema. This is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestphases.md b/sdk-output/access_requests/docs/Models/Accessrequestphases.md new file mode 100644 index 00000000..671c1a55 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestphases.md @@ -0,0 +1,24 @@ +--- +id: v1-accessrequestphases-v1 +title: AccessrequestphasesV1 +pagination_label: AccessrequestphasesV1 +sidebar_label: AccessrequestphasesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestphasesV1', 'v1AccessrequestphasesV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestphases-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestphasesV1', 'v1AccessrequestphasesV1'] +--- + +# AccessrequestphasesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**started** | **(optional)** **string** | The time that this phase started. | [default to undefined] +**finished** | **(optional)** **string** | The time that this phase finished. | [default to undefined] +**name** | **(optional)** **string** | The name of this phase. | [default to undefined] +**state** | **(optional)** **string** | The state of this phase. | [default to undefined] +**result** | **(optional)** **string** | The state of this phase. | [default to undefined] +**phaseReference** | **(optional)** **string** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequestresponse.md b/sdk-output/access_requests/docs/Models/Accessrequestresponse.md new file mode 100644 index 00000000..61de7de6 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequestresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-accessrequestresponse-v1 +title: AccessrequestresponseV1 +pagination_label: AccessrequestresponseV1 +sidebar_label: AccessrequestresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestresponseV1', 'v1AccessrequestresponseV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequestresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestresponseV1', 'v1AccessrequestresponseV1'] +--- + +# AccessrequestresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**newRequests** | **(optional)** **Array<AccessrequesttrackingV1>** | A list of new access request tracking data mapped to the values requested. | [default to undefined] +**existingRequests** | **(optional)** **Array<AccessrequesttrackingV1>** | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequesttracking.md b/sdk-output/access_requests/docs/Models/Accessrequesttracking.md new file mode 100644 index 00000000..425e3f43 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequesttracking.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequesttracking-v1 +title: AccessrequesttrackingV1 +pagination_label: AccessrequesttrackingV1 +sidebar_label: AccessrequesttrackingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequesttrackingV1', 'v1AccessrequesttrackingV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequesttracking-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequesttrackingV1', 'v1AccessrequesttrackingV1'] +--- + +# AccessrequesttrackingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestedFor** | **(optional)** **string** | The identity id in which the access request is for. | [default to undefined] +**requestedItemsDetails** | **(optional)** **Array<RequesteditemdetailsV1>** | The details of the item requested. | [default to undefined] +**attributesHash** | **(optional)** **number** | a hash representation of the access requested, useful for longer term tracking client side. | [default to undefined] +**accessRequestIds** | **(optional)** **Array<string>** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accessrequesttype.md b/sdk-output/access_requests/docs/Models/Accessrequesttype.md new file mode 100644 index 00000000..48f0a787 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accessrequesttype.md @@ -0,0 +1,23 @@ +--- +id: v1-accessrequesttype-v1 +title: AccessrequesttypeV1 +pagination_label: AccessrequesttypeV1 +sidebar_label: AccessrequesttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequesttypeV1', 'v1AccessrequesttypeV1'] +slug: /tools/sdk/typescript/access_requests/models/accessrequesttype-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequesttypeV1', 'v1AccessrequesttypeV1'] +--- + +# AccessrequesttypeV1 + +## Enum + + +* `GrantAccess` (value: `'GRANT_ACCESS'`) + +* `RevokeAccess` (value: `'REVOKE_ACCESS'`) + +* `ModifyAccess` (value: `'MODIFY_ACCESS'`) + + diff --git a/sdk-output/access_requests/docs/Models/Accountinforef.md b/sdk-output/access_requests/docs/Models/Accountinforef.md new file mode 100644 index 00000000..a07b3ffd --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accountinforef.md @@ -0,0 +1,23 @@ +--- +id: v1-accountinforef-v1 +title: AccountinforefV1 +pagination_label: AccountinforefV1 +sidebar_label: AccountinforefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountinforefV1', 'v1AccountinforefV1'] +slug: /tools/sdk/typescript/access_requests/models/accountinforef-v1 +tags: ['SDK', 'Software Development Kit', 'AccountinforefV1', 'v1AccountinforefV1'] +--- + +# AccountinforefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **(optional)** **string** | The uuid for the account, available under the \'objectguid\' attribute | [default to undefined] +**nativeIdentity** | **(optional)** **string** | The \'distinguishedName\' attribute for the account | [default to undefined] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The account id | [default to undefined] +**name** | **(optional)** **string** | The account display name | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accountitemref.md b/sdk-output/access_requests/docs/Models/Accountitemref.md new file mode 100644 index 00000000..42642af8 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accountitemref.md @@ -0,0 +1,20 @@ +--- +id: v1-accountitemref-v1 +title: AccountitemrefV1 +pagination_label: AccountitemrefV1 +sidebar_label: AccountitemrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountitemrefV1', 'v1AccountitemrefV1'] +slug: /tools/sdk/typescript/access_requests/models/accountitemref-v1 +tags: ['SDK', 'Software Development Kit', 'AccountitemrefV1', 'v1AccountitemrefV1'] +--- + +# AccountitemrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountUuid** | **(optional)** **string** | The uuid for the account, available under the \'objectguid\' attribute | [default to undefined] +**nativeIdentity** | **(optional)** **string** | The \'distinguishedName\' attribute for the account | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accountsselectionrequest.md b/sdk-output/access_requests/docs/Models/Accountsselectionrequest.md new file mode 100644 index 00000000..fcbed48a --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accountsselectionrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-accountsselectionrequest-v1 +title: AccountsselectionrequestV1 +pagination_label: AccountsselectionrequestV1 +sidebar_label: AccountsselectionrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsselectionrequestV1', 'v1AccountsselectionrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/accountsselectionrequest-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsselectionrequestV1', 'v1AccountsselectionrequestV1'] +--- + +# AccountsselectionrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestedFor** | **Array<string>** | A list of Identity IDs for whom the Access is requested. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**requestedItems** | **Array<AccessrequestitemV1>** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Accountsselectionresponse.md b/sdk-output/access_requests/docs/Models/Accountsselectionresponse.md new file mode 100644 index 00000000..7bc9d98a --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Accountsselectionresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-accountsselectionresponse-v1 +title: AccountsselectionresponseV1 +pagination_label: AccountsselectionresponseV1 +sidebar_label: AccountsselectionresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsselectionresponseV1', 'v1AccountsselectionresponseV1'] +slug: /tools/sdk/typescript/access_requests/models/accountsselectionresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsselectionresponseV1', 'v1AccountsselectionresponseV1'] +--- + +# AccountsselectionresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identities** | **(optional)** **Array<IdentityaccountselectionsV1>** | A list of available account selections per identity in the request, for all the requested items | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Approvalforwardhistory.md b/sdk-output/access_requests/docs/Models/Approvalforwardhistory.md new file mode 100644 index 00000000..0512d33d --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Approvalforwardhistory.md @@ -0,0 +1,24 @@ +--- +id: v1-approvalforwardhistory-v1 +title: ApprovalforwardhistoryV1 +pagination_label: ApprovalforwardhistoryV1 +sidebar_label: ApprovalforwardhistoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalforwardhistoryV1', 'v1ApprovalforwardhistoryV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalforwardhistory-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalforwardhistoryV1', 'v1ApprovalforwardhistoryV1'] +--- + +# ApprovalforwardhistoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**oldApproverName** | **(optional)** **string** | Display name of approver from whom the approval was forwarded. | [default to undefined] +**newApproverName** | **(optional)** **string** | Display name of approver to whom the approval was forwarded. | [default to undefined] +**comment** | **(optional)** **string** | Comment made while forwarding. | [default to undefined] +**modified** | **(optional)** **string** | Time at which approval was forwarded. | [default to undefined] +**forwarderName** | **(optional)** **string** | Display name of forwarder who forwarded the approval. | [default to undefined] +**reassignmentType** | **(optional)** **ReassignmenttypeV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Approvalreminderandescalationconfig.md b/sdk-output/access_requests/docs/Models/Approvalreminderandescalationconfig.md new file mode 100644 index 00000000..3b24c0fc --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Approvalreminderandescalationconfig.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalreminderandescalationconfig-v1 +title: ApprovalreminderandescalationconfigV1 +pagination_label: ApprovalreminderandescalationconfigV1 +sidebar_label: ApprovalreminderandescalationconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalreminderandescalationconfigV1', 'v1ApprovalreminderandescalationconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalreminderandescalationconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalreminderandescalationconfigV1', 'v1ApprovalreminderandescalationconfigV1'] +--- + +# ApprovalreminderandescalationconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**daysUntilEscalation** | **(optional)** **number** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [default to undefined] +**daysBetweenReminders** | **(optional)** **number** | Number of days to wait between reminder notifications. | [default to undefined] +**maxReminders** | **(optional)** **number** | Maximum number of reminder notifications to send to the reviewer before approval escalation. The maximum allowed value is 20. | [default to undefined] +**fallbackApproverRef** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Approvalscheme.md b/sdk-output/access_requests/docs/Models/Approvalscheme.md new file mode 100644 index 00000000..5007cc3c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Approvalscheme.md @@ -0,0 +1,31 @@ +--- +id: v1-approvalscheme-v1 +title: ApprovalschemeV1 +pagination_label: ApprovalschemeV1 +sidebar_label: ApprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalschemeV1', 'v1ApprovalschemeV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalschemeV1', 'v1ApprovalschemeV1'] +--- + +# ApprovalschemeV1 + +## Enum + + +* `AppOwner` (value: `'APP_OWNER'`) + +* `SourceOwner` (value: `'SOURCE_OWNER'`) + +* `Manager` (value: `'MANAGER'`) + +* `RoleOwner` (value: `'ROLE_OWNER'`) + +* `AccessProfileOwner` (value: `'ACCESS_PROFILE_OWNER'`) + +* `EntitlementOwner` (value: `'ENTITLEMENT_OWNER'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + + diff --git a/sdk-output/access_requests/docs/Models/Approvalstatusdto.md b/sdk-output/access_requests/docs/Models/Approvalstatusdto.md new file mode 100644 index 00000000..875e765c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Approvalstatusdto.md @@ -0,0 +1,27 @@ +--- +id: v1-approvalstatusdto-v1 +title: ApprovalstatusdtoV1 +pagination_label: ApprovalstatusdtoV1 +sidebar_label: ApprovalstatusdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalstatusdtoV1', 'v1ApprovalstatusdtoV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalstatusdto-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalstatusdtoV1', 'v1ApprovalstatusdtoV1'] +--- + +# ApprovalstatusdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **(optional)** **boolean** | True if the request for this item was forwarded from one owner to another. | [default to false] +**originalOwner** | **(optional)** **ApprovalstatusdtoOriginalOwnerV1** | | [default to undefined] +**currentOwner** | **(optional)** **ApprovalstatusdtoCurrentOwnerV1** | | [default to undefined] +**modified** | **(optional)** **string** | Time at which item was modified. | [default to undefined] +**status** | **(optional)** **ManualworkitemstateV1** | | [default to undefined] +**scheme** | **(optional)** **ApprovalschemeV1** | | [default to undefined] +**errorMessages** | **(optional)** **Array<ErrormessagedtoV1>** | If the request failed, includes any error messages that were generated. | [default to undefined] +**comment** | **(optional)** **string** | Comment, if any, provided by the approver. | [default to undefined] +**removeDate** | **(optional)** **string** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/ApprovalstatusdtoCurrentOwner.md b/sdk-output/access_requests/docs/Models/ApprovalstatusdtoCurrentOwner.md new file mode 100644 index 00000000..0fd44488 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/ApprovalstatusdtoCurrentOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalstatusdto-current-owner-v1 +title: ApprovalstatusdtoCurrentOwnerV1 +pagination_label: ApprovalstatusdtoCurrentOwnerV1 +sidebar_label: ApprovalstatusdtoCurrentOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalstatusdtoCurrentOwnerV1', 'v1ApprovalstatusdtoCurrentOwnerV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalstatusdto-current-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalstatusdtoCurrentOwnerV1', 'v1ApprovalstatusdtoCurrentOwnerV1'] +--- + +# ApprovalstatusdtoCurrentOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity who reviewed the access item request. | [default to undefined] +**id** | **(optional)** **string** | ID of identity who reviewed the access item request. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity who reviewed the access item request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/ApprovalstatusdtoOriginalOwner.md b/sdk-output/access_requests/docs/Models/ApprovalstatusdtoOriginalOwner.md new file mode 100644 index 00000000..56c4eb7c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/ApprovalstatusdtoOriginalOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalstatusdto-original-owner-v1 +title: ApprovalstatusdtoOriginalOwnerV1 +pagination_label: ApprovalstatusdtoOriginalOwnerV1 +sidebar_label: ApprovalstatusdtoOriginalOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalstatusdtoOriginalOwnerV1', 'v1ApprovalstatusdtoOriginalOwnerV1'] +slug: /tools/sdk/typescript/access_requests/models/approvalstatusdto-original-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalstatusdtoOriginalOwnerV1', 'v1ApprovalstatusdtoOriginalOwnerV1'] +--- + +# ApprovalstatusdtoOriginalOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of original approval owner\'s identity. | [default to undefined] +**id** | **(optional)** **string** | ID of original approval owner\'s identity. | [default to undefined] +**name** | **(optional)** **string** | Display name of original approval owner. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Bulkapproveaccessrequest.md b/sdk-output/access_requests/docs/Models/Bulkapproveaccessrequest.md new file mode 100644 index 00000000..a5e0a59e --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Bulkapproveaccessrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkapproveaccessrequest-v1 +title: BulkapproveaccessrequestV1 +pagination_label: BulkapproveaccessrequestV1 +sidebar_label: BulkapproveaccessrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkapproveaccessrequestV1', 'v1BulkapproveaccessrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/bulkapproveaccessrequest-v1 +tags: ['SDK', 'Software Development Kit', 'BulkapproveaccessrequestV1', 'v1BulkapproveaccessrequestV1'] +--- + +# BulkapproveaccessrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalIds** | **Array<string>** | List of approval ids to approve the pending requests | [default to undefined] +**comment** | **string** | Reason for approving the pending access request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Bulkcancelaccessrequest.md b/sdk-output/access_requests/docs/Models/Bulkcancelaccessrequest.md new file mode 100644 index 00000000..54155b15 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Bulkcancelaccessrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkcancelaccessrequest-v1 +title: BulkcancelaccessrequestV1 +pagination_label: BulkcancelaccessrequestV1 +sidebar_label: BulkcancelaccessrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkcancelaccessrequestV1', 'v1BulkcancelaccessrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/bulkcancelaccessrequest-v1 +tags: ['SDK', 'Software Development Kit', 'BulkcancelaccessrequestV1', 'v1BulkcancelaccessrequestV1'] +--- + +# BulkcancelaccessrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestIds** | **Array<string>** | List of access requests ids to cancel the pending requests | [default to undefined] +**comment** | **string** | Reason for cancelling the pending access request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Cancelaccessrequest.md b/sdk-output/access_requests/docs/Models/Cancelaccessrequest.md new file mode 100644 index 00000000..b222af02 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Cancelaccessrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-cancelaccessrequest-v1 +title: CancelaccessrequestV1 +pagination_label: CancelaccessrequestV1 +sidebar_label: CancelaccessrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CancelaccessrequestV1', 'v1CancelaccessrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/cancelaccessrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CancelaccessrequestV1', 'v1CancelaccessrequestV1'] +--- + +# CancelaccessrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountActivityId** | **string** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [default to undefined] +**comment** | **string** | Reason for cancelling the pending access request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Cancelledrequestdetails.md b/sdk-output/access_requests/docs/Models/Cancelledrequestdetails.md new file mode 100644 index 00000000..0e6a6c8c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Cancelledrequestdetails.md @@ -0,0 +1,21 @@ +--- +id: v1-cancelledrequestdetails-v1 +title: CancelledrequestdetailsV1 +pagination_label: CancelledrequestdetailsV1 +sidebar_label: CancelledrequestdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CancelledrequestdetailsV1', 'v1CancelledrequestdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/cancelledrequestdetails-v1 +tags: ['SDK', 'Software Development Kit', 'CancelledrequestdetailsV1', 'v1CancelledrequestdetailsV1'] +--- + +# CancelledrequestdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment made by the owner when cancelling the associated request. | [default to undefined] +**owner** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**modified** | **(optional)** **string** | Date comment was added by the owner when cancelling the associated request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Closeaccessrequest.md b/sdk-output/access_requests/docs/Models/Closeaccessrequest.md new file mode 100644 index 00000000..0bab2a9c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Closeaccessrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-closeaccessrequest-v1 +title: CloseaccessrequestV1 +pagination_label: CloseaccessrequestV1 +sidebar_label: CloseaccessrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CloseaccessrequestV1', 'v1CloseaccessrequestV1'] +slug: /tools/sdk/typescript/access_requests/models/closeaccessrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CloseaccessrequestV1', 'v1CloseaccessrequestV1'] +--- + +# CloseaccessrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestIds** | **Array<string>** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [default to undefined] +**message** | **(optional)** **string** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [default to 'The IdentityNow Administrator manually closed this request.'] +**executionStatus** | **(optional)** **string** | The request\'s provisioning status. Displayed as Stage in IdentityNow. | [default to ExecutionStatusV1_Terminated] +**completionStatus** | **(optional)** **string** | The request\'s overall status. Displayed as Status in IdentityNow. | [default to CompletionStatusV1_Failure] + diff --git a/sdk-output/access_requests/docs/Models/Commentdto.md b/sdk-output/access_requests/docs/Models/Commentdto.md new file mode 100644 index 00000000..ff6a9b54 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Commentdto.md @@ -0,0 +1,21 @@ +--- +id: v1-commentdto-v1 +title: CommentdtoV1 +pagination_label: CommentdtoV1 +sidebar_label: CommentdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommentdtoV1', 'v1CommentdtoV1'] +slug: /tools/sdk/typescript/access_requests/models/commentdto-v1 +tags: ['SDK', 'Software Development Kit', 'CommentdtoV1', 'v1CommentdtoV1'] +--- + +# CommentdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment content. | [default to undefined] +**created** | **(optional)** **string** | Date and time comment was created. | [default to undefined] +**author** | **(optional)** **CommentdtoAuthorV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/CommentdtoAuthor.md b/sdk-output/access_requests/docs/Models/CommentdtoAuthor.md new file mode 100644 index 00000000..ef815450 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/CommentdtoAuthor.md @@ -0,0 +1,21 @@ +--- +id: v1-commentdto-author-v1 +title: CommentdtoAuthorV1 +pagination_label: CommentdtoAuthorV1 +sidebar_label: CommentdtoAuthorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommentdtoAuthorV1', 'v1CommentdtoAuthorV1'] +slug: /tools/sdk/typescript/access_requests/models/commentdto-author-v1 +tags: ['SDK', 'Software Development Kit', 'CommentdtoAuthorV1', 'v1CommentdtoAuthorV1'] +--- + +# CommentdtoAuthorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object | [default to undefined] +**id** | **(optional)** **string** | The unique ID of the object | [default to undefined] +**name** | **(optional)** **string** | The display name of the object | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Dtotype.md b/sdk-output/access_requests/docs/Models/Dtotype.md new file mode 100644 index 00000000..653c3c76 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/access_requests/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/access_requests/docs/Models/Entitlementaccessrequestconfig.md b/sdk-output/access_requests/docs/Models/Entitlementaccessrequestconfig.md new file mode 100644 index 00000000..e73d2788 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Entitlementaccessrequestconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-entitlementaccessrequestconfig-v1 +title: EntitlementaccessrequestconfigV1 +pagination_label: EntitlementaccessrequestconfigV1 +sidebar_label: EntitlementaccessrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementaccessrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +--- + +# EntitlementaccessrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] +**requestCommentRequired** | **(optional)** **boolean** | If the requester must provide a comment during access request. | [default to false] +**denialCommentRequired** | **(optional)** **boolean** | If the reviewer must provide a comment when denying the access request. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Is Reauthorization Required | [default to false] +**requireEndDate** | **(optional)** **boolean** | If true, then remove date or sunset date is required in access request of the entitlement. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **EntitlementaccessrequestconfigMaxPermittedAccessDurationV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md b/sdk-output/access_requests/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md new file mode 100644 index 00000000..8410f1df --- /dev/null +++ b/sdk-output/access_requests/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementaccessrequestconfig-max-permitted-access-duration-v1 +title: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +pagination_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementaccessrequestconfig-max-permitted-access-duration-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +--- + +# EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value of the duration. | [default to undefined] +**timeUnit** | **(optional)** **string** | The time unit for the duration. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Entitlementapprovalscheme.md b/sdk-output/access_requests/docs/Models/Entitlementapprovalscheme.md new file mode 100644 index 00000000..4c06c09d --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Entitlementapprovalscheme.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementapprovalscheme-v1 +title: EntitlementapprovalschemeV1 +pagination_label: EntitlementapprovalschemeV1 +sidebar_label: EntitlementapprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementapprovalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +--- + +# EntitlementapprovalschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Entitlementrequestconfig.md b/sdk-output/access_requests/docs/Models/Entitlementrequestconfig.md new file mode 100644 index 00000000..dac075f2 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Entitlementrequestconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrequestconfig-v1 +title: EntitlementrequestconfigV1 +pagination_label: EntitlementrequestconfigV1 +sidebar_label: EntitlementrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrequestconfigV1', 'v1EntitlementrequestconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrequestconfigV1', 'v1EntitlementrequestconfigV1'] +--- + +# EntitlementrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestConfig** | **(optional)** **EntitlementaccessrequestconfigV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **EntitlementrevocationrequestconfigV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Entitlementrequestconfigv2.md b/sdk-output/access_requests/docs/Models/Entitlementrequestconfigv2.md new file mode 100644 index 00000000..46b8a34e --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Entitlementrequestconfigv2.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrequestconfigv2-v1 +title: Entitlementrequestconfigv2V1 +pagination_label: Entitlementrequestconfigv2V1 +sidebar_label: Entitlementrequestconfigv2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementrequestconfigv2V1', 'v1Entitlementrequestconfigv2V1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementrequestconfigv2-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementrequestconfigv2V1', 'v1Entitlementrequestconfigv2V1'] +--- + +# Entitlementrequestconfigv2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestConfig** | **(optional)** **EntitlementaccessrequestconfigV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **EntitlementrevocationrequestconfigV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Entitlementrevocationrequestconfig.md b/sdk-output/access_requests/docs/Models/Entitlementrevocationrequestconfig.md new file mode 100644 index 00000000..bd881b4e --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Entitlementrevocationrequestconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementrevocationrequestconfig-v1 +title: EntitlementrevocationrequestconfigV1 +pagination_label: EntitlementrevocationrequestconfigV1 +sidebar_label: EntitlementrevocationrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/entitlementrevocationrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +--- + +# EntitlementrevocationrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Errormessagedto.md b/sdk-output/access_requests/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..a25dc2ae --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/access_requests/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Errorresponsedto.md b/sdk-output/access_requests/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..aff560d8 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/access_requests/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1401Response.md b/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1401Response.md new file mode 100644 index 00000000..b4254b36 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-config-v1401-response-v1 +title: GetAccessRequestConfigV1401ResponseV1 +pagination_label: GetAccessRequestConfigV1401ResponseV1 +sidebar_label: GetAccessRequestConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestConfigV1401ResponseV1', 'v1GetAccessRequestConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/access_requests/models/get-access-request-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestConfigV1401ResponseV1', 'v1GetAccessRequestConfigV1401ResponseV1'] +--- + +# GetAccessRequestConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1429Response.md b/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1429Response.md new file mode 100644 index 00000000..8f8fd637 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/GetAccessRequestConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-config-v1429-response-v1 +title: GetAccessRequestConfigV1429ResponseV1 +pagination_label: GetAccessRequestConfigV1429ResponseV1 +sidebar_label: GetAccessRequestConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestConfigV1429ResponseV1', 'v1GetAccessRequestConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/access_requests/models/get-access-request-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestConfigV1429ResponseV1', 'v1GetAccessRequestConfigV1429ResponseV1'] +--- + +# GetAccessRequestConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Identityaccountselections.md b/sdk-output/access_requests/docs/Models/Identityaccountselections.md new file mode 100644 index 00000000..21b8ce5b --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Identityaccountselections.md @@ -0,0 +1,23 @@ +--- +id: v1-identityaccountselections-v1 +title: IdentityaccountselectionsV1 +pagination_label: IdentityaccountselectionsV1 +sidebar_label: IdentityaccountselectionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityaccountselectionsV1', 'v1IdentityaccountselectionsV1'] +slug: /tools/sdk/typescript/access_requests/models/identityaccountselections-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityaccountselectionsV1', 'v1IdentityaccountselectionsV1'] +--- + +# IdentityaccountselectionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestedItems** | **(optional)** **Array<RequesteditemaccountselectionsV1>** | Available account selections for the identity, per requested item | [default to undefined] +**accountsSelectionRequired** | **(optional)** **boolean** | A boolean indicating whether any account selections will be required for the user to raise an access request | [default to false] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The identity id for the user | [default to undefined] +**name** | **(optional)** **string** | The name of the identity | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Identityentitlementdetails.md b/sdk-output/access_requests/docs/Models/Identityentitlementdetails.md new file mode 100644 index 00000000..7e838d6a --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Identityentitlementdetails.md @@ -0,0 +1,22 @@ +--- +id: v1-identityentitlementdetails-v1 +title: IdentityentitlementdetailsV1 +pagination_label: IdentityentitlementdetailsV1 +sidebar_label: IdentityentitlementdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitlementdetailsV1', 'v1IdentityentitlementdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/identityentitlementdetails-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitlementdetailsV1', 'v1IdentityentitlementdetailsV1'] +--- + +# IdentityentitlementdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | Id of Identity | [default to undefined] +**entitlement** | **(optional)** **IdentityentitlementdetailsentitlementdtoV1** | | [default to undefined] +**sourceId** | **(optional)** **string** | Id of Source | [default to undefined] +**accountTargets** | **(optional)** **Array<IdentityentitlementdetailsaccounttargetV1>** | A list of account targets on the identity provisioned with the requested entitlement. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Identityentitlementdetailsaccounttarget.md b/sdk-output/access_requests/docs/Models/Identityentitlementdetailsaccounttarget.md new file mode 100644 index 00000000..4b6b89c6 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Identityentitlementdetailsaccounttarget.md @@ -0,0 +1,26 @@ +--- +id: v1-identityentitlementdetailsaccounttarget-v1 +title: IdentityentitlementdetailsaccounttargetV1 +pagination_label: IdentityentitlementdetailsaccounttargetV1 +sidebar_label: IdentityentitlementdetailsaccounttargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitlementdetailsaccounttargetV1', 'v1IdentityentitlementdetailsaccounttargetV1'] +slug: /tools/sdk/typescript/access_requests/models/identityentitlementdetailsaccounttarget-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitlementdetailsaccounttargetV1', 'v1IdentityentitlementdetailsaccounttargetV1'] +--- + +# IdentityentitlementdetailsaccounttargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **(optional)** **string** | The id of account | [default to undefined] +**accountName** | **(optional)** **string** | The name of account | [default to undefined] +**accountUUID** | **(optional)** **string** | The UUID representation of the account if available | [default to undefined] +**sourceId** | **(optional)** **string** | The id of Source | [default to undefined] +**sourceName** | **(optional)** **string** | The name of Source | [default to undefined] +**removeDate** | **(optional)** **string** | The removal date scheduled for the entitlement on the Identity | [default to undefined] +**assignmentId** | **(optional)** **string** | The assignmentId of the entitlement on the Identity | [default to undefined] +**revocable** | **(optional)** **boolean** | If the entitlement can be revoked | [default to false] + diff --git a/sdk-output/access_requests/docs/Models/Identityentitlementdetailsentitlementdto.md b/sdk-output/access_requests/docs/Models/Identityentitlementdetailsentitlementdto.md new file mode 100644 index 00000000..8ad25269 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Identityentitlementdetailsentitlementdto.md @@ -0,0 +1,29 @@ +--- +id: v1-identityentitlementdetailsentitlementdto-v1 +title: IdentityentitlementdetailsentitlementdtoV1 +pagination_label: IdentityentitlementdetailsentitlementdtoV1 +sidebar_label: IdentityentitlementdetailsentitlementdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitlementdetailsentitlementdtoV1', 'v1IdentityentitlementdetailsentitlementdtoV1'] +slug: /tools/sdk/typescript/access_requests/models/identityentitlementdetailsentitlementdto-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitlementdetailsentitlementdtoV1', 'v1IdentityentitlementdetailsentitlementdtoV1'] +--- + +# IdentityentitlementdetailsentitlementdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**type** | **(optional)** **string** | The type of the object, will always be \"ENTITLEMENT\" | [default to undefined] +**sourceId** | **(optional)** **string** | The source ID | [default to undefined] +**sourceName** | **(optional)** **string** | The source name | [default to undefined] +**owner** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**flags** | **(optional)** **Array<string>** | a list of properties informing the viewer about the entitlement | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Identityreferencewithnameandemail.md b/sdk-output/access_requests/docs/Models/Identityreferencewithnameandemail.md new file mode 100644 index 00000000..c22afb17 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Identityreferencewithnameandemail.md @@ -0,0 +1,22 @@ +--- +id: v1-identityreferencewithnameandemail-v1 +title: IdentityreferencewithnameandemailV1 +pagination_label: IdentityreferencewithnameandemailV1 +sidebar_label: IdentityreferencewithnameandemailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +slug: /tools/sdk/typescript/access_requests/models/identityreferencewithnameandemail-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +--- + +# IdentityreferencewithnameandemailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type can only be IDENTITY. This is read-only. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s human-readable display name. This is read-only. | [default to undefined] +**email** | **(optional)** **string** | Identity\'s email address. This is read-only. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Index.md b/sdk-output/access_requests/docs/Models/Index.md new file mode 100644 index 00000000..4241efc4 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: access_requests-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: access_requests-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'access_requests', 'models'] +slug: /tools/sdk/typescript/access_requests/models +tags: ['SDK', 'Software Development Kit', 'access_requests', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/access_requests/docs/Models/Localeorigin.md b/sdk-output/access_requests/docs/Models/Localeorigin.md new file mode 100644 index 00000000..b21958a9 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/access_requests/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/access_requests/docs/Models/Manualworkitemdetails.md b/sdk-output/access_requests/docs/Models/Manualworkitemdetails.md new file mode 100644 index 00000000..6f5fb3cb --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Manualworkitemdetails.md @@ -0,0 +1,24 @@ +--- +id: v1-manualworkitemdetails-v1 +title: ManualworkitemdetailsV1 +pagination_label: ManualworkitemdetailsV1 +sidebar_label: ManualworkitemdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualworkitemdetailsV1', 'v1ManualworkitemdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/manualworkitemdetails-v1 +tags: ['SDK', 'Software Development Kit', 'ManualworkitemdetailsV1', 'v1ManualworkitemdetailsV1'] +--- + +# ManualworkitemdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forwarded** | **(optional)** **boolean** | True if the request for this item was forwarded from one owner to another. | [default to false] +**originalOwner** | **(optional)** **ManualworkitemdetailsOriginalOwnerV1** | | [default to undefined] +**currentOwner** | **(optional)** **ManualworkitemdetailsCurrentOwnerV1** | | [default to undefined] +**modified** | **(optional)** **string** | Time at which item was modified. | [default to undefined] +**status** | **(optional)** **ManualworkitemstateV1** | | [default to undefined] +**forwardHistory** | **(optional)** **Array<ApprovalforwardhistoryV1>** | The history of approval forward action. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/ManualworkitemdetailsCurrentOwner.md b/sdk-output/access_requests/docs/Models/ManualworkitemdetailsCurrentOwner.md new file mode 100644 index 00000000..91c52d3a --- /dev/null +++ b/sdk-output/access_requests/docs/Models/ManualworkitemdetailsCurrentOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-manualworkitemdetails-current-owner-v1 +title: ManualworkitemdetailsCurrentOwnerV1 +pagination_label: ManualworkitemdetailsCurrentOwnerV1 +sidebar_label: ManualworkitemdetailsCurrentOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualworkitemdetailsCurrentOwnerV1', 'v1ManualworkitemdetailsCurrentOwnerV1'] +slug: /tools/sdk/typescript/access_requests/models/manualworkitemdetails-current-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ManualworkitemdetailsCurrentOwnerV1', 'v1ManualworkitemdetailsCurrentOwnerV1'] +--- + +# ManualworkitemdetailsCurrentOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of current work item owner\'s identity. | [default to undefined] +**id** | **(optional)** **string** | ID of current work item owner\'s identity. | [default to undefined] +**name** | **(optional)** **string** | Display name of current work item owner. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/ManualworkitemdetailsOriginalOwner.md b/sdk-output/access_requests/docs/Models/ManualworkitemdetailsOriginalOwner.md new file mode 100644 index 00000000..888c54ca --- /dev/null +++ b/sdk-output/access_requests/docs/Models/ManualworkitemdetailsOriginalOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-manualworkitemdetails-original-owner-v1 +title: ManualworkitemdetailsOriginalOwnerV1 +pagination_label: ManualworkitemdetailsOriginalOwnerV1 +sidebar_label: ManualworkitemdetailsOriginalOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualworkitemdetailsOriginalOwnerV1', 'v1ManualworkitemdetailsOriginalOwnerV1'] +slug: /tools/sdk/typescript/access_requests/models/manualworkitemdetails-original-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ManualworkitemdetailsOriginalOwnerV1', 'v1ManualworkitemdetailsOriginalOwnerV1'] +--- + +# ManualworkitemdetailsOriginalOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of original work item owner\'s identity. | [default to undefined] +**id** | **(optional)** **string** | ID of original work item owner\'s identity. | [default to undefined] +**name** | **(optional)** **string** | Display name of original work item owner. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Manualworkitemstate.md b/sdk-output/access_requests/docs/Models/Manualworkitemstate.md new file mode 100644 index 00000000..b099c4cd --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Manualworkitemstate.md @@ -0,0 +1,29 @@ +--- +id: v1-manualworkitemstate-v1 +title: ManualworkitemstateV1 +pagination_label: ManualworkitemstateV1 +sidebar_label: ManualworkitemstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualworkitemstateV1', 'v1ManualworkitemstateV1'] +slug: /tools/sdk/typescript/access_requests/models/manualworkitemstate-v1 +tags: ['SDK', 'Software Development Kit', 'ManualworkitemstateV1', 'v1ManualworkitemstateV1'] +--- + +# ManualworkitemstateV1 + +## Enum + + +* `Pending` (value: `'PENDING'`) + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Expired` (value: `'EXPIRED'`) + +* `Cancelled` (value: `'CANCELLED'`) + +* `Archived` (value: `'ARCHIVED'`) + + diff --git a/sdk-output/access_requests/docs/Models/Ownerdto.md b/sdk-output/access_requests/docs/Models/Ownerdto.md new file mode 100644 index 00000000..b14923bf --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Ownerdto.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerdto-v1 +title: OwnerdtoV1 +pagination_label: OwnerdtoV1 +sidebar_label: OwnerdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerdtoV1', 'v1OwnerdtoV1'] +slug: /tools/sdk/typescript/access_requests/models/ownerdto-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerdtoV1', 'v1OwnerdtoV1'] +--- + +# OwnerdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Preapprovaltriggerdetails.md b/sdk-output/access_requests/docs/Models/Preapprovaltriggerdetails.md new file mode 100644 index 00000000..8d102461 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Preapprovaltriggerdetails.md @@ -0,0 +1,21 @@ +--- +id: v1-preapprovaltriggerdetails-v1 +title: PreapprovaltriggerdetailsV1 +pagination_label: PreapprovaltriggerdetailsV1 +sidebar_label: PreapprovaltriggerdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PreapprovaltriggerdetailsV1', 'v1PreapprovaltriggerdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/preapprovaltriggerdetails-v1 +tags: ['SDK', 'Software Development Kit', 'PreapprovaltriggerdetailsV1', 'v1PreapprovaltriggerdetailsV1'] +--- + +# PreapprovaltriggerdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment left for the pre-approval decision | [default to undefined] +**reviewer** | **(optional)** **string** | The reviewer of the pre-approval decision | [default to undefined] +**decision** | **(optional)** **string** | The decision of the pre-approval trigger | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Provisioningdetails.md b/sdk-output/access_requests/docs/Models/Provisioningdetails.md new file mode 100644 index 00000000..bfd417cd --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Provisioningdetails.md @@ -0,0 +1,19 @@ +--- +id: v1-provisioningdetails-v1 +title: ProvisioningdetailsV1 +pagination_label: ProvisioningdetailsV1 +sidebar_label: ProvisioningdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningdetailsV1', 'v1ProvisioningdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/provisioningdetails-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningdetailsV1', 'v1ProvisioningdetailsV1'] +--- + +# ProvisioningdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orderedSubPhaseReferences** | **(optional)** **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/README.md b/sdk-output/access_requests/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/access_requests/docs/Models/Reassignmenttype.md b/sdk-output/access_requests/docs/Models/Reassignmenttype.md new file mode 100644 index 00000000..f63c7e8f --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Reassignmenttype.md @@ -0,0 +1,25 @@ +--- +id: v1-reassignmenttype-v1 +title: ReassignmenttypeV1 +pagination_label: ReassignmenttypeV1 +sidebar_label: ReassignmenttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmenttypeV1', 'v1ReassignmenttypeV1'] +slug: /tools/sdk/typescript/access_requests/models/reassignmenttype-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmenttypeV1', 'v1ReassignmenttypeV1'] +--- + +# ReassignmenttypeV1 + +## Enum + + +* `ManualReassignment` (value: `'MANUAL_REASSIGNMENT'`) + +* `AutomaticReassignment` (value: `'AUTOMATIC_REASSIGNMENT'`) + +* `AutoEscalation` (value: `'AUTO_ESCALATION'`) + +* `SelfReviewDelegation` (value: `'SELF_REVIEW_DELEGATION'`) + + diff --git a/sdk-output/access_requests/docs/Models/Requestedaccountref.md b/sdk-output/access_requests/docs/Models/Requestedaccountref.md new file mode 100644 index 00000000..d3c25c6e --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requestedaccountref.md @@ -0,0 +1,23 @@ +--- +id: v1-requestedaccountref-v1 +title: RequestedaccountrefV1 +pagination_label: RequestedaccountrefV1 +sidebar_label: RequestedaccountrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestedaccountrefV1', 'v1RequestedaccountrefV1'] +slug: /tools/sdk/typescript/access_requests/models/requestedaccountref-v1 +tags: ['SDK', 'Software Development Kit', 'RequestedaccountrefV1', 'v1RequestedaccountrefV1'] +--- + +# RequestedaccountrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Display name of the account for the user | [default to undefined] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**accountUuid** | **(optional)** **string** | The uuid for the account | [default to undefined] +**accountId** | **(optional)** **string** | The native identity for the account | [default to undefined] +**sourceName** | **(optional)** **string** | Display name of the source for the account | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requestedfordtoref.md b/sdk-output/access_requests/docs/Models/Requestedfordtoref.md new file mode 100644 index 00000000..52718c0f --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requestedfordtoref.md @@ -0,0 +1,20 @@ +--- +id: v1-requestedfordtoref-v1 +title: RequestedfordtorefV1 +pagination_label: RequestedfordtorefV1 +sidebar_label: RequestedfordtorefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestedfordtorefV1', 'v1RequestedfordtorefV1'] +slug: /tools/sdk/typescript/access_requests/models/requestedfordtoref-v1 +tags: ['SDK', 'Software Development Kit', 'RequestedfordtorefV1', 'v1RequestedfordtorefV1'] +--- + +# RequestedfordtorefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **string** | The identity id for which the access is requested | [default to undefined] +**requestedItems** | **Array<RequesteditemdtorefV1>** | the details for the access items that are requested for the identity | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requesteditemaccountselections.md b/sdk-output/access_requests/docs/Models/Requesteditemaccountselections.md new file mode 100644 index 00000000..dd9ac626 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requesteditemaccountselections.md @@ -0,0 +1,25 @@ +--- +id: v1-requesteditemaccountselections-v1 +title: RequesteditemaccountselectionsV1 +pagination_label: RequesteditemaccountselectionsV1 +sidebar_label: RequesteditemaccountselectionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemaccountselectionsV1', 'v1RequesteditemaccountselectionsV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemaccountselections-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemaccountselectionsV1', 'v1RequesteditemaccountselectionsV1'] +--- + +# RequesteditemaccountselectionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **(optional)** **string** | The description for this requested item | [default to undefined] +**accountsSelectionBlocked** | **(optional)** **boolean** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [default to false] +**accountsSelectionBlockedReason** | **(optional)** **string** | If account selections are not allowed for an item, this field will denote the reason. | [default to undefined] +**type** | **(optional)** **string** | The type of the item being requested. | [default to undefined] +**id** | **(optional)** **string** | The id of the requested item | [default to undefined] +**name** | **(optional)** **string** | The name of the requested item | [default to undefined] +**sources** | **(optional)** **Array<SourceaccountselectionsV1>** | The details for the sources and accounts for the requested item and identity combination | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requesteditemdetails.md b/sdk-output/access_requests/docs/Models/Requesteditemdetails.md new file mode 100644 index 00000000..bf66e520 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requesteditemdetails.md @@ -0,0 +1,20 @@ +--- +id: v1-requesteditemdetails-v1 +title: RequesteditemdetailsV1 +pagination_label: RequesteditemdetailsV1 +sidebar_label: RequesteditemdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemdetailsV1', 'v1RequesteditemdetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemdetails-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemdetailsV1', 'v1RequesteditemdetailsV1'] +--- + +# RequesteditemdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of access item requested. | [default to undefined] +**id** | **(optional)** **string** | The id of the access item requested. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requesteditemdtoref.md b/sdk-output/access_requests/docs/Models/Requesteditemdtoref.md new file mode 100644 index 00000000..20acc23b --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requesteditemdtoref.md @@ -0,0 +1,25 @@ +--- +id: v1-requesteditemdtoref-v1 +title: RequesteditemdtorefV1 +pagination_label: RequesteditemdtorefV1 +sidebar_label: RequesteditemdtorefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemdtorefV1', 'v1RequesteditemdtorefV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemdtoref-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemdtorefV1', 'v1RequesteditemdtorefV1'] +--- + +# RequesteditemdtorefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of the item being requested. | [default to undefined] +**id** | **string** | ID of Role, Access Profile or Entitlement being requested. | [default to undefined] +**comment** | **(optional)** **string** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [default to undefined] +**startDate** | **(optional)** **string** | The date and time the role or access profile or entitlement is/will be provisioned to the specified identity. Also known as the sunrise date. * Specify a date-time in the future. * This date-time can be used to indicate date-time when access item will be provisioned on the identity account. A GRANT_ACCESS request can use startDate to specify when to schedule provisioning of access item for an identity/account & a MODIFY_ACCESS request can use startDate to change the provisioning date-time of already assigned access item. But REVOKE_ACCESS request can not have startDate field. You can change the sunrise date in requests for yourself or others you are authorized to request for. * If the startDate is in the past, then the provisioning will be processed as soon as possible, but no guarantees can be made about when the provisioning will occur. If the startDate is in the future, then the provisioning will be scheduled to occur on that date and time. If no startDate is provided, then the provisioning will be processed as soon as possible. | [default to undefined] +**removeDate** | **(optional)** **string** | The date and time the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date-time in the future. * The current SLA for the deprovisioning is 24 hours. * This date-time can be used to change the duration of an existing access item assignment for the specified identity. A GRANT_ACCESS request can extend duration or even remove an expiration date, and either a GRANT_ACCESS or REVOKE_ACCESS request can reduce duration or add an expiration date where one has not previously been present. You can change the expiration date in requests for yourself or others you are authorized to request for. | [default to undefined] +**accountSelection** | **(optional)** **Array<SourceitemrefV1>** | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requesteditemstatus.md b/sdk-output/access_requests/docs/Models/Requesteditemstatus.md new file mode 100644 index 00000000..c3696904 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requesteditemstatus.md @@ -0,0 +1,46 @@ +--- +id: v1-requesteditemstatus-v1 +title: RequesteditemstatusV1 +pagination_label: RequesteditemstatusV1 +sidebar_label: RequesteditemstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusV1', 'v1RequesteditemstatusV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusV1', 'v1RequesteditemstatusV1'] +--- + +# RequesteditemstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the access request. As of 2025, this is a new property. Older access requests might not have an ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the item being requested. | [default to undefined] +**type** | **(optional)** **string** | Type of requested object. | [default to undefined] +**cancelledRequestDetails** | **(optional)** **RequesteditemstatusCancelledRequestDetailsV1** | | [default to undefined] +**errorMessages** | **(optional)** **Array<Array<ErrormessagedtoV1>>** | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [default to undefined] +**state** | **(optional)** **RequesteditemstatusrequeststateV1** | | [default to undefined] +**approvalDetails** | **(optional)** **Array<ApprovalstatusdtoV1>** | Approval details for each item. | [default to undefined] +**approvalIds** | **(optional)** **Array<string>** | List of approval IDs associated with the request. | [default to undefined] +**manualWorkItemDetails** | **(optional)** **Array<ManualworkitemdetailsV1>** | Manual work items created for provisioning the item. | [default to undefined] +**accountActivityItemId** | **(optional)** **string** | Id of associated account activity item. | [default to undefined] +**requestType** | **(optional)** **AccessrequesttypeV1** | | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**requester** | **(optional)** **AccessitemrequesterV1** | | [default to undefined] +**requestedFor** | **(optional)** **RequesteditemstatusRequestedForV1** | | [default to undefined] +**requesterComment** | **(optional)** **RequesteditemstatusRequesterCommentV1** | | [default to undefined] +**sodViolationContext** | **(optional)** **RequesteditemstatusSodViolationContextV1** | | [default to undefined] +**provisioningDetails** | **(optional)** **RequesteditemstatusProvisioningDetailsV1** | | [default to undefined] +**preApprovalTriggerDetails** | **(optional)** **RequesteditemstatusPreApprovalTriggerDetailsV1** | | [default to undefined] +**accessRequestPhases** | **(optional)** **Array<AccessrequestphasesV1>** | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [default to undefined] +**description** | **(optional)** **string** | Description associated to the requested object. | [default to undefined] +**startDate** | **(optional)** **string** | When the role access is scheduled for provisioning. | [default to undefined] +**removeDate** | **(optional)** **string** | When the role access is scheduled for removal. | [default to undefined] +**cancelable** | **(optional)** **boolean** | True if the request can be canceled. | [default to false] +**accessRequestId** | **(optional)** **string** | This is the account activity id. | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs, if any were included in the corresponding access request | [default to undefined] +**requestedAccounts** | **(optional)** **Array<RequestedaccountrefV1>** | The accounts selected by the user for the access to be provisioned on, in case they have multiple accounts on one or more sources. | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level of the requested access item, if applicable. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusCancelledRequestDetails.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusCancelledRequestDetails.md new file mode 100644 index 00000000..05ca3342 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusCancelledRequestDetails.md @@ -0,0 +1,21 @@ +--- +id: v1-requesteditemstatus-cancelled-request-details-v1 +title: RequesteditemstatusCancelledRequestDetailsV1 +pagination_label: RequesteditemstatusCancelledRequestDetailsV1 +sidebar_label: RequesteditemstatusCancelledRequestDetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusCancelledRequestDetailsV1', 'v1RequesteditemstatusCancelledRequestDetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-cancelled-request-details-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusCancelledRequestDetailsV1', 'v1RequesteditemstatusCancelledRequestDetailsV1'] +--- + +# RequesteditemstatusCancelledRequestDetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment made by the owner when cancelling the associated request. | [default to undefined] +**owner** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**modified** | **(optional)** **string** | Date comment was added by the owner when cancelling the associated request. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusPreApprovalTriggerDetails.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusPreApprovalTriggerDetails.md new file mode 100644 index 00000000..6affcffa --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusPreApprovalTriggerDetails.md @@ -0,0 +1,21 @@ +--- +id: v1-requesteditemstatus-pre-approval-trigger-details-v1 +title: RequesteditemstatusPreApprovalTriggerDetailsV1 +pagination_label: RequesteditemstatusPreApprovalTriggerDetailsV1 +sidebar_label: RequesteditemstatusPreApprovalTriggerDetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusPreApprovalTriggerDetailsV1', 'v1RequesteditemstatusPreApprovalTriggerDetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-pre-approval-trigger-details-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusPreApprovalTriggerDetailsV1', 'v1RequesteditemstatusPreApprovalTriggerDetailsV1'] +--- + +# RequesteditemstatusPreApprovalTriggerDetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment left for the pre-approval decision | [default to undefined] +**reviewer** | **(optional)** **string** | The reviewer of the pre-approval decision | [default to undefined] +**decision** | **(optional)** **string** | The decision of the pre-approval trigger | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusProvisioningDetails.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusProvisioningDetails.md new file mode 100644 index 00000000..b1a15ffe --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusProvisioningDetails.md @@ -0,0 +1,19 @@ +--- +id: v1-requesteditemstatus-provisioning-details-v1 +title: RequesteditemstatusProvisioningDetailsV1 +pagination_label: RequesteditemstatusProvisioningDetailsV1 +sidebar_label: RequesteditemstatusProvisioningDetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusProvisioningDetailsV1', 'v1RequesteditemstatusProvisioningDetailsV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-provisioning-details-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusProvisioningDetailsV1', 'v1RequesteditemstatusProvisioningDetailsV1'] +--- + +# RequesteditemstatusProvisioningDetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orderedSubPhaseReferences** | **(optional)** **string** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain \"manualWorkItemDetails\" which indicate that there is further information in that object for this phase. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusRequestedFor.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusRequestedFor.md new file mode 100644 index 00000000..f1788e33 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusRequestedFor.md @@ -0,0 +1,21 @@ +--- +id: v1-requesteditemstatus-requested-for-v1 +title: RequesteditemstatusRequestedForV1 +pagination_label: RequesteditemstatusRequestedForV1 +sidebar_label: RequesteditemstatusRequestedForV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusRequestedForV1', 'v1RequesteditemstatusRequestedForV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-requested-for-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusRequestedForV1', 'v1RequesteditemstatusRequestedForV1'] +--- + +# RequesteditemstatusRequestedForV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the object to which this reference applies | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusRequesterComment.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusRequesterComment.md new file mode 100644 index 00000000..50b5fc45 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusRequesterComment.md @@ -0,0 +1,21 @@ +--- +id: v1-requesteditemstatus-requester-comment-v1 +title: RequesteditemstatusRequesterCommentV1 +pagination_label: RequesteditemstatusRequesterCommentV1 +sidebar_label: RequesteditemstatusRequesterCommentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusRequesterCommentV1', 'v1RequesteditemstatusRequesterCommentV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-requester-comment-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusRequesterCommentV1', 'v1RequesteditemstatusRequesterCommentV1'] +--- + +# RequesteditemstatusRequesterCommentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment content. | [default to undefined] +**created** | **(optional)** **string** | Date and time comment was created. | [default to undefined] +**author** | **(optional)** **CommentdtoAuthorV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/RequesteditemstatusSodViolationContext.md b/sdk-output/access_requests/docs/Models/RequesteditemstatusSodViolationContext.md new file mode 100644 index 00000000..dd89930f --- /dev/null +++ b/sdk-output/access_requests/docs/Models/RequesteditemstatusSodViolationContext.md @@ -0,0 +1,21 @@ +--- +id: v1-requesteditemstatus-sod-violation-context-v1 +title: RequesteditemstatusSodViolationContextV1 +pagination_label: RequesteditemstatusSodViolationContextV1 +sidebar_label: RequesteditemstatusSodViolationContextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusSodViolationContextV1', 'v1RequesteditemstatusSodViolationContextV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatus-sod-violation-context-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusSodViolationContextV1', 'v1RequesteditemstatusSodViolationContextV1'] +--- + +# RequesteditemstatusSodViolationContextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **(optional)** **string** | The status of SOD violation check | [default to undefined] +**uuid** | **(optional)** **string** | The id of the Violation check event | [default to undefined] +**violationCheckResult** | **(optional)** **SodviolationcheckresultV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Requesteditemstatusrequeststate.md b/sdk-output/access_requests/docs/Models/Requesteditemstatusrequeststate.md new file mode 100644 index 00000000..6d2ef05c --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requesteditemstatusrequeststate.md @@ -0,0 +1,35 @@ +--- +id: v1-requesteditemstatusrequeststate-v1 +title: RequesteditemstatusrequeststateV1 +pagination_label: RequesteditemstatusrequeststateV1 +sidebar_label: RequesteditemstatusrequeststateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequesteditemstatusrequeststateV1', 'v1RequesteditemstatusrequeststateV1'] +slug: /tools/sdk/typescript/access_requests/models/requesteditemstatusrequeststate-v1 +tags: ['SDK', 'Software Development Kit', 'RequesteditemstatusrequeststateV1', 'v1RequesteditemstatusrequeststateV1'] +--- + +# RequesteditemstatusrequeststateV1 + +## Enum + + +* `Executing` (value: `'EXECUTING'`) + +* `RequestCompleted` (value: `'REQUEST_COMPLETED'`) + +* `Cancelled` (value: `'CANCELLED'`) + +* `Terminated` (value: `'TERMINATED'`) + +* `ProvisioningVerificationPending` (value: `'PROVISIONING_VERIFICATION_PENDING'`) + +* `Rejected` (value: `'REJECTED'`) + +* `ProvisioningFailed` (value: `'PROVISIONING_FAILED'`) + +* `NotAllItemsProvisioned` (value: `'NOT_ALL_ITEMS_PROVISIONED'`) + +* `Error` (value: `'ERROR'`) + + diff --git a/sdk-output/access_requests/docs/Models/Requestonbehalfofconfig.md b/sdk-output/access_requests/docs/Models/Requestonbehalfofconfig.md new file mode 100644 index 00000000..4bb35b86 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requestonbehalfofconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-requestonbehalfofconfig-v1 +title: RequestonbehalfofconfigV1 +pagination_label: RequestonbehalfofconfigV1 +sidebar_label: RequestonbehalfofconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestonbehalfofconfigV1', 'v1RequestonbehalfofconfigV1'] +slug: /tools/sdk/typescript/access_requests/models/requestonbehalfofconfig-v1 +tags: ['SDK', 'Software Development Kit', 'RequestonbehalfofconfigV1', 'v1RequestonbehalfofconfigV1'] +--- + +# RequestonbehalfofconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowRequestOnBehalfOfAnyoneByAnyone** | **(optional)** **boolean** | If this is true, anyone can request access for anyone. | [default to false] +**allowRequestOnBehalfOfEmployeeByManager** | **(optional)** **boolean** | If this is true, a manager can request access for his or her direct reports. | [default to false] + diff --git a/sdk-output/access_requests/docs/Models/Requestonbehalfofconfigv2.md b/sdk-output/access_requests/docs/Models/Requestonbehalfofconfigv2.md new file mode 100644 index 00000000..1e9b06ab --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Requestonbehalfofconfigv2.md @@ -0,0 +1,20 @@ +--- +id: v1-requestonbehalfofconfigv2-v1 +title: Requestonbehalfofconfigv2V1 +pagination_label: Requestonbehalfofconfigv2V1 +sidebar_label: Requestonbehalfofconfigv2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Requestonbehalfofconfigv2V1', 'v1Requestonbehalfofconfigv2V1'] +slug: /tools/sdk/typescript/access_requests/models/requestonbehalfofconfigv2-v1 +tags: ['SDK', 'Software Development Kit', 'Requestonbehalfofconfigv2V1', 'v1Requestonbehalfofconfigv2V1'] +--- + +# Requestonbehalfofconfigv2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**allowRequestOnBehalfOfAnyoneByAnyone** | **(optional)** **boolean** | If this is true, anyone can request access for anyone. | [default to false] +**allowRequestOnBehalfOfEmployeeByManager** | **(optional)** **boolean** | If this is true, a manager can request access for his or her direct reports. | [default to false] + diff --git a/sdk-output/access_requests/docs/Models/Sodexemptcriteria.md b/sdk-output/access_requests/docs/Models/Sodexemptcriteria.md new file mode 100644 index 00000000..90bf0dbf --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sodexemptcriteria.md @@ -0,0 +1,22 @@ +--- +id: v1-sodexemptcriteria-v1 +title: SodexemptcriteriaV1 +pagination_label: SodexemptcriteriaV1 +sidebar_label: SodexemptcriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodexemptcriteriaV1', 'v1SodexemptcriteriaV1'] +slug: /tools/sdk/typescript/access_requests/models/sodexemptcriteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodexemptcriteriaV1', 'v1SodexemptcriteriaV1'] +--- + +# SodexemptcriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**existing** | **(optional)** **boolean** | If the entitlement already belonged to the user or not. | [default to false] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Entitlement ID | [default to undefined] +**name** | **(optional)** **string** | Entitlement name | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sodpolicydto.md b/sdk-output/access_requests/docs/Models/Sodpolicydto.md new file mode 100644 index 00000000..de9c5d4e --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sodpolicydto.md @@ -0,0 +1,21 @@ +--- +id: v1-sodpolicydto-v1 +title: SodpolicydtoV1 +pagination_label: SodpolicydtoV1 +sidebar_label: SodpolicydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicydtoV1', 'v1SodpolicydtoV1'] +slug: /tools/sdk/typescript/access_requests/models/sodpolicydto-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicydtoV1', 'v1SodpolicydtoV1'] +--- + +# SodpolicydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy ID. | [default to undefined] +**name** | **(optional)** **string** | SOD policy display name. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sodviolationcheckresult.md b/sdk-output/access_requests/docs/Models/Sodviolationcheckresult.md new file mode 100644 index 00000000..68dac25b --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sodviolationcheckresult.md @@ -0,0 +1,22 @@ +--- +id: v1-sodviolationcheckresult-v1 +title: SodviolationcheckresultV1 +pagination_label: SodviolationcheckresultV1 +sidebar_label: SodviolationcheckresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcheckresultV1', 'v1SodviolationcheckresultV1'] +slug: /tools/sdk/typescript/access_requests/models/sodviolationcheckresult-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcheckresultV1', 'v1SodviolationcheckresultV1'] +--- + +# SodviolationcheckresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **ErrormessagedtoV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [default to undefined] +**violationContexts** | **(optional)** **Array<SodviolationcontextV1>** | | [default to undefined] +**violatedPolicies** | **(optional)** **Array<SodpolicydtoV1>** | A list of the SOD policies that were violated. | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sodviolationcontext.md b/sdk-output/access_requests/docs/Models/Sodviolationcontext.md new file mode 100644 index 00000000..aad2a6bf --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sodviolationcontext.md @@ -0,0 +1,20 @@ +--- +id: v1-sodviolationcontext-v1 +title: SodviolationcontextV1 +pagination_label: SodviolationcontextV1 +sidebar_label: SodviolationcontextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextV1', 'v1SodviolationcontextV1'] +slug: /tools/sdk/typescript/access_requests/models/sodviolationcontext-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextV1', 'v1SodviolationcontextV1'] +--- + +# SodviolationcontextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | **(optional)** **SodpolicydtoV1** | | [default to undefined] +**conflictingAccessCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteria.md b/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteria.md new file mode 100644 index 00000000..f4bd7ead --- /dev/null +++ b/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-sodviolationcontext-conflicting-access-criteria-v1 +title: SodviolationcontextConflictingAccessCriteriaV1 +pagination_label: SodviolationcontextConflictingAccessCriteriaV1 +sidebar_label: SodviolationcontextConflictingAccessCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextConflictingAccessCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaV1'] +slug: /tools/sdk/typescript/access_requests/models/sodviolationcontext-conflicting-access-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextConflictingAccessCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaV1'] +--- + +# SodviolationcontextConflictingAccessCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leftCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1** | | [default to undefined] +**rightCriteria** | **(optional)** **SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md b/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 00000000..ed728a05 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/SodviolationcontextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-sodviolationcontext-conflicting-access-criteria-left-criteria-v1 +title: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +pagination_label: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +sidebar_label: SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1'] +slug: /tools/sdk/typescript/access_requests/models/sodviolationcontext-conflicting-access-criteria-left-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1', 'v1SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1'] +--- + +# SodviolationcontextConflictingAccessCriteriaLeftCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteriaList** | **(optional)** **Array<SodexemptcriteriaV1>** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sodviolationcontextcheckcompleted.md b/sdk-output/access_requests/docs/Models/Sodviolationcontextcheckcompleted.md new file mode 100644 index 00000000..f5086cd3 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sodviolationcontextcheckcompleted.md @@ -0,0 +1,21 @@ +--- +id: v1-sodviolationcontextcheckcompleted-v1 +title: SodviolationcontextcheckcompletedV1 +pagination_label: SodviolationcontextcheckcompletedV1 +sidebar_label: SodviolationcontextcheckcompletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcontextcheckcompletedV1', 'v1SodviolationcontextcheckcompletedV1'] +slug: /tools/sdk/typescript/access_requests/models/sodviolationcontextcheckcompleted-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcontextcheckcompletedV1', 'v1SodviolationcontextcheckcompletedV1'] +--- + +# SodviolationcontextcheckcompletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **(optional)** **string** | The status of SOD violation check | [default to undefined] +**uuid** | **(optional)** **string** | The id of the Violation check event | [default to undefined] +**violationCheckResult** | **(optional)** **SodviolationcheckresultV1** | | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sourceaccountselections.md b/sdk-output/access_requests/docs/Models/Sourceaccountselections.md new file mode 100644 index 00000000..146e14c6 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sourceaccountselections.md @@ -0,0 +1,22 @@ +--- +id: v1-sourceaccountselections-v1 +title: SourceaccountselectionsV1 +pagination_label: SourceaccountselectionsV1 +sidebar_label: SourceaccountselectionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceaccountselectionsV1', 'v1SourceaccountselectionsV1'] +slug: /tools/sdk/typescript/access_requests/models/sourceaccountselections-v1 +tags: ['SDK', 'Software Development Kit', 'SourceaccountselectionsV1', 'v1SourceaccountselectionsV1'] +--- + +# SourceaccountselectionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The source id | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] +**accounts** | **(optional)** **Array<AccountinforefV1>** | The accounts information for a particular source in the requested item | [default to undefined] + diff --git a/sdk-output/access_requests/docs/Models/Sourceitemref.md b/sdk-output/access_requests/docs/Models/Sourceitemref.md new file mode 100644 index 00000000..0dd992b9 --- /dev/null +++ b/sdk-output/access_requests/docs/Models/Sourceitemref.md @@ -0,0 +1,20 @@ +--- +id: v1-sourceitemref-v1 +title: SourceitemrefV1 +pagination_label: SourceitemrefV1 +sidebar_label: SourceitemrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceitemrefV1', 'v1SourceitemrefV1'] +slug: /tools/sdk/typescript/access_requests/models/sourceitemref-v1 +tags: ['SDK', 'Software Development Kit', 'SourceitemrefV1', 'v1SourceitemrefV1'] +--- + +# SourceitemrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **(optional)** **string** | The id for the source on which account selections are made | [default to undefined] +**accounts** | **(optional)** **Array<AccountitemrefV1>** | A list of account selections on the source. Currently, only one selection per source is supported. | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/account_activities/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bbb2223f --- /dev/null +++ b/sdk-output/account_activities/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,37 @@ +- path: /account-activities/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_activities/methods/account-activities#get-account-activity-v1 + source: | + import { AccountActivitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountActivitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account activity id (default to undefined) + const result = await apiInstance.getAccountActivityV1(id); + console.log(result); +- path: /account-activities/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_activities/methods/account-activities#list-account-activities-v1 + source: | + import { AccountActivitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountActivitiesV1Api(configuration); + const requestedFor: string = '2c91808568c529c60168cca6f90c1313'; // string | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const requestedBy: string = '2c91808568c529c60168cca6f90c1313'; // string | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) (default to undefined) + const regardingIdentity: string = '2c91808568c529c60168cca6f90c1313'; // string | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'type eq "Identity Refresh"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) (default to undefined) + const sorters: string = 'created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) (default to undefined) + const result = await apiInstance.listAccountActivitiesV1(); + console.log(result); diff --git a/sdk-output/account_activities/docs/Methods/AccountActivitiesV1Api.md b/sdk-output/account_activities/docs/Methods/AccountActivitiesV1Api.md new file mode 100644 index 00000000..a93a3967 --- /dev/null +++ b/sdk-output/account_activities/docs/Methods/AccountActivitiesV1Api.md @@ -0,0 +1,144 @@ +--- +id: v1-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountActivities', 'v1AccountActivities'] +slug: /tools/sdk/typescript/account_activities/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'v1AccountActivities'] +--- + +# AccountActivitiesV1Api + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-activity-v1**](#get-account-activity-v1) | **GET** `/account-activities/v1/{id}` | Get an account activity +[**list-account-activities-v1**](#list-account-activities-v1) | **GET** `/account-activities/v1` | List account activities + + +## get-account-activity-v1 +Get an account activity +This gets a single account activity by its id. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-activity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account activity id | [default to undefined] + +### Return type + +**AccountactivityV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountActivitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountActivitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account activity id +const result = await apiInstance.getAccountActivityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-account-activities-v1 +List account activities +This gets a collection of account activities that satisfy the given query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-account-activities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**requestedBy** | **string** | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. | [optional] [default to undefined] +**regardingIdentity** | **string** | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountActivitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountActivitiesV1Api(configuration); +const requestedFor: string = 2c91808568c529c60168cca6f90c1313; // The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const requestedBy: string = 2c91808568c529c60168cca6f90c1313; // The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +const regardingIdentity: string = 2c91808568c529c60168cca6f90c1313; // The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = type eq "Identity Refresh"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) +const sorters: string = created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) +const result = await apiInstance.listAccountActivitiesV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/account_activities/docs/Methods/Index.md b/sdk-output/account_activities/docs/Methods/Index.md new file mode 100644 index 00000000..cc951449 --- /dev/null +++ b/sdk-output/account_activities/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: account_activities-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: account_activities-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'account_activities', 'methods'] +slug: /tools/sdk/typescript/account_activities/methods +tags: ['SDK', 'Software Development Kit', 'account_activities', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/account_activities/docs/Models/Accountactivity.md b/sdk-output/account_activities/docs/Models/Accountactivity.md new file mode 100644 index 00000000..a52491c9 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Accountactivity.md @@ -0,0 +1,32 @@ +--- +id: v1-accountactivity-v1 +title: AccountactivityV1 +pagination_label: AccountactivityV1 +sidebar_label: AccountactivityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactivityV1', 'v1AccountactivityV1'] +slug: /tools/sdk/typescript/account_activities/models/accountactivity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactivityV1', 'v1AccountactivityV1'] +--- + +# AccountactivityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the account activity | [default to undefined] +**name** | **(optional)** **string** | The name of the activity | [default to undefined] +**created** | **(optional)** **string** | When the activity was first created | [default to undefined] +**modified** | **(optional)** **string** | When the activity was last modified | [default to undefined] +**completed** | **(optional)** **string** | When the activity was completed | [default to undefined] +**completionStatus** | **(optional)** **CompletionstatusV1** | | [default to undefined] +**type** | **(optional)** **string** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [default to undefined] +**requesterIdentitySummary** | **(optional)** **IdentitysummaryV1** | | [default to undefined] +**targetIdentitySummary** | **(optional)** **IdentitysummaryV1** | | [default to undefined] +**errors** | **(optional)** **Array<string>** | A list of error messages, if any, that were encountered. | [default to undefined] +**warnings** | **(optional)** **Array<string>** | A list of warning messages, if any, that were encountered. | [default to undefined] +**items** | **(optional)** **Array<AccountactivityitemV1>** | Individual actions performed as part of this account activity | [default to undefined] +**executionStatus** | **(optional)** **ExecutionstatusV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs, if any were included in the corresponding access request | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Accountactivityapprovalstatus.md b/sdk-output/account_activities/docs/Models/Accountactivityapprovalstatus.md new file mode 100644 index 00000000..cb220bb9 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Accountactivityapprovalstatus.md @@ -0,0 +1,29 @@ +--- +id: v1-accountactivityapprovalstatus-v1 +title: AccountactivityapprovalstatusV1 +pagination_label: AccountactivityapprovalstatusV1 +sidebar_label: AccountactivityapprovalstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactivityapprovalstatusV1', 'v1AccountactivityapprovalstatusV1'] +slug: /tools/sdk/typescript/account_activities/models/accountactivityapprovalstatus-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactivityapprovalstatusV1', 'v1AccountactivityapprovalstatusV1'] +--- + +# AccountactivityapprovalstatusV1 + +## Enum + + +* `Finished` (value: `'FINISHED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Returned` (value: `'RETURNED'`) + +* `Expired` (value: `'EXPIRED'`) + +* `Pending` (value: `'PENDING'`) + +* `Canceled` (value: `'CANCELED'`) + + diff --git a/sdk-output/account_activities/docs/Models/Accountactivityitem.md b/sdk-output/account_activities/docs/Models/Accountactivityitem.md new file mode 100644 index 00000000..a0818979 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Accountactivityitem.md @@ -0,0 +1,34 @@ +--- +id: v1-accountactivityitem-v1 +title: AccountactivityitemV1 +pagination_label: AccountactivityitemV1 +sidebar_label: AccountactivityitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactivityitemV1', 'v1AccountactivityitemV1'] +slug: /tools/sdk/typescript/account_activities/models/accountactivityitem-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactivityitemV1', 'v1AccountactivityitemV1'] +--- + +# AccountactivityitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Item id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of item | [default to undefined] +**requested** | **(optional)** **string** | Date and time item was requested | [default to undefined] +**approvalStatus** | **(optional)** **AccountactivityapprovalstatusV1** | | [default to undefined] +**provisioningStatus** | **(optional)** **ProvisioningstateV1** | | [default to undefined] +**requesterComment** | **(optional)** **CommentV1** | | [default to undefined] +**reviewerIdentitySummary** | **(optional)** **IdentitysummaryV1** | | [default to undefined] +**reviewerComment** | **(optional)** **CommentV1** | | [default to undefined] +**operation** | **(optional)** **AccountactivityitemoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Attribute to which account activity applies | [default to undefined] +**value** | **(optional)** **string** | Value of attribute | [default to undefined] +**nativeIdentity** | **(optional)** **string** | Native identity in the target system to which the account activity applies | [default to undefined] +**sourceId** | **(optional)** **string** | Id of Source to which account activity applies | [default to undefined] +**accountRequestInfo** | **(optional)** **AccountrequestinfoV1** | | [default to undefined] +**clientMetadata** | **(optional)** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [default to undefined] +**removeDate** | **(optional)** **string** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Accountactivityitemoperation.md b/sdk-output/account_activities/docs/Models/Accountactivityitemoperation.md new file mode 100644 index 00000000..c55006ee --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Accountactivityitemoperation.md @@ -0,0 +1,37 @@ +--- +id: v1-accountactivityitemoperation-v1 +title: AccountactivityitemoperationV1 +pagination_label: AccountactivityitemoperationV1 +sidebar_label: AccountactivityitemoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactivityitemoperationV1', 'v1AccountactivityitemoperationV1'] +slug: /tools/sdk/typescript/account_activities/models/accountactivityitemoperation-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactivityitemoperationV1', 'v1AccountactivityitemoperationV1'] +--- + +# AccountactivityitemoperationV1 + +## Enum + + +* `Add` (value: `'ADD'`) + +* `Create` (value: `'CREATE'`) + +* `Modify` (value: `'MODIFY'`) + +* `Delete` (value: `'DELETE'`) + +* `Disable` (value: `'DISABLE'`) + +* `Enable` (value: `'ENABLE'`) + +* `Unlock` (value: `'UNLOCK'`) + +* `Lock` (value: `'LOCK'`) + +* `Remove` (value: `'REMOVE'`) + +* `Set` (value: `'SET'`) + + diff --git a/sdk-output/account_activities/docs/Models/Accountrequestinfo.md b/sdk-output/account_activities/docs/Models/Accountrequestinfo.md new file mode 100644 index 00000000..3ea6d26b --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Accountrequestinfo.md @@ -0,0 +1,21 @@ +--- +id: v1-accountrequestinfo-v1 +title: AccountrequestinfoV1 +pagination_label: AccountrequestinfoV1 +sidebar_label: AccountrequestinfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestinfoV1', 'v1AccountrequestinfoV1'] +slug: /tools/sdk/typescript/account_activities/models/accountrequestinfo-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestinfoV1', 'v1AccountrequestinfoV1'] +--- + +# AccountrequestinfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestedObjectId** | **(optional)** **string** | Id of requested object | [default to undefined] +**requestedObjectName** | **(optional)** **string** | Human-readable name of requested object | [default to undefined] +**requestedObjectType** | **(optional)** **RequestableobjecttypeV1** | | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Comment.md b/sdk-output/account_activities/docs/Models/Comment.md new file mode 100644 index 00000000..0863b59d --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Comment.md @@ -0,0 +1,22 @@ +--- +id: v1-comment-v1 +title: CommentV1 +pagination_label: CommentV1 +sidebar_label: CommentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommentV1', 'v1CommentV1'] +slug: /tools/sdk/typescript/account_activities/models/comment-v1 +tags: ['SDK', 'Software Development Kit', 'CommentV1', 'v1CommentV1'] +--- + +# CommentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commenterId** | **(optional)** **string** | Id of the identity making the comment | [default to undefined] +**commenterName** | **(optional)** **string** | Human-readable display name of the identity making the comment | [default to undefined] +**body** | **(optional)** **string** | Content of the comment | [default to undefined] +**date** | **(optional)** **string** | Date and time comment was made | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Completionstatus.md b/sdk-output/account_activities/docs/Models/Completionstatus.md new file mode 100644 index 00000000..24370798 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Completionstatus.md @@ -0,0 +1,25 @@ +--- +id: v1-completionstatus-v1 +title: CompletionstatusV1 +pagination_label: CompletionstatusV1 +sidebar_label: CompletionstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompletionstatusV1', 'v1CompletionstatusV1'] +slug: /tools/sdk/typescript/account_activities/models/completionstatus-v1 +tags: ['SDK', 'Software Development Kit', 'CompletionstatusV1', 'v1CompletionstatusV1'] +--- + +# CompletionstatusV1 + +## Enum + + +* `Success` (value: `'SUCCESS'`) + +* `Failure` (value: `'FAILURE'`) + +* `Incomplete` (value: `'INCOMPLETE'`) + +* `Pending` (value: `'PENDING'`) + + diff --git a/sdk-output/account_activities/docs/Models/Errormessagedto.md b/sdk-output/account_activities/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..756a5312 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/account_activities/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Errorresponsedto.md b/sdk-output/account_activities/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..7ffa4755 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/account_activities/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Executionstatus.md b/sdk-output/account_activities/docs/Models/Executionstatus.md new file mode 100644 index 00000000..cc4cdf0f --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Executionstatus.md @@ -0,0 +1,25 @@ +--- +id: v1-executionstatus-v1 +title: ExecutionstatusV1 +pagination_label: ExecutionstatusV1 +sidebar_label: ExecutionstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExecutionstatusV1', 'v1ExecutionstatusV1'] +slug: /tools/sdk/typescript/account_activities/models/executionstatus-v1 +tags: ['SDK', 'Software Development Kit', 'ExecutionstatusV1', 'v1ExecutionstatusV1'] +--- + +# ExecutionstatusV1 + +## Enum + + +* `Executing` (value: `'EXECUTING'`) + +* `Verifying` (value: `'VERIFYING'`) + +* `Terminated` (value: `'TERMINATED'`) + +* `Completed` (value: `'COMPLETED'`) + + diff --git a/sdk-output/account_activities/docs/Models/Identitysummary.md b/sdk-output/account_activities/docs/Models/Identitysummary.md new file mode 100644 index 00000000..fb2d016f --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Identitysummary.md @@ -0,0 +1,22 @@ +--- +id: v1-identitysummary-v1 +title: IdentitysummaryV1 +pagination_label: IdentitysummaryV1 +sidebar_label: IdentitysummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitysummaryV1', 'v1IdentitysummaryV1'] +slug: /tools/sdk/typescript/account_activities/models/identitysummary-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitysummaryV1', 'v1IdentitysummaryV1'] +--- + +# IdentitysummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of this identity summary | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity | [default to undefined] +**identityId** | **(optional)** **string** | ID of the identity that this summary represents | [default to undefined] +**completed** | **(optional)** **boolean** | Indicates if all access items for this summary have been decided on | [default to false] + diff --git a/sdk-output/account_activities/docs/Models/Index.md b/sdk-output/account_activities/docs/Models/Index.md new file mode 100644 index 00000000..c57eefa4 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: account_activities-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: account_activities-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'account_activities', 'models'] +slug: /tools/sdk/typescript/account_activities/models +tags: ['SDK', 'Software Development Kit', 'account_activities', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1401Response.md b/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1401Response.md new file mode 100644 index 00000000..a8408428 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-account-activities-v1401-response-v1 +title: ListAccountActivitiesV1401ResponseV1 +pagination_label: ListAccountActivitiesV1401ResponseV1 +sidebar_label: ListAccountActivitiesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccountActivitiesV1401ResponseV1', 'v1ListAccountActivitiesV1401ResponseV1'] +slug: /tools/sdk/typescript/account_activities/models/list-account-activities-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccountActivitiesV1401ResponseV1', 'v1ListAccountActivitiesV1401ResponseV1'] +--- + +# ListAccountActivitiesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1429Response.md b/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1429Response.md new file mode 100644 index 00000000..a65cd08d --- /dev/null +++ b/sdk-output/account_activities/docs/Models/ListAccountActivitiesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-account-activities-v1429-response-v1 +title: ListAccountActivitiesV1429ResponseV1 +pagination_label: ListAccountActivitiesV1429ResponseV1 +sidebar_label: ListAccountActivitiesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccountActivitiesV1429ResponseV1', 'v1ListAccountActivitiesV1429ResponseV1'] +slug: /tools/sdk/typescript/account_activities/models/list-account-activities-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccountActivitiesV1429ResponseV1', 'v1ListAccountActivitiesV1429ResponseV1'] +--- + +# ListAccountActivitiesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_activities/docs/Models/Localeorigin.md b/sdk-output/account_activities/docs/Models/Localeorigin.md new file mode 100644 index 00000000..32ce8ef3 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/account_activities/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/account_activities/docs/Models/Provisioningstate.md b/sdk-output/account_activities/docs/Models/Provisioningstate.md new file mode 100644 index 00000000..56f180ef --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Provisioningstate.md @@ -0,0 +1,29 @@ +--- +id: v1-provisioningstate-v1 +title: ProvisioningstateV1 +pagination_label: ProvisioningstateV1 +sidebar_label: ProvisioningstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningstateV1', 'v1ProvisioningstateV1'] +slug: /tools/sdk/typescript/account_activities/models/provisioningstate-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningstateV1', 'v1ProvisioningstateV1'] +--- + +# ProvisioningstateV1 + +## Enum + + +* `Pending` (value: `'PENDING'`) + +* `Finished` (value: `'FINISHED'`) + +* `Unverifiable` (value: `'UNVERIFIABLE'`) + +* `Commited` (value: `'COMMITED'`) + +* `Failed` (value: `'FAILED'`) + +* `Retry` (value: `'RETRY'`) + + diff --git a/sdk-output/account_activities/docs/Models/README.md b/sdk-output/account_activities/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_activities/docs/Models/Requestableobjecttype.md b/sdk-output/account_activities/docs/Models/Requestableobjecttype.md new file mode 100644 index 00000000..50a7c8f1 --- /dev/null +++ b/sdk-output/account_activities/docs/Models/Requestableobjecttype.md @@ -0,0 +1,23 @@ +--- +id: v1-requestableobjecttype-v1 +title: RequestableobjecttypeV1 +pagination_label: RequestableobjecttypeV1 +sidebar_label: RequestableobjecttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableobjecttypeV1', 'v1RequestableobjecttypeV1'] +slug: /tools/sdk/typescript/account_activities/models/requestableobjecttype-v1 +tags: ['SDK', 'Software Development Kit', 'RequestableobjecttypeV1', 'v1RequestableobjecttypeV1'] +--- + +# RequestableobjecttypeV1 + +## Enum + + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Role` (value: `'ROLE'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + + diff --git a/sdk-output/account_aggregations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/account_aggregations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..9e4d86fa --- /dev/null +++ b/sdk-output/account_aggregations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,15 @@ +- path: /account-aggregations/v1/{id}/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_aggregations/methods/account-aggregations#get-account-aggregation-status-v1 + source: | + import { AccountAggregationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountAggregationsV1Api(configuration); + const id: string = '2c91808477a6b0c60177a81146b8110b'; // string | The account aggregation id (default to undefined) + const result = await apiInstance.getAccountAggregationStatusV1(id); + console.log(result); diff --git a/sdk-output/account_aggregations/docs/Methods/AccountAggregationsV1Api.md b/sdk-output/account_aggregations/docs/Methods/AccountAggregationsV1Api.md new file mode 100644 index 00000000..3f5a4335 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Methods/AccountAggregationsV1Api.md @@ -0,0 +1,77 @@ +--- +id: v1-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountAggregations', 'v1AccountAggregations'] +slug: /tools/sdk/typescript/account_aggregations/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'v1AccountAggregations'] +--- + +# AccountAggregationsV1Api + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + +If you are looking for the endpoint for account aggregations in a source, [click here](https://developer.sailpoint.com/docs/api/v2025/import-accounts) + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-account-aggregation-status-v1**](#get-account-aggregation-status-v1) | **GET** `/account-aggregations/v1/{id}/status` | In-progress account aggregation status + + +## get-account-aggregation-status-v1 +In-progress account aggregation status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* +required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-aggregation-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account aggregation id | [default to undefined] + +### Return type + +**AccountaggregationstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountAggregationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountAggregationsV1Api(configuration); +const id: string = 2c91808477a6b0c60177a81146b8110b; // The account aggregation id +const result = await apiInstance.getAccountAggregationStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/account_aggregations/docs/Methods/Index.md b/sdk-output/account_aggregations/docs/Methods/Index.md new file mode 100644 index 00000000..ec4ff6ec --- /dev/null +++ b/sdk-output/account_aggregations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: account_aggregations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: account_aggregations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'account_aggregations', 'methods'] +slug: /tools/sdk/typescript/account_aggregations/methods +tags: ['SDK', 'Software Development Kit', 'account_aggregations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/account_aggregations/docs/Models/Accountaggregationstatus.md b/sdk-output/account_aggregations/docs/Models/Accountaggregationstatus.md new file mode 100644 index 00000000..03237369 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/Accountaggregationstatus.md @@ -0,0 +1,26 @@ +--- +id: v1-accountaggregationstatus-v1 +title: AccountaggregationstatusV1 +pagination_label: AccountaggregationstatusV1 +sidebar_label: AccountaggregationstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountaggregationstatusV1', 'v1AccountaggregationstatusV1'] +slug: /tools/sdk/typescript/account_aggregations/models/accountaggregationstatus-v1 +tags: ['SDK', 'Software Development Kit', 'AccountaggregationstatusV1', 'v1AccountaggregationstatusV1'] +--- + +# AccountaggregationstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **(optional)** **string** | When the aggregation started. | [default to undefined] +**status** | **(optional)** **string** | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [default to undefined] +**totalAccounts** | **(optional)** **number** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] +**processedAccounts** | **(optional)** **number** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] +**totalAccountsMarkedForDeletion** | **(optional)** **number** | The total number of accounts that have been marked for deletion during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] +**deletedAccounts** | **(optional)** **number** | The number of accounts that have been deleted during the aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] +**totalIdentities** | **(optional)** **number** | The total number of unique identities that have been marked for refresh. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] +**processedIdentities** | **(optional)** **number** | The number of unique identities that have been refreshed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [default to undefined] + diff --git a/sdk-output/account_aggregations/docs/Models/Errormessagedto.md b/sdk-output/account_aggregations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..514dfdec --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/account_aggregations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/account_aggregations/docs/Models/Errorresponsedto.md b/sdk-output/account_aggregations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..a671b06f --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/account_aggregations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1400Response.md b/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1400Response.md new file mode 100644 index 00000000..4f593130 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1400Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-account-aggregation-status-v1400-response-v1 +title: GetAccountAggregationStatusV1400ResponseV1 +pagination_label: GetAccountAggregationStatusV1400ResponseV1 +sidebar_label: GetAccountAggregationStatusV1400ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccountAggregationStatusV1400ResponseV1', 'v1GetAccountAggregationStatusV1400ResponseV1'] +slug: /tools/sdk/typescript/account_aggregations/models/get-account-aggregation-status-v1400-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccountAggregationStatusV1400ResponseV1', 'v1GetAccountAggregationStatusV1400ResponseV1'] +--- + +# GetAccountAggregationStatusV1400ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1429Response.md b/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1429Response.md new file mode 100644 index 00000000..c630e341 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/GetAccountAggregationStatusV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-account-aggregation-status-v1429-response-v1 +title: GetAccountAggregationStatusV1429ResponseV1 +pagination_label: GetAccountAggregationStatusV1429ResponseV1 +sidebar_label: GetAccountAggregationStatusV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccountAggregationStatusV1429ResponseV1', 'v1GetAccountAggregationStatusV1429ResponseV1'] +slug: /tools/sdk/typescript/account_aggregations/models/get-account-aggregation-status-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccountAggregationStatusV1429ResponseV1', 'v1GetAccountAggregationStatusV1429ResponseV1'] +--- + +# GetAccountAggregationStatusV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_aggregations/docs/Models/Index.md b/sdk-output/account_aggregations/docs/Models/Index.md new file mode 100644 index 00000000..3d14f3f1 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: account_aggregations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: account_aggregations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'account_aggregations', 'models'] +slug: /tools/sdk/typescript/account_aggregations/models +tags: ['SDK', 'Software Development Kit', 'account_aggregations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/account_aggregations/docs/Models/Localeorigin.md b/sdk-output/account_aggregations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..928434ff --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/account_aggregations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/account_aggregations/docs/Models/README.md b/sdk-output/account_aggregations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_aggregations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_deletion_requests/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/account_deletion_requests/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..37bbc056 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,34 @@ +- path: /account-requests/v1/account/{accountId}/delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_deletion_requests/methods/account-deletion-requests#delete-account-request-v1 + source: | + import { AccountDeletionRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountDeletionRequestsV1Api(configuration); + const accountId: string = 'ef38f94347e94562b5bb8424a56498d8'; // string | Account ID. (default to undefined) + const accountdeleterequestinputV1: AccountdeleterequestinputV1 = {"comments":"I requested this account deletion."}; // AccountdeleterequestinputV1 | (optional) + const result = await apiInstance.deleteAccountRequestV1(accountId); + console.log(result); +- path: /account-requests/v1/deletion + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_deletion_requests/methods/account-deletion-requests#get-account-deletion-requests-v1 + source: | + import { AccountDeletionRequestsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountDeletionRequestsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const mine: boolean = true; // boolean | Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. (optional) (default to false) + const result = await apiInstance.getAccountDeletionRequestsV1(); + console.log(result); diff --git a/sdk-output/account_deletion_requests/docs/Methods/AccountDeletionRequestsV1Api.md b/sdk-output/account_deletion_requests/docs/Methods/AccountDeletionRequestsV1Api.md new file mode 100644 index 00000000..2b3f9432 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Methods/AccountDeletionRequestsV1Api.md @@ -0,0 +1,108 @@ +--- +id: v1-account-deletion-requests +title: AccountDeletionRequests +pagination_label: AccountDeletionRequests +sidebar_label: AccountDeletionRequests +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountDeletionRequests', 'v1AccountDeletionRequests'] +slug: /tools/sdk/typescript/account_deletion_requests/methods/account-deletion-requests +tags: ['SDK', 'Software Development Kit', 'AccountDeletionRequests', 'v1AccountDeletionRequests'] +--- + +# AccountDeletionRequestsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-account-request-v1**](#delete-account-request-v1) | **POST** `/account-requests/v1/account/{accountId}/delete` | Delete account +[**get-account-deletion-requests-v1**](#get-account-deletion-requests-v1) | **GET** `/account-requests/v1/deletion` | List of Account Deletion Requests + + +## delete-account-request-v1 +Delete account +Initiates an account deletion request for the specified account. +This method validates the input data, processes the deletion request, +and generates an asynchronous result containing a tracking ID. +>**NOTE: You can only delete accounts from sources of the "Connected" type. which supports account deletion** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-account-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accountId** | **string** | Account ID. | [default to undefined] +**accountdeleterequestinputV1** | **AccountdeleterequestinputV1** | | [optional] + +### Return type + +**AccountrequestasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountDeletionRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountDeletionRequestsV1Api(configuration); +const accountId: string = ef38f94347e94562b5bb8424a56498d8; // Account ID. +const accountdeleterequestinputV1: AccountdeleterequestinputV1 = {"comments":"I requested this account deletion."}; // (optional) +const result = await apiInstance.deleteAccountRequestV1(accountId); +console.log(result); +``` + +[[Back to top]](#) + +## get-account-deletion-requests-v1 +List of Account Deletion Requests +Retrieves a paginated list of account deletion requests filtered by the provided query parameters. When the "mine" parameter is set to true, the response includes only those deletion requests that were initiated by the currently authenticated user. If "mine" is false or not specified, the endpoint returns all account deletion requests associated with the current tenant, regardless of the initiator. This allows both users and administrators to view relevant deletion requests based on their access level and intent. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-deletion-requests-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**mine** | **boolean** | Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountDeletionRequestsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountDeletionRequestsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const mine: boolean = true; // Determines whether to return only the account deletion requests initiated by the currently authenticated user. If set to true, the response includes only deletion requests created by the logged-in user. If set to false or not provided, the response includes all deletion requests for the tenant, regardless of the initiator. This parameter allows users to view their own requests, while administrators can view all requests within the tenant. (optional) +const result = await apiInstance.getAccountDeletionRequestsV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/account_deletion_requests/docs/Methods/Index.md b/sdk-output/account_deletion_requests/docs/Methods/Index.md new file mode 100644 index 00000000..a70dfaa8 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: account_deletion_requests-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: account_deletion_requests-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'account_deletion_requests', 'methods'] +slug: /tools/sdk/typescript/account_deletion_requests/methods +tags: ['SDK', 'Software Development Kit', 'account_deletion_requests', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountactionrequestdto.md b/sdk-output/account_deletion_requests/docs/Models/Accountactionrequestdto.md new file mode 100644 index 00000000..a6e7103a --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountactionrequestdto.md @@ -0,0 +1,32 @@ +--- +id: v1-accountactionrequestdto-v1 +title: AccountactionrequestdtoV1 +pagination_label: AccountactionrequestdtoV1 +sidebar_label: AccountactionrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactionrequestdtoV1', 'v1AccountactionrequestdtoV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountactionrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactionrequestdtoV1', 'v1AccountactionrequestdtoV1'] +--- + +# AccountactionrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountRequestId** | **(optional)** **string** | Account requester ID. | [default to undefined] +**requestType** | **(optional)** **string** | Access item requester\'s identity ID. | [default to undefined] +**createdAt** | **(optional)** **string** | Creation date and time of account deletion request date. | [readonly] [default to undefined] +**completedAt** | **(optional)** **string** | Account deletion request completion date and time. | [readonly] [default to undefined] +**overallStatus** | **(optional)** **string** | Overall status of deletion request. | [default to undefined] +**requester** | **(optional)** **AccountactionrequestdtoRequesterV1** | | [default to undefined] +**requesterComments** | **(optional)** **string** | Comments added by the requester while creating the account deletion request. | [default to undefined] +**accountDetails** | **(optional)** **AccountactionrequestdtoAccountDetailsV1** | | [default to undefined] +**correlatedIdentity** | **(optional)** **AccountactionrequestdtoCorrelatedIdentityV1** | | [default to undefined] +**managerReference** | **(optional)** **IdentityreferenceV1** | | [default to undefined] +**approvalRequestId** | **(optional)** **string** | ID of the approval request associated with the account deletion action. | [default to undefined] +**accountRequestPhases** | **(optional)** **Array<AccountrequestphaseV1>** | List of account request phases. | [default to undefined] +**approvalDetails** | **(optional)** **Array<ApprovaldetailsV1>** | List approval details | [default to undefined] +**errorDetails** | **(optional)** **string** | Detailed error information. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoAccountDetails.md b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoAccountDetails.md new file mode 100644 index 00000000..eded7cfc --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoAccountDetails.md @@ -0,0 +1,38 @@ +--- +id: v1-accountactionrequestdto-account-details-v1 +title: AccountactionrequestdtoAccountDetailsV1 +pagination_label: AccountactionrequestdtoAccountDetailsV1 +sidebar_label: AccountactionrequestdtoAccountDetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactionrequestdtoAccountDetailsV1', 'v1AccountactionrequestdtoAccountDetailsV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountactionrequestdto-account-details-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactionrequestdtoAccountDetailsV1', 'v1AccountactionrequestdtoAccountDetailsV1'] +--- + +# AccountactionrequestdtoAccountDetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | unique id of this object | [default to undefined] +**name** | **(optional)** **string** | | [default to undefined] +**accountId** | **(optional)** **string** | | [default to undefined] +**description** | **(optional)** **string** | | [default to undefined] +**nativeIdentity** | **(optional)** **string** | | [default to undefined] +**uuid** | **(optional)** **string** | | [default to undefined] +**displayName** | **(optional)** **string** | | [default to undefined] +**disabled** | **(optional)** **boolean** | | [default to undefined] +**locked** | **(optional)** **boolean** | | [default to undefined] +**uncorrelated** | **(optional)** **boolean** | | [default to undefined] +**systemAccount** | **(optional)** **boolean** | | [default to undefined] +**authoritative** | **(optional)** **boolean** | | [default to undefined] +**supportsPasswordChange** | **(optional)** **boolean** | | [default to undefined] +**attributes** | **(optional)** **object** | | [default to undefined] +**application** | **(optional)** **object** | | [default to undefined] +**identity** | **(optional)** **object** | | [default to undefined] +**schema** | **(optional)** **object** | | [default to undefined] +**pendingAccessRequestIds** | **(optional)** **Array<string>** | | [default to undefined] +**features** | **(optional)** **Array<string>** | | [default to undefined] +**meta** | **(optional)** **object** | | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoCorrelatedIdentity.md b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoCorrelatedIdentity.md new file mode 100644 index 00000000..379e2e4e --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoCorrelatedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-accountactionrequestdto-correlated-identity-v1 +title: AccountactionrequestdtoCorrelatedIdentityV1 +pagination_label: AccountactionrequestdtoCorrelatedIdentityV1 +sidebar_label: AccountactionrequestdtoCorrelatedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactionrequestdtoCorrelatedIdentityV1', 'v1AccountactionrequestdtoCorrelatedIdentityV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountactionrequestdto-correlated-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactionrequestdtoCorrelatedIdentityV1', 'v1AccountactionrequestdtoCorrelatedIdentityV1'] +--- + +# AccountactionrequestdtoCorrelatedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoRequester.md b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoRequester.md new file mode 100644 index 00000000..79f22e84 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/AccountactionrequestdtoRequester.md @@ -0,0 +1,21 @@ +--- +id: v1-accountactionrequestdto-requester-v1 +title: AccountactionrequestdtoRequesterV1 +pagination_label: AccountactionrequestdtoRequesterV1 +sidebar_label: AccountactionrequestdtoRequesterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactionrequestdtoRequesterV1', 'v1AccountactionrequestdtoRequesterV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountactionrequestdto-requester-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactionrequestdtoRequesterV1', 'v1AccountactionrequestdtoRequesterV1'] +--- + +# AccountactionrequestdtoRequesterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountdeleterequestinput.md b/sdk-output/account_deletion_requests/docs/Models/Accountdeleterequestinput.md new file mode 100644 index 00000000..f2bcfab7 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountdeleterequestinput.md @@ -0,0 +1,19 @@ +--- +id: v1-accountdeleterequestinput-v1 +title: AccountdeleterequestinputV1 +pagination_label: AccountdeleterequestinputV1 +sidebar_label: AccountdeleterequestinputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountdeleterequestinputV1', 'v1AccountdeleterequestinputV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountdeleterequestinput-v1 +tags: ['SDK', 'Software Development Kit', 'AccountdeleterequestinputV1', 'v1AccountdeleterequestinputV1'] +--- + +# AccountdeleterequestinputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comments** | **(optional)** **string** | Reason for deleting the account. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountdetails.md b/sdk-output/account_deletion_requests/docs/Models/Accountdetails.md new file mode 100644 index 00000000..877c9620 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountdetails.md @@ -0,0 +1,38 @@ +--- +id: v1-accountdetails-v1 +title: AccountdetailsV1 +pagination_label: AccountdetailsV1 +sidebar_label: AccountdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountdetailsV1', 'v1AccountdetailsV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountdetails-v1 +tags: ['SDK', 'Software Development Kit', 'AccountdetailsV1', 'v1AccountdetailsV1'] +--- + +# AccountdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | unique id of this object | [default to undefined] +**name** | **(optional)** **string** | | [default to undefined] +**accountId** | **(optional)** **string** | | [default to undefined] +**description** | **(optional)** **string** | | [default to undefined] +**nativeIdentity** | **(optional)** **string** | | [default to undefined] +**uuid** | **(optional)** **string** | | [default to undefined] +**displayName** | **(optional)** **string** | | [default to undefined] +**disabled** | **(optional)** **boolean** | | [default to undefined] +**locked** | **(optional)** **boolean** | | [default to undefined] +**uncorrelated** | **(optional)** **boolean** | | [default to undefined] +**systemAccount** | **(optional)** **boolean** | | [default to undefined] +**authoritative** | **(optional)** **boolean** | | [default to undefined] +**supportsPasswordChange** | **(optional)** **boolean** | | [default to undefined] +**attributes** | **(optional)** **object** | | [default to undefined] +**application** | **(optional)** **object** | | [default to undefined] +**identity** | **(optional)** **object** | | [default to undefined] +**schema** | **(optional)** **object** | | [default to undefined] +**pendingAccessRequestIds** | **(optional)** **Array<string>** | | [default to undefined] +**features** | **(optional)** **Array<string>** | | [default to undefined] +**meta** | **(optional)** **object** | | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountrequestasyncresult.md b/sdk-output/account_deletion_requests/docs/Models/Accountrequestasyncresult.md new file mode 100644 index 00000000..b0442877 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountrequestasyncresult.md @@ -0,0 +1,19 @@ +--- +id: v1-accountrequestasyncresult-v1 +title: AccountrequestasyncresultV1 +pagination_label: AccountrequestasyncresultV1 +sidebar_label: AccountrequestasyncresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestasyncresultV1', 'v1AccountrequestasyncresultV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountrequestasyncresult-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestasyncresultV1', 'v1AccountrequestasyncresultV1'] +--- + +# AccountrequestasyncresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountRequestId** | **string** | Id of the account request | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountrequestphase.md b/sdk-output/account_deletion_requests/docs/Models/Accountrequestphase.md new file mode 100644 index 00000000..074169b5 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountrequestphase.md @@ -0,0 +1,22 @@ +--- +id: v1-accountrequestphase-v1 +title: AccountrequestphaseV1 +pagination_label: AccountrequestphaseV1 +sidebar_label: AccountrequestphaseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestphaseV1', 'v1AccountrequestphaseV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountrequestphase-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestphaseV1', 'v1AccountrequestphaseV1'] +--- + +# AccountrequestphaseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Enum of account request phase type | [default to undefined] +**state** | **(optional)** **AccountrequestphasestateV1** | | [default to undefined] +**started** | **(optional)** **string** | Start date of account request phase. | [readonly] [default to undefined] +**finished** | **(optional)** **string** | Finish date of account request phase. | [readonly] [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Accountrequestphasestate.md b/sdk-output/account_deletion_requests/docs/Models/Accountrequestphasestate.md new file mode 100644 index 00000000..d8feb100 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Accountrequestphasestate.md @@ -0,0 +1,31 @@ +--- +id: v1-accountrequestphasestate-v1 +title: AccountrequestphasestateV1 +pagination_label: AccountrequestphasestateV1 +sidebar_label: AccountrequestphasestateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestphasestateV1', 'v1AccountrequestphasestateV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/accountrequestphasestate-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestphasestateV1', 'v1AccountrequestphasestateV1'] +--- + +# AccountrequestphasestateV1 + +## Enum + + +* `Pending` (value: `'PENDING'`) + +* `Cancelled` (value: `'CANCELLED'`) + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Passed` (value: `'PASSED'`) + +* `Failed` (value: `'FAILED'`) + +* `NotStarted` (value: `'NOT_STARTED'`) + + diff --git a/sdk-output/account_deletion_requests/docs/Models/Approvaldetails.md b/sdk-output/account_deletion_requests/docs/Models/Approvaldetails.md new file mode 100644 index 00000000..0ea49208 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Approvaldetails.md @@ -0,0 +1,23 @@ +--- +id: v1-approvaldetails-v1 +title: ApprovaldetailsV1 +pagination_label: ApprovaldetailsV1 +sidebar_label: ApprovaldetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovaldetailsV1', 'v1ApprovaldetailsV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/approvaldetails-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovaldetailsV1', 'v1ApprovaldetailsV1'] +--- + +# ApprovaldetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approver** | **(optional)** **ApproverdtoV1** | | [default to undefined] +**approverComments** | **(optional)** **string** | Comments added by approver while rejecting or approving the account deletion request. | [default to undefined] +**decisionDate** | **(optional)** **string** | Decision date of approval rejected or approved. | [readonly] [default to undefined] +**serialOrder** | **(optional)** **number** | SerialOrder of approval details. | [default to undefined] +**status** | **(optional)** **AccountrequestphasestateV1** | | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Approverdto.md b/sdk-output/account_deletion_requests/docs/Models/Approverdto.md new file mode 100644 index 00000000..903f9bb0 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Approverdto.md @@ -0,0 +1,26 @@ +--- +id: v1-approverdto-v1 +title: ApproverdtoV1 +pagination_label: ApproverdtoV1 +sidebar_label: ApproverdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApproverdtoV1', 'v1ApproverdtoV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/approverdto-v1 +tags: ['SDK', 'Software Development Kit', 'ApproverdtoV1', 'v1ApproverdtoV1'] +--- + +# ApproverdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityID** | **(optional)** **string** | Identity ID and it cannot be null. | [default to undefined] +**id** | **(optional)** **string** | Optional id | [default to undefined] +**name** | **(optional)** **string** | Identity display name | [default to undefined] +**email** | **(optional)** **string** | Email address of identity | [default to undefined] +**type** | **(optional)** **string** | Used to mention type of data transfer object in this case it is used to transfer IDENTITY data. | [default to undefined] +**ownerOf** | **(optional)** **Array<ApproverreferenceV1>** | List of reference of identity type dto for account owner identities | [default to undefined] +**actionedAs** | **(optional)** **Array<ApproverreferenceV1>** | List of reference of identity type dto who acted on behalf of other identities. | [default to undefined] +**members** | **(optional)** **Array<ApproverreferenceV1>** | List of reference of identity type dto for member identities. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Approverreference.md b/sdk-output/account_deletion_requests/docs/Models/Approverreference.md new file mode 100644 index 00000000..f5624b43 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Approverreference.md @@ -0,0 +1,21 @@ +--- +id: v1-approverreference-v1 +title: ApproverreferenceV1 +pagination_label: ApproverreferenceV1 +sidebar_label: ApproverreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApproverreferenceV1', 'v1ApproverreferenceV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/approverreference-v1 +tags: ['SDK', 'Software Development Kit', 'ApproverreferenceV1', 'v1ApproverreferenceV1'] +--- + +# ApproverreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of supported DtoType like IDENTITY, MACHINE_IDENTITY etc. | [default to undefined] +**type** | **(optional)** **string** | Type of Dto | [default to undefined] +**name** | **(optional)** **string** | Display name of DtoType like IDENTITY, MACHINE_IDENTITY etc | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Basereferencedto.md b/sdk-output/account_deletion_requests/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..995ffd35 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Dtotype.md b/sdk-output/account_deletion_requests/docs/Models/Dtotype.md new file mode 100644 index 00000000..f6122fcf --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/account_deletion_requests/docs/Models/Errormessagedto.md b/sdk-output/account_deletion_requests/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..9c58073b --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Errorresponsedto.md b/sdk-output/account_deletion_requests/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..ca033a4e --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1401Response.md b/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1401Response.md new file mode 100644 index 00000000..5a2692d0 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-account-deletion-requests-v1401-response-v1 +title: GetAccountDeletionRequestsV1401ResponseV1 +pagination_label: GetAccountDeletionRequestsV1401ResponseV1 +sidebar_label: GetAccountDeletionRequestsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccountDeletionRequestsV1401ResponseV1', 'v1GetAccountDeletionRequestsV1401ResponseV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/get-account-deletion-requests-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccountDeletionRequestsV1401ResponseV1', 'v1GetAccountDeletionRequestsV1401ResponseV1'] +--- + +# GetAccountDeletionRequestsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1429Response.md b/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1429Response.md new file mode 100644 index 00000000..37ab9681 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/GetAccountDeletionRequestsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-account-deletion-requests-v1429-response-v1 +title: GetAccountDeletionRequestsV1429ResponseV1 +pagination_label: GetAccountDeletionRequestsV1429ResponseV1 +sidebar_label: GetAccountDeletionRequestsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccountDeletionRequestsV1429ResponseV1', 'v1GetAccountDeletionRequestsV1429ResponseV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/get-account-deletion-requests-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccountDeletionRequestsV1429ResponseV1', 'v1GetAccountDeletionRequestsV1429ResponseV1'] +--- + +# GetAccountDeletionRequestsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Identityreference.md b/sdk-output/account_deletion_requests/docs/Models/Identityreference.md new file mode 100644 index 00000000..7f73c233 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Identityreference.md @@ -0,0 +1,21 @@ +--- +id: v1-identityreference-v1 +title: IdentityreferenceV1 +pagination_label: IdentityreferenceV1 +sidebar_label: IdentityreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/identityreference-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +--- + +# IdentityreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/account_deletion_requests/docs/Models/Index.md b/sdk-output/account_deletion_requests/docs/Models/Index.md new file mode 100644 index 00000000..1ffdb1a1 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: account_deletion_requests-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: account_deletion_requests-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'account_deletion_requests', 'models'] +slug: /tools/sdk/typescript/account_deletion_requests/models +tags: ['SDK', 'Software Development Kit', 'account_deletion_requests', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/account_deletion_requests/docs/Models/Localeorigin.md b/sdk-output/account_deletion_requests/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a7dc2157 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/account_deletion_requests/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/account_deletion_requests/docs/Models/README.md b/sdk-output/account_deletion_requests/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_deletion_requests/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/account_usages/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/account_usages/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f0b228e1 --- /dev/null +++ b/sdk-output/account_usages/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,19 @@ +- path: /account-usages/v1/{accountId}/summaries + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/account_usages/methods/account-usages#get-usages-by-account-id-v1 + source: | + import { AccountUsagesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountUsagesV1Api(configuration); + const accountId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | ID of IDN account (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = '-date'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) (default to undefined) + const result = await apiInstance.getUsagesByAccountIdV1(accountId); + console.log(result); diff --git a/sdk-output/account_usages/docs/Methods/AccountUsagesV1Api.md b/sdk-output/account_usages/docs/Methods/AccountUsagesV1Api.md new file mode 100644 index 00000000..69b10abd --- /dev/null +++ b/sdk-output/account_usages/docs/Methods/AccountUsagesV1Api.md @@ -0,0 +1,69 @@ +--- +id: v1-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountUsages', 'v1AccountUsages'] +slug: /tools/sdk/typescript/account_usages/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'v1AccountUsages'] +--- + +# AccountUsagesV1Api + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-usages-by-account-id-v1**](#get-usages-by-account-id-v1) | **GET** `/account-usages/v1/{accountId}/summaries` | Returns account usage insights + + +## get-usages-by-account-id-v1 +Returns account usage insights +This API returns a summary of account usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-usages-by-account-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accountId** | **string** | ID of IDN account | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountUsagesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountUsagesV1Api(configuration); +const accountId: string = ef38f94347e94562b5bb8424a56397d8; // ID of IDN account +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = -date; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) +const result = await apiInstance.getUsagesByAccountIdV1(accountId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/account_usages/docs/Methods/Index.md b/sdk-output/account_usages/docs/Methods/Index.md new file mode 100644 index 00000000..5abf0c03 --- /dev/null +++ b/sdk-output/account_usages/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: account_usages-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: account_usages-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'account_usages', 'methods'] +slug: /tools/sdk/typescript/account_usages/methods +tags: ['SDK', 'Software Development Kit', 'account_usages', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/account_usages/docs/Models/Accountusage.md b/sdk-output/account_usages/docs/Models/Accountusage.md new file mode 100644 index 00000000..f8ae32a5 --- /dev/null +++ b/sdk-output/account_usages/docs/Models/Accountusage.md @@ -0,0 +1,20 @@ +--- +id: v1-accountusage-v1 +title: AccountusageV1 +pagination_label: AccountusageV1 +sidebar_label: AccountusageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountusageV1', 'v1AccountusageV1'] +slug: /tools/sdk/typescript/account_usages/models/accountusage-v1 +tags: ['SDK', 'Software Development Kit', 'AccountusageV1', 'v1AccountusageV1'] +--- + +# AccountusageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date** | **(optional)** **string** | The first day of the month for which activity is aggregated. | [default to undefined] +**count** | **(optional)** **number** | The number of days within the month that the account was active in a source. | [default to undefined] + diff --git a/sdk-output/account_usages/docs/Models/Errormessagedto.md b/sdk-output/account_usages/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..10582965 --- /dev/null +++ b/sdk-output/account_usages/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/account_usages/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/account_usages/docs/Models/Errorresponsedto.md b/sdk-output/account_usages/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..02ecbc1b --- /dev/null +++ b/sdk-output/account_usages/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/account_usages/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1401Response.md b/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1401Response.md new file mode 100644 index 00000000..52cc0dfe --- /dev/null +++ b/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-usages-by-account-id-v1401-response-v1 +title: GetUsagesByAccountIdV1401ResponseV1 +pagination_label: GetUsagesByAccountIdV1401ResponseV1 +sidebar_label: GetUsagesByAccountIdV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetUsagesByAccountIdV1401ResponseV1', 'v1GetUsagesByAccountIdV1401ResponseV1'] +slug: /tools/sdk/typescript/account_usages/models/get-usages-by-account-id-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetUsagesByAccountIdV1401ResponseV1', 'v1GetUsagesByAccountIdV1401ResponseV1'] +--- + +# GetUsagesByAccountIdV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1429Response.md b/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1429Response.md new file mode 100644 index 00000000..10ab4379 --- /dev/null +++ b/sdk-output/account_usages/docs/Models/GetUsagesByAccountIdV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-usages-by-account-id-v1429-response-v1 +title: GetUsagesByAccountIdV1429ResponseV1 +pagination_label: GetUsagesByAccountIdV1429ResponseV1 +sidebar_label: GetUsagesByAccountIdV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetUsagesByAccountIdV1429ResponseV1', 'v1GetUsagesByAccountIdV1429ResponseV1'] +slug: /tools/sdk/typescript/account_usages/models/get-usages-by-account-id-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetUsagesByAccountIdV1429ResponseV1', 'v1GetUsagesByAccountIdV1429ResponseV1'] +--- + +# GetUsagesByAccountIdV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/account_usages/docs/Models/Index.md b/sdk-output/account_usages/docs/Models/Index.md new file mode 100644 index 00000000..39dd072f --- /dev/null +++ b/sdk-output/account_usages/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: account_usages-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: account_usages-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'account_usages', 'models'] +slug: /tools/sdk/typescript/account_usages/models +tags: ['SDK', 'Software Development Kit', 'account_usages', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/account_usages/docs/Models/Localeorigin.md b/sdk-output/account_usages/docs/Models/Localeorigin.md new file mode 100644 index 00000000..9d3ad1f4 --- /dev/null +++ b/sdk-output/account_usages/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/account_usages/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/account_usages/docs/Models/README.md b/sdk-output/account_usages/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/account_usages/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/accounts/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/accounts/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..30ec4be3 --- /dev/null +++ b/sdk-output/accounts/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,253 @@ +- path: /accounts/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#create-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const accountattributescreateV1: AccountattributescreateV1 = ; // AccountattributescreateV1 | + const result = await apiInstance.createAccountV1(accountattributescreateV1); + console.log(result); +- path: /accounts/v1/{id}/remove + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#delete-account-async-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'c350d6aa4f104c61b062cb632421ad10'; // string | The account id (default to undefined) + const result = await apiInstance.deleteAccountAsyncV1(id); + console.log(result); +- path: /accounts/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#delete-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Account ID. (default to undefined) + const result = await apiInstance.deleteAccountV1(id); + console.log(result); +- path: /identities-accounts/v1/{id}/disable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#disable-account-for-identity-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = '2c91808384203c2d018437e631158309'; // string | The identity id. (default to undefined) + const result = await apiInstance.disableAccountForIdentityV1(id); + console.log(result); +- path: /accounts/v1/{id}/disable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#disable-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account id (default to undefined) + const accounttogglerequestV1: AccounttogglerequestV1 = ; // AccounttogglerequestV1 | + const result = await apiInstance.disableAccountV1(id, accounttogglerequestV1); + console.log(result); +- path: /identities-accounts/v1/disable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#disable-accounts-for-identities-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 = ; // IdentitiesaccountsbulkrequestV1 | + const result = await apiInstance.disableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1); + console.log(result); +- path: /identities-accounts/v1/{id}/enable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#enable-account-for-identity-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = '2c91808384203c2d018437e631158309'; // string | The identity id. (default to undefined) + const result = await apiInstance.enableAccountForIdentityV1(id); + console.log(result); +- path: /accounts/v1/{id}/enable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#enable-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account id (default to undefined) + const accounttogglerequestV1: AccounttogglerequestV1 = ; // AccounttogglerequestV1 | + const result = await apiInstance.enableAccountV1(id, accounttogglerequestV1); + console.log(result); +- path: /identities-accounts/v1/enable + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#enable-accounts-for-identities-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 = ; // IdentitiesaccountsbulkrequestV1 | + const result = await apiInstance.enableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1); + console.log(result); +- path: /accounts/v1/{id}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#get-account-entitlements-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account id (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getAccountEntitlementsV1(id); + console.log(result); +- path: /accounts/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#get-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Account ID. (default to undefined) + const result = await apiInstance.getAccountV1(id); + console.log(result); +- path: /accounts/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#list-accounts-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const detailLevel: string = 'FULL'; // 'SLIM' | 'FULL' | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) (default to undefined) + const filters: string = 'identityId eq "2c9180858082150f0180893dbaf44201"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) (default to undefined) + const sorters: string = 'id,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) (default to undefined) + const result = await apiInstance.listAccountsV1(); + console.log(result); +- path: /accounts/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#put-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Account ID. (default to undefined) + const accountattributesV1: AccountattributesV1 = ; // AccountattributesV1 | + const result = await apiInstance.putAccountV1(id, accountattributesV1); + console.log(result); +- path: /accounts/v1/{id}/reload + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#submit-reload-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account id (default to undefined) + const result = await apiInstance.submitReloadAccountV1(id); + console.log(result); +- path: /accounts/v1/{id}/unlock + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#unlock-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account ID. (default to undefined) + const accountunlockrequestV1: AccountunlockrequestV1 = ; // AccountunlockrequestV1 | + const result = await apiInstance.unlockAccountV1(id, accountunlockrequestV1); + console.log(result); +- path: /accounts/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/accounts/methods/accounts#update-account-v1 + source: | + import { AccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Account ID. (default to undefined) + const requestBody: Array<object> = [{"op":"remove","path":"/identityId"}]; // Array | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.updateAccountV1(id, requestBody); + console.log(result); diff --git a/sdk-output/accounts/docs/Methods/AccountsV1Api.md b/sdk-output/accounts/docs/Methods/AccountsV1Api.md new file mode 100644 index 00000000..59505b70 --- /dev/null +++ b/sdk-output/accounts/docs/Methods/AccountsV1Api.md @@ -0,0 +1,732 @@ +--- +id: v1-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accounts', 'v1Accounts'] +slug: /tools/sdk/typescript/accounts/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'v1Accounts'] +--- + +# AccountsV1Api + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/accounts/identities.html?h=disabling+identities#managing-access) for more information about accounts. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-account-v1**](#create-account-v1) | **POST** `/accounts/v1` | Create account +[**delete-account-async-v1**](#delete-account-async-v1) | **POST** `/accounts/v1/{id}/remove` | Remove account +[**delete-account-v1**](#delete-account-v1) | **DELETE** `/accounts/v1/{id}` | Delete account +[**disable-account-for-identity-v1**](#disable-account-for-identity-v1) | **POST** `/identities-accounts/v1/{id}/disable` | Disable idn account for identity +[**disable-account-v1**](#disable-account-v1) | **POST** `/accounts/v1/{id}/disable` | Disable account +[**disable-accounts-for-identities-v1**](#disable-accounts-for-identities-v1) | **POST** `/identities-accounts/v1/disable` | Disable idn accounts for identities +[**enable-account-for-identity-v1**](#enable-account-for-identity-v1) | **POST** `/identities-accounts/v1/{id}/enable` | Enable idn account for identity +[**enable-account-v1**](#enable-account-v1) | **POST** `/accounts/v1/{id}/enable` | Enable account +[**enable-accounts-for-identities-v1**](#enable-accounts-for-identities-v1) | **POST** `/identities-accounts/v1/enable` | Enable idn accounts for identities +[**get-account-entitlements-v1**](#get-account-entitlements-v1) | **GET** `/accounts/v1/{id}/entitlements` | Account entitlements +[**get-account-v1**](#get-account-v1) | **GET** `/accounts/v1/{id}` | Account details +[**list-accounts-v1**](#list-accounts-v1) | **GET** `/accounts/v1` | Accounts list +[**put-account-v1**](#put-account-v1) | **PUT** `/accounts/v1/{id}` | Update account +[**submit-reload-account-v1**](#submit-reload-account-v1) | **POST** `/accounts/v1/{id}/reload` | Reload account +[**unlock-account-v1**](#unlock-account-v1) | **POST** `/accounts/v1/{id}/unlock` | Unlock account +[**update-account-v1**](#update-account-v1) | **PATCH** `/accounts/v1/{id}` | Update account + + +## create-account-v1 +Create account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accountattributescreateV1** | **AccountattributescreateV1** | | + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const accountattributescreateV1: AccountattributescreateV1 = ; // +const result = await apiInstance.createAccountV1(accountattributescreateV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-account-async-v1 +Remove account +Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-account-async-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account id | [default to undefined] + +### Return type + +**TaskresultdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = c350d6aa4f104c61b062cb632421ad10; // The account id +const result = await apiInstance.deleteAccountAsyncV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-account-v1 +Delete account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Account ID. | [default to undefined] + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Account ID. +const result = await apiInstance.deleteAccountV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## disable-account-for-identity-v1 +Disable idn account for identity +This API submits a task to disable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/disable-account-for-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = 2c91808384203c2d018437e631158309; // The identity id. +const result = await apiInstance.disableAccountForIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## disable-account-v1 +Disable account +This API submits a task to disable the account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/disable-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account id | [default to undefined] +**accounttogglerequestV1** | **AccounttogglerequestV1** | | + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account id +const accounttogglerequestV1: AccounttogglerequestV1 = ; // +const result = await apiInstance.disableAccountV1(id, accounttogglerequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## disable-accounts-for-identities-v1 +Disable idn accounts for identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/disable-accounts-for-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identitiesaccountsbulkrequestV1** | **IdentitiesaccountsbulkrequestV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 = ; // +const result = await apiInstance.disableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## enable-account-for-identity-v1 +Enable idn account for identity +This API submits a task to enable IDN account for a single identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/enable-account-for-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = 2c91808384203c2d018437e631158309; // The identity id. +const result = await apiInstance.enableAccountForIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## enable-account-v1 +Enable account +This API submits a task to enable account and returns the task ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/enable-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account id | [default to undefined] +**accounttogglerequestV1** | **AccounttogglerequestV1** | | + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account id +const accounttogglerequestV1: AccounttogglerequestV1 = ; // +const result = await apiInstance.enableAccountV1(id, accounttogglerequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## enable-accounts-for-identities-v1 +Enable idn accounts for identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/enable-accounts-for-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identitiesaccountsbulkrequestV1** | **IdentitiesaccountsbulkrequestV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const identitiesaccountsbulkrequestV1: IdentitiesaccountsbulkrequestV1 = ; // +const result = await apiInstance.enableAccountsForIdentitiesV1(identitiesaccountsbulkrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-account-entitlements-v1 +Account entitlements +This API returns entitlements of the account. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account id | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account id +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getAccountEntitlementsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-account-v1 +Account details +Use this API to return the details for a single account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Account ID. | [default to undefined] + +### Return type + +**AccountV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Account ID. +const result = await apiInstance.getAccountV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-accounts-v1 +Accounts list +List accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-accounts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**detailLevel** | **'SLIM' | 'FULL'** | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const detailLevel: string = FULL; // This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) +const filters: string = identityId eq "2c9180858082150f0180893dbaf44201"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) +const sorters: string = id,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +const result = await apiInstance.listAccountsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-account-v1 +Update account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Account ID. | [default to undefined] +**accountattributesV1** | **AccountattributesV1** | | + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Account ID. +const accountattributesV1: AccountattributesV1 = ; // +const result = await apiInstance.putAccountV1(id, accountattributesV1); +console.log(result); +``` + +[[Back to top]](#) + +## submit-reload-account-v1 +Reload account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-reload-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account id | [default to undefined] + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account id +const result = await apiInstance.submitReloadAccountV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## unlock-account-v1 +Unlock account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/unlock-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The account ID. | [default to undefined] +**accountunlockrequestV1** | **AccountunlockrequestV1** | | + +### Return type + +**AccountsasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The account ID. +const accountunlockrequestV1: AccountunlockrequestV1 = ; // +const result = await apiInstance.unlockAccountV1(id, accountunlockrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-account-v1 +Update account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Account ID. | [default to undefined] +**requestBody** | **Array<object>** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Account ID. +const requestBody: Array<object> = [{"op":"remove","path":"/identityId"}]; // A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.updateAccountV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/accounts/docs/Methods/Index.md b/sdk-output/accounts/docs/Methods/Index.md new file mode 100644 index 00000000..b04be2f0 --- /dev/null +++ b/sdk-output/accounts/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: accounts-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: accounts-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'accounts', 'methods'] +slug: /tools/sdk/typescript/accounts/methods +tags: ['SDK', 'Software Development Kit', 'accounts', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/accounts/docs/Models/Accessmodelmetadata.md b/sdk-output/accounts/docs/Models/Accessmodelmetadata.md new file mode 100644 index 00000000..31d3438c --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accessmodelmetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-accessmodelmetadata-v1 +title: AccessmodelmetadataV1 +pagination_label: AccessmodelmetadataV1 +sidebar_label: AccessmodelmetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +slug: /tools/sdk/typescript/accounts/models/accessmodelmetadata-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +--- + +# AccessmodelmetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Unique identifier for the metadata type | [default to undefined] +**name** | **(optional)** **string** | Human readable name of the metadata type | [default to undefined] +**multiselect** | **(optional)** **boolean** | Allows selecting multiple values | [default to false] +**status** | **(optional)** **string** | The state of the metadata item | [default to undefined] +**type** | **(optional)** **string** | The type of the metadata item | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | The types of objects | [default to undefined] +**description** | **(optional)** **string** | Describes the metadata item | [default to undefined] +**values** | **(optional)** **Array<AccessmodelmetadataValuesInnerV1>** | The value to assign to the metadata item | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccessmodelmetadataValuesInner.md b/sdk-output/accounts/docs/Models/AccessmodelmetadataValuesInner.md new file mode 100644 index 00000000..59d09712 --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccessmodelmetadataValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessmodelmetadata-values-inner-v1 +title: AccessmodelmetadataValuesInnerV1 +pagination_label: AccessmodelmetadataValuesInnerV1 +sidebar_label: AccessmodelmetadataValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +slug: /tools/sdk/typescript/accounts/models/accessmodelmetadata-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +--- + +# AccessmodelmetadataValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The value to assign to the metdata item | [default to undefined] +**name** | **(optional)** **string** | Display name of the value | [default to undefined] +**status** | **(optional)** **string** | The status of the individual value | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Account.md b/sdk-output/accounts/docs/Models/Account.md new file mode 100644 index 00000000..c71efbfc --- /dev/null +++ b/sdk-output/accounts/docs/Models/Account.md @@ -0,0 +1,46 @@ +--- +id: v1-account-v1 +title: AccountV1 +pagination_label: AccountV1 +sidebar_label: AccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountV1', 'v1AccountV1'] +slug: /tools/sdk/typescript/accounts/models/account-v1 +tags: ['SDK', 'Software Development Kit', 'AccountV1', 'v1AccountV1'] +--- + +# AccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**sourceId** | **string** | The unique ID of the source this account belongs to | [default to undefined] +**sourceName** | **string** | The display name of the source this account belongs to | [default to undefined] +**identityId** | **(optional)** **string** | The unique ID of the identity this account is correlated to | [default to undefined] +**cloudLifecycleState** | **(optional)** **string** | The lifecycle state of the identity this account is correlated to | [default to undefined] +**identityState** | **(optional)** **string** | The identity state of the identity this account is correlated to | [default to undefined] +**connectionType** | **(optional)** **string** | The connection type of the source this account is from | [default to undefined] +**isMachine** | **(optional)** **boolean** | Indicates if the account is of machine type | [default to false] +**recommendation** | **(optional)** **AccountAllOfRecommendationV1** | | [default to undefined] +**attributes** | | The account attributes that are aggregated | [default to undefined] +**authoritative** | **boolean** | Indicates if this account is from an authoritative source | [default to undefined] +**description** | **(optional)** **string** | A description of the account | [default to undefined] +**disabled** | **boolean** | Indicates if the account is currently disabled | [default to undefined] +**locked** | **boolean** | Indicates if the account is currently locked | [default to undefined] +**nativeIdentity** | **string** | The unique ID of the account generated by the source system | [default to undefined] +**systemAccount** | **boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [default to undefined] +**uncorrelated** | **boolean** | Indicates if this account is not correlated to an identity | [default to undefined] +**uuid** | **(optional)** **string** | The unique ID of the account as determined by the account schema | [default to undefined] +**manuallyCorrelated** | **boolean** | Indicates if the account has been manually correlated to an identity | [default to undefined] +**hasEntitlements** | **boolean** | Indicates if the account has entitlements | [default to undefined] +**identity** | **(optional)** **AccountAllOfIdentityV1** | | [default to undefined] +**sourceOwner** | **(optional)** **AccountAllOfSourceOwnerV1** | | [default to undefined] +**features** | **(optional)** **string** | A string list containing the owning source\'s features | [default to undefined] +**origin** | **(optional)** **string** | The origin of the account either aggregated or provisioned | [default to undefined] +**ownerIdentity** | **(optional)** **AccountAllOfOwnerIdentityV1** | | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccountAllOfIdentity.md b/sdk-output/accounts/docs/Models/AccountAllOfIdentity.md new file mode 100644 index 00000000..94b1018c --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccountAllOfIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-account-all-of-identity-v1 +title: AccountAllOfIdentityV1 +pagination_label: AccountAllOfIdentityV1 +sidebar_label: AccountAllOfIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountAllOfIdentityV1', 'v1AccountAllOfIdentityV1'] +slug: /tools/sdk/typescript/accounts/models/account-all-of-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentityV1', 'v1AccountAllOfIdentityV1'] +--- + +# AccountAllOfIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the identity | [default to undefined] +**type** | **(optional)** **string** | The type of object being referenced | [default to undefined] +**name** | **(optional)** **string** | display name of identity | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccountAllOfOwnerIdentity.md b/sdk-output/accounts/docs/Models/AccountAllOfOwnerIdentity.md new file mode 100644 index 00000000..cf0add19 --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccountAllOfOwnerIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-account-all-of-owner-identity-v1 +title: AccountAllOfOwnerIdentityV1 +pagination_label: AccountAllOfOwnerIdentityV1 +sidebar_label: AccountAllOfOwnerIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountAllOfOwnerIdentityV1', 'v1AccountAllOfOwnerIdentityV1'] +slug: /tools/sdk/typescript/accounts/models/account-all-of-owner-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentityV1', 'v1AccountAllOfOwnerIdentityV1'] +--- + +# AccountAllOfOwnerIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccountAllOfRecommendation.md b/sdk-output/accounts/docs/Models/AccountAllOfRecommendation.md new file mode 100644 index 00000000..86e530d9 --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccountAllOfRecommendation.md @@ -0,0 +1,20 @@ +--- +id: v1-account-all-of-recommendation-v1 +title: AccountAllOfRecommendationV1 +pagination_label: AccountAllOfRecommendationV1 +sidebar_label: AccountAllOfRecommendationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountAllOfRecommendationV1', 'v1AccountAllOfRecommendationV1'] +slug: /tools/sdk/typescript/accounts/models/account-all-of-recommendation-v1 +tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendationV1', 'v1AccountAllOfRecommendationV1'] +--- + +# AccountAllOfRecommendationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Recommended type of account. | [default to undefined] +**method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccountAllOfSourceOwner.md b/sdk-output/accounts/docs/Models/AccountAllOfSourceOwner.md new file mode 100644 index 00000000..66310195 --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccountAllOfSourceOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-account-all-of-source-owner-v1 +title: AccountAllOfSourceOwnerV1 +pagination_label: AccountAllOfSourceOwnerV1 +sidebar_label: AccountAllOfSourceOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountAllOfSourceOwnerV1', 'v1AccountAllOfSourceOwnerV1'] +slug: /tools/sdk/typescript/accounts/models/account-all-of-source-owner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwnerV1', 'v1AccountAllOfSourceOwnerV1'] +--- + +# AccountAllOfSourceOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the identity | [default to undefined] +**type** | **(optional)** **string** | The type of object being referenced | [default to undefined] +**name** | **(optional)** **string** | display name of identity | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Accountattributes.md b/sdk-output/accounts/docs/Models/Accountattributes.md new file mode 100644 index 00000000..30b5080e --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accountattributes.md @@ -0,0 +1,19 @@ +--- +id: v1-accountattributes-v1 +title: AccountattributesV1 +pagination_label: AccountattributesV1 +sidebar_label: AccountattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributesV1', 'v1AccountattributesV1'] +slug: /tools/sdk/typescript/accounts/models/accountattributes-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributesV1', 'v1AccountattributesV1'] +--- + +# AccountattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | | The schema attribute values for the account | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Accountattributescreate.md b/sdk-output/accounts/docs/Models/Accountattributescreate.md new file mode 100644 index 00000000..1611b764 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accountattributescreate.md @@ -0,0 +1,19 @@ +--- +id: v1-accountattributescreate-v1 +title: AccountattributescreateV1 +pagination_label: AccountattributescreateV1 +sidebar_label: AccountattributescreateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributescreateV1', 'v1AccountattributescreateV1'] +slug: /tools/sdk/typescript/accounts/models/accountattributescreate-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributescreateV1', 'v1AccountattributescreateV1'] +--- + +# AccountattributescreateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **AccountattributescreateAttributesV1** | | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/AccountattributescreateAttributes.md b/sdk-output/accounts/docs/Models/AccountattributescreateAttributes.md new file mode 100644 index 00000000..51445550 --- /dev/null +++ b/sdk-output/accounts/docs/Models/AccountattributescreateAttributes.md @@ -0,0 +1,19 @@ +--- +id: v1-accountattributescreate-attributes-v1 +title: AccountattributescreateAttributesV1 +pagination_label: AccountattributescreateAttributesV1 +sidebar_label: AccountattributescreateAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributescreateAttributesV1', 'v1AccountattributescreateAttributesV1'] +slug: /tools/sdk/typescript/accounts/models/accountattributescreate-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributescreateAttributesV1', 'v1AccountattributescreateAttributesV1'] +--- + +# AccountattributescreateAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **string** | Target source to create an account | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Accountsasyncresult.md b/sdk-output/accounts/docs/Models/Accountsasyncresult.md new file mode 100644 index 00000000..fcdaf2ed --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accountsasyncresult.md @@ -0,0 +1,19 @@ +--- +id: v1-accountsasyncresult-v1 +title: AccountsasyncresultV1 +pagination_label: AccountsasyncresultV1 +sidebar_label: AccountsasyncresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsasyncresultV1', 'v1AccountsasyncresultV1'] +slug: /tools/sdk/typescript/accounts/models/accountsasyncresult-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsasyncresultV1', 'v1AccountsasyncresultV1'] +--- + +# AccountsasyncresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | id of the task | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Accounttogglerequest.md b/sdk-output/accounts/docs/Models/Accounttogglerequest.md new file mode 100644 index 00000000..142ed531 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accounttogglerequest.md @@ -0,0 +1,20 @@ +--- +id: v1-accounttogglerequest-v1 +title: AccounttogglerequestV1 +pagination_label: AccounttogglerequestV1 +sidebar_label: AccounttogglerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccounttogglerequestV1', 'v1AccounttogglerequestV1'] +slug: /tools/sdk/typescript/accounts/models/accounttogglerequest-v1 +tags: ['SDK', 'Software Development Kit', 'AccounttogglerequestV1', 'v1AccounttogglerequestV1'] +--- + +# AccounttogglerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**externalVerificationId** | **(optional)** **string** | If set, an external process validates that the user wants to proceed with this request. | [default to undefined] +**forceProvisioning** | **(optional)** **boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. Providing \'true\' for an unlocked account will add and process \'Unlock\' operation by the workflow. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Accountunlockrequest.md b/sdk-output/accounts/docs/Models/Accountunlockrequest.md new file mode 100644 index 00000000..7cfa3051 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Accountunlockrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-accountunlockrequest-v1 +title: AccountunlockrequestV1 +pagination_label: AccountunlockrequestV1 +sidebar_label: AccountunlockrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountunlockrequestV1', 'v1AccountunlockrequestV1'] +slug: /tools/sdk/typescript/accounts/models/accountunlockrequest-v1 +tags: ['SDK', 'Software Development Kit', 'AccountunlockrequestV1', 'v1AccountunlockrequestV1'] +--- + +# AccountunlockrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**externalVerificationId** | **(optional)** **string** | If set, an external process validates that the user wants to proceed with this request. | [default to undefined] +**unlockIDNAccount** | **(optional)** **boolean** | If set, the IDN account is unlocked after the workflow completes. | [default to undefined] +**forceProvisioning** | **(optional)** **boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Additionalownerref.md b/sdk-output/accounts/docs/Models/Additionalownerref.md new file mode 100644 index 00000000..f5cc4fbe --- /dev/null +++ b/sdk-output/accounts/docs/Models/Additionalownerref.md @@ -0,0 +1,21 @@ +--- +id: v1-additionalownerref-v1 +title: AdditionalownerrefV1 +pagination_label: AdditionalownerrefV1 +sidebar_label: AdditionalownerrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +slug: /tools/sdk/typescript/accounts/models/additionalownerref-v1 +tags: ['SDK', 'Software Development Kit', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +--- + +# AdditionalownerrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity or governance group. | [default to undefined] +**name** | **(optional)** **string** | Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Basecommondto.md b/sdk-output/accounts/docs/Models/Basecommondto.md new file mode 100644 index 00000000..ef4c6a2c --- /dev/null +++ b/sdk-output/accounts/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/accounts/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Basereferencedto.md b/sdk-output/accounts/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..5f60186c --- /dev/null +++ b/sdk-output/accounts/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/accounts/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Bulkidentitiesaccountsresponse.md b/sdk-output/accounts/docs/Models/Bulkidentitiesaccountsresponse.md new file mode 100644 index 00000000..b40fbcdb --- /dev/null +++ b/sdk-output/accounts/docs/Models/Bulkidentitiesaccountsresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-bulkidentitiesaccountsresponse-v1 +title: BulkidentitiesaccountsresponseV1 +pagination_label: BulkidentitiesaccountsresponseV1 +sidebar_label: BulkidentitiesaccountsresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkidentitiesaccountsresponseV1', 'v1BulkidentitiesaccountsresponseV1'] +slug: /tools/sdk/typescript/accounts/models/bulkidentitiesaccountsresponse-v1 +tags: ['SDK', 'Software Development Kit', 'BulkidentitiesaccountsresponseV1', 'v1BulkidentitiesaccountsresponseV1'] +--- + +# BulkidentitiesaccountsresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Identifier of bulk request item. | [default to undefined] +**statusCode** | **(optional)** **number** | Response status value. | [default to undefined] +**message** | **(optional)** **string** | Status containing additional context information about failures. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Dtotype.md b/sdk-output/accounts/docs/Models/Dtotype.md new file mode 100644 index 00000000..f92f34bd --- /dev/null +++ b/sdk-output/accounts/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/accounts/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/accounts/docs/Models/Entitlement.md b/sdk-output/accounts/docs/Models/Entitlement.md new file mode 100644 index 00000000..e4ba5bac --- /dev/null +++ b/sdk-output/accounts/docs/Models/Entitlement.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlement-v1 +title: EntitlementV1 +pagination_label: EntitlementV1 +sidebar_label: EntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementV1', 'v1EntitlementV1'] +slug: /tools/sdk/typescript/accounts/models/entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementV1', 'v1EntitlementV1'] +--- + +# EntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | True if the entitlement is privileged | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **EntitlementOwnerV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **EntitlementAccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **EntitlementSourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/EntitlementAccessModelMetadata.md b/sdk-output/accounts/docs/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 00000000..ed8c9d04 --- /dev/null +++ b/sdk-output/accounts/docs/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlement-access-model-metadata-v1 +title: EntitlementAccessModelMetadataV1 +pagination_label: EntitlementAccessModelMetadataV1 +sidebar_label: EntitlementAccessModelMetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +slug: /tools/sdk/typescript/accounts/models/entitlement-access-model-metadata-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +--- + +# EntitlementAccessModelMetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AccessmodelmetadataV1>** | | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/EntitlementOwner.md b/sdk-output/accounts/docs/Models/EntitlementOwner.md new file mode 100644 index 00000000..1674206f --- /dev/null +++ b/sdk-output/accounts/docs/Models/EntitlementOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-owner-v1 +title: EntitlementOwnerV1 +pagination_label: EntitlementOwnerV1 +sidebar_label: EntitlementOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +slug: /tools/sdk/typescript/accounts/models/entitlement-owner-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +--- + +# EntitlementOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | The type of object | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/EntitlementSource.md b/sdk-output/accounts/docs/Models/EntitlementSource.md new file mode 100644 index 00000000..e1e7c650 --- /dev/null +++ b/sdk-output/accounts/docs/Models/EntitlementSource.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-source-v1 +title: EntitlementSourceV1 +pagination_label: EntitlementSourceV1 +sidebar_label: EntitlementSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +slug: /tools/sdk/typescript/accounts/models/entitlement-source-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +--- + +# EntitlementSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Errormessagedto.md b/sdk-output/accounts/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..241a35fe --- /dev/null +++ b/sdk-output/accounts/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/accounts/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Errorresponsedto.md b/sdk-output/accounts/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..8c28e8df --- /dev/null +++ b/sdk-output/accounts/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/accounts/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Identitiesaccountsbulkrequest.md b/sdk-output/accounts/docs/Models/Identitiesaccountsbulkrequest.md new file mode 100644 index 00000000..139783e7 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Identitiesaccountsbulkrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-identitiesaccountsbulkrequest-v1 +title: IdentitiesaccountsbulkrequestV1 +pagination_label: IdentitiesaccountsbulkrequestV1 +sidebar_label: IdentitiesaccountsbulkrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitiesaccountsbulkrequestV1', 'v1IdentitiesaccountsbulkrequestV1'] +slug: /tools/sdk/typescript/accounts/models/identitiesaccountsbulkrequest-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitiesaccountsbulkrequestV1', 'v1IdentitiesaccountsbulkrequestV1'] +--- + +# IdentitiesaccountsbulkrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityIds** | **(optional)** **Array<string>** | The ids of the identities for which enable/disable accounts. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Index.md b/sdk-output/accounts/docs/Models/Index.md new file mode 100644 index 00000000..9ae3b1d3 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: accounts-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: accounts-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'accounts', 'models'] +slug: /tools/sdk/typescript/accounts/models +tags: ['SDK', 'Software Development Kit', 'accounts', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/accounts/docs/Models/ListAccountsV1401Response.md b/sdk-output/accounts/docs/Models/ListAccountsV1401Response.md new file mode 100644 index 00000000..cdc38160 --- /dev/null +++ b/sdk-output/accounts/docs/Models/ListAccountsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-accounts-v1401-response-v1 +title: ListAccountsV1401ResponseV1 +pagination_label: ListAccountsV1401ResponseV1 +sidebar_label: ListAccountsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccountsV1401ResponseV1', 'v1ListAccountsV1401ResponseV1'] +slug: /tools/sdk/typescript/accounts/models/list-accounts-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccountsV1401ResponseV1', 'v1ListAccountsV1401ResponseV1'] +--- + +# ListAccountsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/ListAccountsV1429Response.md b/sdk-output/accounts/docs/Models/ListAccountsV1429Response.md new file mode 100644 index 00000000..841e9c55 --- /dev/null +++ b/sdk-output/accounts/docs/Models/ListAccountsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-accounts-v1429-response-v1 +title: ListAccountsV1429ResponseV1 +pagination_label: ListAccountsV1429ResponseV1 +sidebar_label: ListAccountsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListAccountsV1429ResponseV1', 'v1ListAccountsV1429ResponseV1'] +slug: /tools/sdk/typescript/accounts/models/list-accounts-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListAccountsV1429ResponseV1', 'v1ListAccountsV1429ResponseV1'] +--- + +# ListAccountsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Localeorigin.md b/sdk-output/accounts/docs/Models/Localeorigin.md new file mode 100644 index 00000000..2af6b1e2 --- /dev/null +++ b/sdk-output/accounts/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/accounts/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/accounts/docs/Models/Permissiondto.md b/sdk-output/accounts/docs/Models/Permissiondto.md new file mode 100644 index 00000000..0075441d --- /dev/null +++ b/sdk-output/accounts/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/accounts/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/README.md b/sdk-output/accounts/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/accounts/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/accounts/docs/Models/Recommendation.md b/sdk-output/accounts/docs/Models/Recommendation.md new file mode 100644 index 00000000..9d1babdd --- /dev/null +++ b/sdk-output/accounts/docs/Models/Recommendation.md @@ -0,0 +1,20 @@ +--- +id: v1-recommendation-v1 +title: RecommendationV1 +pagination_label: RecommendationV1 +sidebar_label: RecommendationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationV1', 'v1RecommendationV1'] +slug: /tools/sdk/typescript/accounts/models/recommendation-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationV1', 'v1RecommendationV1'] +--- + +# RecommendationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Recommended type of account. | [default to undefined] +**method** | **string** | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [default to undefined] + diff --git a/sdk-output/accounts/docs/Models/Taskresultdto.md b/sdk-output/accounts/docs/Models/Taskresultdto.md new file mode 100644 index 00000000..dfd2897c --- /dev/null +++ b/sdk-output/accounts/docs/Models/Taskresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taskresultdto-v1 +title: TaskresultdtoV1 +pagination_label: TaskresultdtoV1 +sidebar_label: TaskresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +slug: /tools/sdk/typescript/accounts/models/taskresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +--- + +# TaskresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Task result DTO type. | [default to undefined] +**id** | **(optional)** **string** | Task result ID. | [default to undefined] +**name** | **(optional)** **string** | Task result display name. | [default to undefined] + diff --git a/sdk-output/api_usage/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/api_usage/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e0a797e6 --- /dev/null +++ b/sdk-output/api_usage/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,34 @@ +- path: /api-usage/v1/count + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/api_usage/methods/api-usage#get-total-count-v1 + source: | + import { ApiUsageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApiUsageV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const filters: string = 'method eq "GET", startDate gt "2025-08-01"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional) (default to undefined) + const result = await apiInstance.getTotalCountV1(); + console.log(result); +- path: /api-usage/v1/summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/api_usage/methods/api-usage#list-api-summary-v1 + source: | + import { ApiUsageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApiUsageV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const filters: string = 'method eq "GET", startDate gt "2025-08-01"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional) (default to undefined) + const limit: number = 100; // number | Max number of results to return. (optional) (default to 250) + const offset: number = 10; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) (default to undefined) + const result = await apiInstance.listApiSummaryV1(); + console.log(result); diff --git a/sdk-output/api_usage/docs/Methods/ApiUsageV1Api.md b/sdk-output/api_usage/docs/Methods/ApiUsageV1Api.md new file mode 100644 index 00000000..4111d012 --- /dev/null +++ b/sdk-output/api_usage/docs/Methods/ApiUsageV1Api.md @@ -0,0 +1,113 @@ +--- +id: v1-api-usage +title: ApiUsage +pagination_label: ApiUsage +sidebar_label: ApiUsage +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApiUsage', 'v1ApiUsage'] +slug: /tools/sdk/typescript/api_usage/methods/api-usage +tags: ['SDK', 'Software Development Kit', 'ApiUsage', 'v1ApiUsage'] +--- + +# ApiUsageV1Api + Use this API to retrieve metrics about an org's API usage. +With this functionality in place, administrators can monitor the usage of APIs within a specified timespan, as well as a breakdown of commonly-used APIs sorted by number of requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-total-count-v1**](#get-total-count-v1) | **GET** `/api-usage/v1/count` | Total number of API requests +[**list-api-summary-v1**](#list-api-summary-v1) | **GET** `/api-usage/v1/summary` | Get Api Summary + + +## get-total-count-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Total number of API requests +This API gets an aggregated number of all API calls from an org in a specific timespan. Unless specified, the results are aggregated between the first day of the current month and today. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-total-count-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* | [optional] [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApiUsageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApiUsageV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const filters: string = method eq "GET", startDate gt "2025-08-01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional) +const result = await apiInstance.getTotalCountV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-api-summary-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get Api Summary +This API gets a list of APIs called by the org in a specific timespan, sorted by number of calls. Unless specified, the results are aggregated between the first day of the current month and today. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-api-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApiUsageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApiUsageV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const filters: string = method eq "GET", startDate gt "2025-08-01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **method**: *eq* **startDate**: *gt, eq* **endDate**: *lt, eq* (optional) +const limit: number = 100; // Max number of results to return. (optional) +const offset: number = 10; // Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +const result = await apiInstance.listApiSummaryV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/api_usage/docs/Methods/Index.md b/sdk-output/api_usage/docs/Methods/Index.md new file mode 100644 index 00000000..691c092c --- /dev/null +++ b/sdk-output/api_usage/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: api_usage-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: api_usage-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'api_usage', 'methods'] +slug: /tools/sdk/typescript/api_usage/methods +tags: ['SDK', 'Software Development Kit', 'api_usage', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/api_usage/docs/Models/Errormessagedto.md b/sdk-output/api_usage/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..90dffb4e --- /dev/null +++ b/sdk-output/api_usage/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/api_usage/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/api_usage/docs/Models/Errorresponsedto.md b/sdk-output/api_usage/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cad8a222 --- /dev/null +++ b/sdk-output/api_usage/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/api_usage/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/api_usage/docs/Models/GetTotalCountV1401Response.md b/sdk-output/api_usage/docs/Models/GetTotalCountV1401Response.md new file mode 100644 index 00000000..74729e93 --- /dev/null +++ b/sdk-output/api_usage/docs/Models/GetTotalCountV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-total-count-v1401-response-v1 +title: GetTotalCountV1401ResponseV1 +pagination_label: GetTotalCountV1401ResponseV1 +sidebar_label: GetTotalCountV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTotalCountV1401ResponseV1', 'v1GetTotalCountV1401ResponseV1'] +slug: /tools/sdk/typescript/api_usage/models/get-total-count-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTotalCountV1401ResponseV1', 'v1GetTotalCountV1401ResponseV1'] +--- + +# GetTotalCountV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/api_usage/docs/Models/GetTotalCountV1429Response.md b/sdk-output/api_usage/docs/Models/GetTotalCountV1429Response.md new file mode 100644 index 00000000..f8c7320d --- /dev/null +++ b/sdk-output/api_usage/docs/Models/GetTotalCountV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-total-count-v1429-response-v1 +title: GetTotalCountV1429ResponseV1 +pagination_label: GetTotalCountV1429ResponseV1 +sidebar_label: GetTotalCountV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTotalCountV1429ResponseV1', 'v1GetTotalCountV1429ResponseV1'] +slug: /tools/sdk/typescript/api_usage/models/get-total-count-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTotalCountV1429ResponseV1', 'v1GetTotalCountV1429ResponseV1'] +--- + +# GetTotalCountV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/api_usage/docs/Models/Index.md b/sdk-output/api_usage/docs/Models/Index.md new file mode 100644 index 00000000..ddddebfa --- /dev/null +++ b/sdk-output/api_usage/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: api_usage-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: api_usage-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'api_usage', 'models'] +slug: /tools/sdk/typescript/api_usage/models +tags: ['SDK', 'Software Development Kit', 'api_usage', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/api_usage/docs/Models/Localeorigin.md b/sdk-output/api_usage/docs/Models/Localeorigin.md new file mode 100644 index 00000000..9e2c34e9 --- /dev/null +++ b/sdk-output/api_usage/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/api_usage/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/api_usage/docs/Models/README.md b/sdk-output/api_usage/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/api_usage/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/api_usage/docs/Models/Summaryresponse.md b/sdk-output/api_usage/docs/Models/Summaryresponse.md new file mode 100644 index 00000000..9d15f6d9 --- /dev/null +++ b/sdk-output/api_usage/docs/Models/Summaryresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-summaryresponse-v1 +title: SummaryresponseV1 +pagination_label: SummaryresponseV1 +sidebar_label: SummaryresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SummaryresponseV1', 'v1SummaryresponseV1'] +slug: /tools/sdk/typescript/api_usage/models/summaryresponse-v1 +tags: ['SDK', 'Software Development Kit', 'SummaryresponseV1', 'v1SummaryresponseV1'] +--- + +# SummaryresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedUri** | **(optional)** **string** | The endpoint of a SailPoint API | [default to undefined] +**NumberOfCalls** | **(optional)** **number** | Number of calls made to a specific SailPoint API | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/application_discovery/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d9660d3f --- /dev/null +++ b/sdk-output/application_discovery/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,65 @@ +- path: /discovered-applications/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/application_discovery/methods/application-discovery#get-discovered-applications-v1 + source: | + import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApplicationDiscoveryV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const detail: string = 'FULL'; // 'SLIM' | 'FULL' | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) (default to undefined) + const filter: string = 'name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** (optional) (default to undefined) + const result = await apiInstance.getDiscoveredApplicationsV1(); + console.log(result); +- path: /manual-discover-applications-template/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/application_discovery/methods/application-discovery#get-manual-discover-applications-csv-template-v1 + source: | + import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApplicationDiscoveryV1Api(configuration); + const result = await apiInstance.getManualDiscoverApplicationsCsvTemplateV1(); + console.log(result); +- path: /manual-discover-applications/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/application_discovery/methods/application-discovery#send-manual-discover-applications-csv-template-v1 + source: | + import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApplicationDiscoveryV1Api(configuration); + const file: File = BINARY_DATA_HERE; // File | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. (default to undefined) + const result = await apiInstance.sendManualDiscoverApplicationsCsvTemplateV1(file); + console.log(result); +- path: /sources/v1/{sourceId}/discover-applications + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/application_discovery/methods/application-discovery#start-application-discovery-v1 + source: | + import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApplicationDiscoveryV1Api(configuration); + const sourceId: string = 'sourceId_example'; // string | The sourceId. (default to undefined) + const applicationdiscoveryrequestV1: ApplicationdiscoveryrequestV1 = ; // ApplicationdiscoveryrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.startApplicationDiscoveryV1(sourceId, applicationdiscoveryrequestV1); + console.log(result); diff --git a/sdk-output/application_discovery/docs/Methods/ApplicationDiscoveryV1Api.md b/sdk-output/application_discovery/docs/Methods/ApplicationDiscoveryV1Api.md new file mode 100644 index 00000000..b02b4f0f --- /dev/null +++ b/sdk-output/application_discovery/docs/Methods/ApplicationDiscoveryV1Api.md @@ -0,0 +1,193 @@ +--- +id: v1-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationDiscovery', 'v1ApplicationDiscovery'] +slug: /tools/sdk/typescript/application_discovery/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'v1ApplicationDiscovery'] +--- + +# ApplicationDiscoveryV1Api + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-discovered-applications-v1**](#get-discovered-applications-v1) | **GET** `/discovered-applications/v1` | Get discovered applications for tenant +[**get-manual-discover-applications-csv-template-v1**](#get-manual-discover-applications-csv-template-v1) | **GET** `/manual-discover-applications-template/v1` | Download csv template for discovery +[**send-manual-discover-applications-csv-template-v1**](#send-manual-discover-applications-csv-template-v1) | **POST** `/manual-discover-applications/v1` | Upload csv to discover applications +[**start-application-discovery-v1**](#start-application-discovery-v1) | **POST** `/sources/v1/{sourceId}/discover-applications` | Start Application Discovery + + +## get-discovered-applications-v1 +Get discovered applications for tenant +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-discovered-applications-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**detail** | **'SLIM' | 'FULL'** | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. | [optional] [default to undefined] +**filter** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApplicationDiscoveryV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const detail: string = FULL; // Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) +const filter: string = name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas"); // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* **discoverySourceName**: *eq, in* **discoverySourceCategory**: *eq, in* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource, discoverySourceName, discoverySourceCategory** (optional) +const result = await apiInstance.getDiscoveredApplicationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-manual-discover-applications-csv-template-v1 +Download csv template for discovery +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-manual-discover-applications-csv-template-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**ManualdiscoverapplicationstemplateV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApplicationDiscoveryV1Api(configuration); +const result = await apiInstance.getManualDiscoverApplicationsCsvTemplateV1(); +console.log(result); +``` + +[[Back to top]](#) + +## send-manual-discover-applications-csv-template-v1 +Upload csv to discover applications +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-manual-discover-applications-csv-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**file** | **File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApplicationDiscoveryV1Api(configuration); +const file: File = BINARY_DATA_HERE; // The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. +const result = await apiInstance.sendManualDiscoverApplicationsCsvTemplateV1(file); +console.log(result); +``` + +[[Back to top]](#) + +## start-application-discovery-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Start Application Discovery +Use this API to discover applications. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-application-discovery-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The sourceId. | [default to undefined] +**applicationdiscoveryrequestV1** | **ApplicationdiscoveryrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ApplicationdiscoveryresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApplicationDiscoveryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApplicationDiscoveryV1Api(configuration); +const sourceId: string = sourceId_example; // The sourceId. +const applicationdiscoveryrequestV1: ApplicationdiscoveryrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.startApplicationDiscoveryV1(sourceId, applicationdiscoveryrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/application_discovery/docs/Methods/Index.md b/sdk-output/application_discovery/docs/Methods/Index.md new file mode 100644 index 00000000..e0baf213 --- /dev/null +++ b/sdk-output/application_discovery/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: application_discovery-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: application_discovery-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'application_discovery', 'methods'] +slug: /tools/sdk/typescript/application_discovery/methods +tags: ['SDK', 'Software Development Kit', 'application_discovery', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/application_discovery/docs/Models/Applicationdiscoveryrequest.md b/sdk-output/application_discovery/docs/Models/Applicationdiscoveryrequest.md new file mode 100644 index 00000000..45d54852 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Applicationdiscoveryrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-applicationdiscoveryrequest-v1 +title: ApplicationdiscoveryrequestV1 +pagination_label: ApplicationdiscoveryrequestV1 +sidebar_label: ApplicationdiscoveryrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationdiscoveryrequestV1', 'v1ApplicationdiscoveryrequestV1'] +slug: /tools/sdk/typescript/application_discovery/models/applicationdiscoveryrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationdiscoveryrequestV1', 'v1ApplicationdiscoveryrequestV1'] +--- + +# ApplicationdiscoveryrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**datasetIds** | **Array<string>** | List of dataset Ids to discover applications | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Applicationdiscoveryresponse.md b/sdk-output/application_discovery/docs/Models/Applicationdiscoveryresponse.md new file mode 100644 index 00000000..53635066 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Applicationdiscoveryresponse.md @@ -0,0 +1,36 @@ +--- +id: v1-applicationdiscoveryresponse-v1 +title: ApplicationdiscoveryresponseV1 +pagination_label: ApplicationdiscoveryresponseV1 +sidebar_label: ApplicationdiscoveryresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationdiscoveryresponseV1', 'v1ApplicationdiscoveryresponseV1'] +slug: /tools/sdk/typescript/application_discovery/models/applicationdiscoveryresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationdiscoveryresponseV1', 'v1ApplicationdiscoveryresponseV1'] +--- + +# ApplicationdiscoveryresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [default to undefined] +**type** | **(optional)** **string** | Type of task for app discovery | [default to undefined] +**uniqueName** | **(optional)** **string** | Name of the task for app discovery | [default to undefined] +**description** | **(optional)** **string** | Description of the app discovery aggregation | [default to undefined] +**parentName** | **(optional)** **string** | Name of the parent of the task for app discovery | [default to undefined] +**launcher** | **(optional)** **string** | Service to execute app discovery | [default to undefined] +**target** | **(optional)** **ApplicationdiscoveryresponseTargetV1** | | [default to undefined] +**created** | **(optional)** **string** | Creation date of app discovery task | [default to undefined] +**modified** | **(optional)** **string** | Last modification date of app discovery task | [default to undefined] +**launched** | **(optional)** **string** | Launch date of app discovery task | [default to undefined] +**completed** | **(optional)** **string** | Completion date of app discovery task | [default to undefined] +**taskDefinitionSummary** | **(optional)** **TaskdefinitionsummaryV1** | | [default to undefined] +**completionStatus** | **(optional)** **string** | Completion status of app discovery task | [default to undefined] +**messages** | **(optional)** **Array<TaskstatusmessageV1>** | Messages associated with the app discovery task | [default to undefined] +**returns** | **(optional)** **Array<TaskreturndetailsV1>** | Return values associated with the app discovery task | [default to undefined] +**attributes** | **(optional)** | Attributes of the app discovery task | [default to undefined] +**progress** | **(optional)** **string** | Current progress of aggregation | [default to undefined] +**percentComplete** | **(optional)** **number** | Current percentage completion of app discovery task | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/ApplicationdiscoveryresponseTarget.md b/sdk-output/application_discovery/docs/Models/ApplicationdiscoveryresponseTarget.md new file mode 100644 index 00000000..fc2eb919 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/ApplicationdiscoveryresponseTarget.md @@ -0,0 +1,21 @@ +--- +id: v1-applicationdiscoveryresponse-target-v1 +title: ApplicationdiscoveryresponseTargetV1 +pagination_label: ApplicationdiscoveryresponseTargetV1 +sidebar_label: ApplicationdiscoveryresponseTargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationdiscoveryresponseTargetV1', 'v1ApplicationdiscoveryresponseTargetV1'] +slug: /tools/sdk/typescript/application_discovery/models/applicationdiscoveryresponse-target-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationdiscoveryresponseTargetV1', 'v1ApplicationdiscoveryresponseTargetV1'] +--- + +# ApplicationdiscoveryresponseTargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Basereferencedto.md b/sdk-output/application_discovery/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..368ecd05 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/application_discovery/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Dtotype.md b/sdk-output/application_discovery/docs/Models/Dtotype.md new file mode 100644 index 00000000..e0b7a011 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/application_discovery/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/application_discovery/docs/Models/Errormessagedto.md b/sdk-output/application_discovery/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..45548514 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/application_discovery/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Errorresponsedto.md b/sdk-output/application_discovery/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..ba70d14e --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/application_discovery/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Fulldiscoveredapplications.md b/sdk-output/application_discovery/docs/Models/Fulldiscoveredapplications.md new file mode 100644 index 00000000..d048ce70 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Fulldiscoveredapplications.md @@ -0,0 +1,50 @@ +--- +id: v1-fulldiscoveredapplications-v1 +title: FulldiscoveredapplicationsV1 +pagination_label: FulldiscoveredapplicationsV1 +sidebar_label: FulldiscoveredapplicationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FulldiscoveredapplicationsV1', 'v1FulldiscoveredapplicationsV1'] +slug: /tools/sdk/typescript/application_discovery/models/fulldiscoveredapplications-v1 +tags: ['SDK', 'Software Development Kit', 'FulldiscoveredapplicationsV1', 'v1FulldiscoveredapplicationsV1'] +--- + +# FulldiscoveredapplicationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the discovered application. | [default to undefined] +**name** | **(optional)** **string** | Name of the discovered application. | [default to undefined] +**discoverySource** | **(optional)** **string** | Source from which the application was discovered. | [default to undefined] +**discoveredVendor** | **(optional)** **string** | The vendor associated with the discovered application. | [default to undefined] +**description** | **(optional)** **string** | A brief description of the discovered application. | [default to undefined] +**recommendedConnectors** | **(optional)** **Array<string>** | List of recommended connectors for the application. | [default to undefined] +**discoveredAt** | **(optional)** **string** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [default to undefined] +**createdAt** | **(optional)** **string** | The timestamp when the application was first discovered, in ISO 8601 format. | [default to undefined] +**status** | **(optional)** **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [default to undefined] +**associatedSources** | **(optional)** **Array<string>** | List of associated sources related to this discovered application. | [default to undefined] +**operationalStatus** | **(optional)** **string** | The operational status of the application. | [default to undefined] +**discoverySourceCategory** | **(optional)** **string** | The category of the discovery source. | [default to undefined] +**licenseCount** | **(optional)** **number** | The number of licenses associated with the application. | [default to undefined] +**isSanctioned** | **(optional)** **boolean** | Indicates whether the application is sanctioned. | [default to false] +**logo** | **(optional)** **string** | URL of the application\'s logo. | [default to undefined] +**appUrl** | **(optional)** **string** | The URL of the application. | [default to undefined] +**groups** | **(optional)** **Array<object>** | List of groups associated with the application. | [default to undefined] +**usersCount** | **(optional)** **string** | The count of users associated with the application. | [default to undefined] +**applicationOwner** | **(optional)** **Array<string>** | The owners of the application. | [default to undefined] +**itApplicationOwner** | **(optional)** **Array<string>** | The IT owners of the application. | [default to undefined] +**businessCriticality** | **(optional)** **string** | The business criticality level of the application. | [default to undefined] +**dataClassification** | **(optional)** **string** | The data classification level of the application. | [default to undefined] +**businessUnit** | **(optional)** **string** | The business unit associated with the application. | [default to undefined] +**installType** | **(optional)** **string** | The installation type of the application. | [default to undefined] +**environment** | **(optional)** **string** | The environment in which the application operates. | [default to undefined] +**riskScore** | **(optional)** **number** | The risk score of the application ranging from 0-100, 100 being highest risk. | [default to undefined] +**isBusiness** | **(optional)** **boolean** | Indicates whether the application is used for business purposes. | [default to true] +**totalSigninsCount** | **(optional)** **number** | The total number of sign-in accounts for the application. | [default to undefined] +**riskLevel** | **(optional)** **string** | The risk level of the application. | [default to undefined] +**isPrivileged** | **(optional)** **boolean** | Indicates whether the application has privileged access. | [default to false] +**warrantyExpiration** | **(optional)** **string** | The warranty expiration date of the application. | [default to undefined] +**attributes** | **(optional)** **object** | Additional attributes of the application useful for visibility of governance posture. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/GetDiscoveredApplicationsV1200ResponseInner.md b/sdk-output/application_discovery/docs/Models/GetDiscoveredApplicationsV1200ResponseInner.md new file mode 100644 index 00000000..c0be5159 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/GetDiscoveredApplicationsV1200ResponseInner.md @@ -0,0 +1,50 @@ +--- +id: v1-get-discovered-applications-v1200-response-inner-v1 +title: GetDiscoveredApplicationsV1200ResponseInnerV1 +pagination_label: GetDiscoveredApplicationsV1200ResponseInnerV1 +sidebar_label: GetDiscoveredApplicationsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetDiscoveredApplicationsV1200ResponseInnerV1', 'v1GetDiscoveredApplicationsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/application_discovery/models/get-discovered-applications-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplicationsV1200ResponseInnerV1', 'v1GetDiscoveredApplicationsV1200ResponseInnerV1'] +--- + +# GetDiscoveredApplicationsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the discovered application. | [default to undefined] +**name** | **(optional)** **string** | Name of the discovered application. | [default to undefined] +**discoverySource** | **(optional)** **string** | Source from which the application was discovered. | [default to undefined] +**discoveredVendor** | **(optional)** **string** | The vendor associated with the discovered application. | [default to undefined] +**description** | **(optional)** **string** | A brief description of the discovered application. | [default to undefined] +**recommendedConnectors** | **(optional)** **Array<string>** | List of recommended connectors for the application. | [default to undefined] +**discoveredAt** | **(optional)** **string** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [default to undefined] +**createdAt** | **(optional)** **string** | The timestamp when the application was first discovered, in ISO 8601 format. | [default to undefined] +**status** | **(optional)** **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [default to undefined] +**operationalStatus** | **(optional)** **string** | The operational status of the application. | [default to undefined] +**discoverySourceCategory** | **(optional)** **string** | The category of the discovery source. | [default to undefined] +**licenseCount** | **(optional)** **number** | The number of licenses associated with the application. | [default to undefined] +**isSanctioned** | **(optional)** **boolean** | Indicates whether the application is sanctioned. | [default to false] +**logo** | **(optional)** **string** | URL of the application\'s logo. | [default to undefined] +**appUrl** | **(optional)** **string** | The URL of the application. | [default to undefined] +**groups** | **(optional)** **Array<object>** | List of groups associated with the application. | [default to undefined] +**usersCount** | **(optional)** **string** | The count of users associated with the application. | [default to undefined] +**applicationOwner** | **(optional)** **Array<string>** | The owners of the application. | [default to undefined] +**itApplicationOwner** | **(optional)** **Array<string>** | The IT owners of the application. | [default to undefined] +**businessCriticality** | **(optional)** **string** | The business criticality level of the application. | [default to undefined] +**dataClassification** | **(optional)** **string** | The data classification level of the application. | [default to undefined] +**businessUnit** | **(optional)** **string** | The business unit associated with the application. | [default to undefined] +**installType** | **(optional)** **string** | The installation type of the application. | [default to undefined] +**environment** | **(optional)** **string** | The environment in which the application operates. | [default to undefined] +**riskScore** | **(optional)** **number** | The risk score of the application ranging from 0-100, 100 being highest risk. | [default to undefined] +**isBusiness** | **(optional)** **boolean** | Indicates whether the application is used for business purposes. | [default to true] +**totalSigninsCount** | **(optional)** **number** | The total number of sign-in accounts for the application. | [default to undefined] +**riskLevel** | **(optional)** **string** | The risk level of the application. | [default to undefined] +**isPrivileged** | **(optional)** **boolean** | Indicates whether the application has privileged access. | [default to false] +**warrantyExpiration** | **(optional)** **string** | The warranty expiration date of the application. | [default to undefined] +**attributes** | **(optional)** **object** | Additional attributes of the application useful for visibility of governance posture. | [default to undefined] +**associatedSources** | **(optional)** **Array<string>** | List of associated sources related to this discovered application. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Index.md b/sdk-output/application_discovery/docs/Models/Index.md new file mode 100644 index 00000000..2f45fcd8 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: application_discovery-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: application_discovery-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'application_discovery', 'models'] +slug: /tools/sdk/typescript/application_discovery/models +tags: ['SDK', 'Software Development Kit', 'application_discovery', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/application_discovery/docs/Models/Localeorigin.md b/sdk-output/application_discovery/docs/Models/Localeorigin.md new file mode 100644 index 00000000..ed36d220 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/application_discovery/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/application_discovery/docs/Models/Localizedmessage.md b/sdk-output/application_discovery/docs/Models/Localizedmessage.md new file mode 100644 index 00000000..7442b887 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Localizedmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-localizedmessage-v1 +title: LocalizedmessageV1 +pagination_label: LocalizedmessageV1 +sidebar_label: LocalizedmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +slug: /tools/sdk/typescript/application_discovery/models/localizedmessage-v1 +tags: ['SDK', 'Software Development Kit', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +--- + +# LocalizedmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **string** | Message locale | [default to undefined] +**message** | **string** | Message text | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Manualdiscoverapplications.md b/sdk-output/application_discovery/docs/Models/Manualdiscoverapplications.md new file mode 100644 index 00000000..681a73fc --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Manualdiscoverapplications.md @@ -0,0 +1,19 @@ +--- +id: v1-manualdiscoverapplications-v1 +title: ManualdiscoverapplicationsV1 +pagination_label: ManualdiscoverapplicationsV1 +sidebar_label: ManualdiscoverapplicationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualdiscoverapplicationsV1', 'v1ManualdiscoverapplicationsV1'] +slug: /tools/sdk/typescript/application_discovery/models/manualdiscoverapplications-v1 +tags: ['SDK', 'Software Development Kit', 'ManualdiscoverapplicationsV1', 'v1ManualdiscoverapplicationsV1'] +--- + +# ManualdiscoverapplicationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **File** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Manualdiscoverapplicationstemplate.md b/sdk-output/application_discovery/docs/Models/Manualdiscoverapplicationstemplate.md new file mode 100644 index 00000000..c4add9a7 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Manualdiscoverapplicationstemplate.md @@ -0,0 +1,20 @@ +--- +id: v1-manualdiscoverapplicationstemplate-v1 +title: ManualdiscoverapplicationstemplateV1 +pagination_label: ManualdiscoverapplicationstemplateV1 +sidebar_label: ManualdiscoverapplicationstemplateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManualdiscoverapplicationstemplateV1', 'v1ManualdiscoverapplicationstemplateV1'] +slug: /tools/sdk/typescript/application_discovery/models/manualdiscoverapplicationstemplate-v1 +tags: ['SDK', 'Software Development Kit', 'ManualdiscoverapplicationstemplateV1', 'v1ManualdiscoverapplicationstemplateV1'] +--- + +# ManualdiscoverapplicationstemplateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_name** | **(optional)** **string** | Name of the application. | [default to undefined] +**description** | **(optional)** **string** | Description of the application. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/README.md b/sdk-output/application_discovery/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/application_discovery/docs/Models/Slimdiscoveredapplications.md b/sdk-output/application_discovery/docs/Models/Slimdiscoveredapplications.md new file mode 100644 index 00000000..5d4ba27b --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Slimdiscoveredapplications.md @@ -0,0 +1,49 @@ +--- +id: v1-slimdiscoveredapplications-v1 +title: SlimdiscoveredapplicationsV1 +pagination_label: SlimdiscoveredapplicationsV1 +sidebar_label: SlimdiscoveredapplicationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SlimdiscoveredapplicationsV1', 'v1SlimdiscoveredapplicationsV1'] +slug: /tools/sdk/typescript/application_discovery/models/slimdiscoveredapplications-v1 +tags: ['SDK', 'Software Development Kit', 'SlimdiscoveredapplicationsV1', 'v1SlimdiscoveredapplicationsV1'] +--- + +# SlimdiscoveredapplicationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the discovered application. | [default to undefined] +**name** | **(optional)** **string** | Name of the discovered application. | [default to undefined] +**discoverySource** | **(optional)** **string** | Source from which the application was discovered. | [default to undefined] +**discoveredVendor** | **(optional)** **string** | The vendor associated with the discovered application. | [default to undefined] +**description** | **(optional)** **string** | A brief description of the discovered application. | [default to undefined] +**recommendedConnectors** | **(optional)** **Array<string>** | List of recommended connectors for the application. | [default to undefined] +**discoveredAt** | **(optional)** **string** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [default to undefined] +**createdAt** | **(optional)** **string** | The timestamp when the application was first discovered, in ISO 8601 format. | [default to undefined] +**status** | **(optional)** **string** | The status of an application within the discovery source. By default this field is set to \"ACTIVE\" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to \"INACTIVE\". | [default to undefined] +**operationalStatus** | **(optional)** **string** | The operational status of the application. | [default to undefined] +**discoverySourceCategory** | **(optional)** **string** | The category of the discovery source. | [default to undefined] +**licenseCount** | **(optional)** **number** | The number of licenses associated with the application. | [default to undefined] +**isSanctioned** | **(optional)** **boolean** | Indicates whether the application is sanctioned. | [default to false] +**logo** | **(optional)** **string** | URL of the application\'s logo. | [default to undefined] +**appUrl** | **(optional)** **string** | The URL of the application. | [default to undefined] +**groups** | **(optional)** **Array<object>** | List of groups associated with the application. | [default to undefined] +**usersCount** | **(optional)** **string** | The count of users associated with the application. | [default to undefined] +**applicationOwner** | **(optional)** **Array<string>** | The owners of the application. | [default to undefined] +**itApplicationOwner** | **(optional)** **Array<string>** | The IT owners of the application. | [default to undefined] +**businessCriticality** | **(optional)** **string** | The business criticality level of the application. | [default to undefined] +**dataClassification** | **(optional)** **string** | The data classification level of the application. | [default to undefined] +**businessUnit** | **(optional)** **string** | The business unit associated with the application. | [default to undefined] +**installType** | **(optional)** **string** | The installation type of the application. | [default to undefined] +**environment** | **(optional)** **string** | The environment in which the application operates. | [default to undefined] +**riskScore** | **(optional)** **number** | The risk score of the application ranging from 0-100, 100 being highest risk. | [default to undefined] +**isBusiness** | **(optional)** **boolean** | Indicates whether the application is used for business purposes. | [default to true] +**totalSigninsCount** | **(optional)** **number** | The total number of sign-in accounts for the application. | [default to undefined] +**riskLevel** | **(optional)** **string** | The risk level of the application. | [default to undefined] +**isPrivileged** | **(optional)** **boolean** | Indicates whether the application has privileged access. | [default to false] +**warrantyExpiration** | **(optional)** **string** | The warranty expiration date of the application. | [default to undefined] +**attributes** | **(optional)** **object** | Additional attributes of the application useful for visibility of governance posture. | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1401Response.md b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1401Response.md new file mode 100644 index 00000000..cfd7653c --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-application-discovery-v1401-response-v1 +title: StartApplicationDiscoveryV1401ResponseV1 +pagination_label: StartApplicationDiscoveryV1401ResponseV1 +sidebar_label: StartApplicationDiscoveryV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartApplicationDiscoveryV1401ResponseV1', 'v1StartApplicationDiscoveryV1401ResponseV1'] +slug: /tools/sdk/typescript/application_discovery/models/start-application-discovery-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartApplicationDiscoveryV1401ResponseV1', 'v1StartApplicationDiscoveryV1401ResponseV1'] +--- + +# StartApplicationDiscoveryV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403Response.md b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403Response.md new file mode 100644 index 00000000..51a66344 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403Response.md @@ -0,0 +1,23 @@ +--- +id: v1-start-application-discovery-v1403-response-v1 +title: StartApplicationDiscoveryV1403ResponseV1 +pagination_label: StartApplicationDiscoveryV1403ResponseV1 +sidebar_label: StartApplicationDiscoveryV1403ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartApplicationDiscoveryV1403ResponseV1', 'v1StartApplicationDiscoveryV1403ResponseV1'] +slug: /tools/sdk/typescript/application_discovery/models/start-application-discovery-v1403-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartApplicationDiscoveryV1403ResponseV1', 'v1StartApplicationDiscoveryV1403ResponseV1'] +--- + +# StartApplicationDiscoveryV1403ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] +**error** | **string** | Error message when quota is exceeded | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403ResponseOneOf.md b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403ResponseOneOf.md new file mode 100644 index 00000000..05e0935b --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1403ResponseOneOf.md @@ -0,0 +1,19 @@ +--- +id: v1-start-application-discovery-v1403-response-one-of-v1 +title: StartApplicationDiscoveryV1403ResponseOneOfV1 +pagination_label: StartApplicationDiscoveryV1403ResponseOneOfV1 +sidebar_label: StartApplicationDiscoveryV1403ResponseOneOfV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartApplicationDiscoveryV1403ResponseOneOfV1', 'v1StartApplicationDiscoveryV1403ResponseOneOfV1'] +slug: /tools/sdk/typescript/application_discovery/models/start-application-discovery-v1403-response-one-of-v1 +tags: ['SDK', 'Software Development Kit', 'StartApplicationDiscoveryV1403ResponseOneOfV1', 'v1StartApplicationDiscoveryV1403ResponseOneOfV1'] +--- + +# StartApplicationDiscoveryV1403ResponseOneOfV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **string** | Error message when quota is exceeded | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1429Response.md b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1429Response.md new file mode 100644 index 00000000..8da81332 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/StartApplicationDiscoveryV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-application-discovery-v1429-response-v1 +title: StartApplicationDiscoveryV1429ResponseV1 +pagination_label: StartApplicationDiscoveryV1429ResponseV1 +sidebar_label: StartApplicationDiscoveryV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartApplicationDiscoveryV1429ResponseV1', 'v1StartApplicationDiscoveryV1429ResponseV1'] +slug: /tools/sdk/typescript/application_discovery/models/start-application-discovery-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartApplicationDiscoveryV1429ResponseV1', 'v1StartApplicationDiscoveryV1429ResponseV1'] +--- + +# StartApplicationDiscoveryV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Taskdefinitionsummary.md b/sdk-output/application_discovery/docs/Models/Taskdefinitionsummary.md new file mode 100644 index 00000000..a3d29b5b --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Taskdefinitionsummary.md @@ -0,0 +1,24 @@ +--- +id: v1-taskdefinitionsummary-v1 +title: TaskdefinitionsummaryV1 +pagination_label: TaskdefinitionsummaryV1 +sidebar_label: TaskdefinitionsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +slug: /tools/sdk/typescript/application_discovery/models/taskdefinitionsummary-v1 +tags: ['SDK', 'Software Development Kit', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +--- + +# TaskdefinitionsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the TaskDefinition | [default to undefined] +**uniqueName** | **string** | Name of the TaskDefinition | [default to undefined] +**description** | **string** | Description of the TaskDefinition | [default to undefined] +**parentName** | **string** | Name of the parent of the TaskDefinition | [default to undefined] +**executor** | **string** | Executor of the TaskDefinition | [default to undefined] +**arguments** | | Formal parameters of the TaskDefinition, without values | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Taskreturndetails.md b/sdk-output/application_discovery/docs/Models/Taskreturndetails.md new file mode 100644 index 00000000..4e5ecfc8 --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Taskreturndetails.md @@ -0,0 +1,20 @@ +--- +id: v1-taskreturndetails-v1 +title: TaskreturndetailsV1 +pagination_label: TaskreturndetailsV1 +sidebar_label: TaskreturndetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +slug: /tools/sdk/typescript/application_discovery/models/taskreturndetails-v1 +tags: ['SDK', 'Software Development Kit', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +--- + +# TaskreturndetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Display name of the TaskReturnDetails | [default to undefined] +**attributeName** | **string** | Attribute the TaskReturnDetails is for | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/Taskstatusmessage.md b/sdk-output/application_discovery/docs/Models/Taskstatusmessage.md new file mode 100644 index 00000000..86d9643f --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/Taskstatusmessage.md @@ -0,0 +1,22 @@ +--- +id: v1-taskstatusmessage-v1 +title: TaskstatusmessageV1 +pagination_label: TaskstatusmessageV1 +sidebar_label: TaskstatusmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +slug: /tools/sdk/typescript/application_discovery/models/taskstatusmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +--- + +# TaskstatusmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of the message | [default to undefined] +**localizedText** | **LocalizedmessageV1** | | [default to undefined] +**key** | **string** | Key of the message | [default to undefined] +**parameters** | **Array<TaskstatusmessageParametersInnerV1>** | Message parameters for internationalization | [default to undefined] + diff --git a/sdk-output/application_discovery/docs/Models/TaskstatusmessageParametersInner.md b/sdk-output/application_discovery/docs/Models/TaskstatusmessageParametersInner.md new file mode 100644 index 00000000..423fe60f --- /dev/null +++ b/sdk-output/application_discovery/docs/Models/TaskstatusmessageParametersInner.md @@ -0,0 +1,18 @@ +--- +id: v1-taskstatusmessage-parameters-inner-v1 +title: TaskstatusmessageParametersInnerV1 +pagination_label: TaskstatusmessageParametersInnerV1 +sidebar_label: TaskstatusmessageParametersInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +slug: /tools/sdk/typescript/application_discovery/models/taskstatusmessage-parameters-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +--- + +# TaskstatusmessageParametersInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/approvals/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/approvals/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..c88b85aa --- /dev/null +++ b/sdk-output/approvals/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,246 @@ +- path: /generic-approvals/v1/bulk-approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#approve-approval-in-bulk-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const bulkapproverequestdtoV1: BulkapproverequestdtoV1 = ; // BulkapproverequestdtoV1 | + const result = await apiInstance.approveApprovalInBulkV1(bulkapproverequestdtoV1); + console.log(result); +- path: /generic-approvals/v1/{id}/approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#approve-approval-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | Approval ID that correlates to an existing approval request that a user wants to approve. (default to undefined) + const approvalapproverequestV1: ApprovalapproverequestV1 = ; // ApprovalapproverequestV1 | (optional) + const result = await apiInstance.approveApprovalV1(id); + console.log(result); +- path: /generic-approvals/v1/{id}/cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#cancel-approval-by-id-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | ID of the approval request to cancel. (default to undefined) + const approvalcancelrequestV1: ApprovalcancelrequestV1 = ; // ApprovalcancelrequestV1 | (optional) + const result = await apiInstance.cancelApprovalByIdV1(id); + console.log(result); +- path: /generic-approvals/v1/bulk-cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#cancel-approval-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const bulkcancelrequestdtoV1: BulkcancelrequestdtoV1 = ; // BulkcancelrequestdtoV1 | + const result = await apiInstance.cancelApprovalV1(bulkcancelrequestdtoV1); + console.log(result); +- path: /generic-approvals/v1/config/{id}/{scope} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#delete-approval-config-request-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = 'ACCESS_REQUEST_APPROVAL'; // string | The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT (default to undefined) + const scope: string = 'APPROVAL_TYPE'; // 'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT' | The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT (default to undefined) + const result = await apiInstance.deleteApprovalConfigRequestV1(id, scope); + console.log(result); +- path: /generic-approvals/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#get-approval-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | ID of the approval that is to be returned (default to undefined) + const result = await apiInstance.getApprovalV1(id); + console.log(result); +- path: /generic-approvals/v1/config/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#get-approvals-config-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '1.2345678901234567E+31'; // string | The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] (default to undefined) + const result = await apiInstance.getApprovalsConfigV1(id); + console.log(result); +- path: /generic-approvals/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#get-approvals-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const mine: boolean = true; // boolean | Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). (optional) (default to false) + const requesterId: string = '17e633e7d57e481569df76323169deb6a'; // string | Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. (optional) (default to undefined) + const requesteeId: string = '27e6334g757e481569df76323169db9sc'; // string | Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. (optional) (default to undefined) + const approverId: string = '37e6334g557e481569df7g2d3169db9sb'; // string | Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. (optional) (default to undefined) + const count: boolean = true; // boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) (default to false) + const countOnly: boolean = true; // boolean | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) (default to false) + const includeComments: boolean = true; // boolean | If set to true in the query, the approval requests returned will include comments. (optional) (default to false) + const includeApprovers: boolean = true; // boolean | If set to true in the query, the approval requests returned will include approvers. (optional) (default to false) + const includeReassignmentHistory: boolean = true; // boolean | If set to true in the query, the approval requests returned will include reassignment history. (optional) (default to false) + const includeBatchInfo: boolean = true; // boolean | If set to true in the query, the approval requests returned will include batch information. (optional) (default to false) + const filters: string = 'filters=status eq "PENDING" and type eq "ACCESS_REQUEST_APPROVAL"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.getApprovalsV1(); + console.log(result); +- path: /generic-approvals/v1/bulk-reassign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#move-approval-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const bulkreassignrequestdtoV1: BulkreassignrequestdtoV1 = ; // BulkreassignrequestdtoV1 | + const result = await apiInstance.moveApprovalV1(bulkreassignrequestdtoV1); + console.log(result); +- path: /generic-approvals/v1/config/{id}/{scope} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#put-approvals-config-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = 'ACCESS_REQUEST_APPROVAL'; // string | The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT (default to undefined) + const scope: string = 'APPROVAL_TYPE'; // 'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT' | The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT (default to undefined) + const approvalconfigV1: ApprovalconfigV1 = ; // ApprovalconfigV1 | + const result = await apiInstance.putApprovalsConfigV1(id, scope, approvalconfigV1); + console.log(result); +- path: /generic-approvals/v1/bulk-reject + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#reject-approval-in-bulk-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const bulkrejectrequestdtoV1: BulkrejectrequestdtoV1 = ; // BulkrejectrequestdtoV1 | + const result = await apiInstance.rejectApprovalInBulkV1(bulkrejectrequestdtoV1); + console.log(result); +- path: /generic-approvals/v1/{id}/reject + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#reject-approval-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | Approval ID that correlates to an existing approval request that a user wants to reject. (default to undefined) + const approvalrejectrequestV1: ApprovalrejectrequestV1 = ; // ApprovalrejectrequestV1 | (optional) + const result = await apiInstance.rejectApprovalV1(id); + console.log(result); +- path: /generic-approvals/v1/{id}/attributes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#update-approvals-attributes-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | Approval ID that correlates to an existing approval request that a user wants to change the attributes of. (default to undefined) + const approvalattributesrequestV1: ApprovalattributesrequestV1 = ; // ApprovalattributesrequestV1 | + const result = await apiInstance.updateApprovalsAttributesV1(id, approvalattributesrequestV1); + console.log(result); +- path: /generic-approvals/v1/{id}/comments + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#update-approvals-comments-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | Approval ID that correlates to an existing approval request that a user wants to add a comment to. (default to undefined) + const approvalcommentsrequestV1: ApprovalcommentsrequestV1 = ; // ApprovalcommentsrequestV1 | + const result = await apiInstance.updateApprovalsCommentsV1(id, approvalcommentsrequestV1); + console.log(result); +- path: /generic-approvals/v1/{id}/reassign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/approvals/methods/approvals#update-approvals-reassign-v1 + source: | + import { ApprovalsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ApprovalsV1Api(configuration); + const id: string = '38453251-6be2-5f8f-df93-5ce19e295837'; // string | Approval ID that correlates to an existing approval request that a user wants to reassign. (default to undefined) + const approvalreassignrequestV1: ApprovalreassignrequestV1 = ; // ApprovalreassignrequestV1 | + const result = await apiInstance.updateApprovalsReassignV1(id, approvalreassignrequestV1); + console.log(result); diff --git a/sdk-output/approvals/docs/Methods/ApprovalsV1Api.md b/sdk-output/approvals/docs/Methods/ApprovalsV1Api.md new file mode 100644 index 00000000..dd9f47d9 --- /dev/null +++ b/sdk-output/approvals/docs/Methods/ApprovalsV1Api.md @@ -0,0 +1,667 @@ +--- +id: v1-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approvals', 'v1Approvals'] +slug: /tools/sdk/typescript/approvals/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'v1Approvals'] +--- + +# ApprovalsV1Api + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/v2025/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-in-bulk-v1**](#approve-approval-in-bulk-v1) | **POST** `/generic-approvals/v1/bulk-approve` | Post Bulk Approve Approvals +[**approve-approval-v1**](#approve-approval-v1) | **POST** `/generic-approvals/v1/{id}/approve` | Post Approvals Approve +[**cancel-approval-by-id-v1**](#cancel-approval-by-id-v1) | **POST** `/generic-approvals/v1/{id}/cancel` | Post Approval Cancel +[**cancel-approval-v1**](#cancel-approval-v1) | **POST** `/generic-approvals/v1/bulk-cancel` | Post Bulk Cancel Approvals +[**delete-approval-config-request-v1**](#delete-approval-config-request-v1) | **DELETE** `/generic-approvals/v1/config/{id}/{scope}` | Delete Approval Configuration +[**get-approval-v1**](#get-approval-v1) | **GET** `/generic-approvals/v1/{id}` | Get an approval +[**get-approvals-config-v1**](#get-approvals-config-v1) | **GET** `/generic-approvals/v1/config/{id}` | Get Approval Config +[**get-approvals-v1**](#get-approvals-v1) | **GET** `/generic-approvals/v1` | Get approvals +[**move-approval-v1**](#move-approval-v1) | **POST** `/generic-approvals/v1/bulk-reassign` | Post Bulk Reassign Approvals +[**put-approvals-config-v1**](#put-approvals-config-v1) | **PUT** `/generic-approvals/v1/config/{id}/{scope}` | Put Approval Config +[**reject-approval-in-bulk-v1**](#reject-approval-in-bulk-v1) | **POST** `/generic-approvals/v1/bulk-reject` | Post Bulk Reject Approvals +[**reject-approval-v1**](#reject-approval-v1) | **POST** `/generic-approvals/v1/{id}/reject` | Post Approvals Reject +[**update-approvals-attributes-v1**](#update-approvals-attributes-v1) | **POST** `/generic-approvals/v1/{id}/attributes` | Post Approvals Attributes +[**update-approvals-comments-v1**](#update-approvals-comments-v1) | **POST** `/generic-approvals/v1/{id}/comments` | Post Approvals Comments +[**update-approvals-reassign-v1**](#update-approvals-reassign-v1) | **POST** `/generic-approvals/v1/{id}/reassign` | Post Approvals Reassign + + +## approve-approval-in-bulk-v1 +Post Bulk Approve Approvals +Bulk Approves specified approval requests on behalf of the caller + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-approval-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkapproverequestdtoV1** | **BulkapproverequestdtoV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const bulkapproverequestdtoV1: BulkapproverequestdtoV1 = ; // +const result = await apiInstance.approveApprovalInBulkV1(bulkapproverequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## approve-approval-v1 +Post Approvals Approve +Approves a specified approval request on behalf of the caller. The approval request must be in a state that allows it to be approved. This endpoint does not support access request IDs. +If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Approval ID that correlates to an existing approval request that a user wants to approve. | [default to undefined] +**approvalapproverequestV1** | **ApprovalapproverequestV1** | | [optional] + +### Return type + +**Approval2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // Approval ID that correlates to an existing approval request that a user wants to approve. +const approvalapproverequestV1: ApprovalapproverequestV1 = ; // (optional) +const result = await apiInstance.approveApprovalV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## cancel-approval-by-id-v1 +Post Approval Cancel +Cancels a specified approval requests on behalf of the caller. +Note: This endpoint does not support access request IDs. To cancel access request approvals, please use the following: +/access-requests/cancel + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-approval-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the approval request to cancel. | [default to undefined] +**approvalcancelrequestV1** | **ApprovalcancelrequestV1** | | [optional] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // ID of the approval request to cancel. +const approvalcancelrequestV1: ApprovalcancelrequestV1 = ; // (optional) +const result = await apiInstance.cancelApprovalByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## cancel-approval-v1 +Post Bulk Cancel Approvals +Bulk cancels specified approval requests on behalf of the caller. +Note: To bulk cancel access request approvals, please use the following: +/access-requests/bulk-cancel + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkcancelrequestdtoV1** | **BulkcancelrequestdtoV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const bulkcancelrequestdtoV1: BulkcancelrequestdtoV1 = ; // +const result = await apiInstance.cancelApprovalV1(bulkcancelrequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-approval-config-request-v1 +Delete Approval Configuration +Deletes an approval configuration. +Configurations at the APPROVAL_REQUEST scope cannot be deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-approval-config-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT | [default to undefined] +**scope** | **'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'** | The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = ACCESS_REQUEST_APPROVAL; // The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT +const scope: string = APPROVAL_TYPE; // The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT +const result = await apiInstance.deleteApprovalConfigRequestV1(id, scope); +console.log(result); +``` + +[[Back to top]](#) + +## get-approval-v1 +Get an approval +Fetches an approval request by it's approval ID. For lookups by access request ID please use the following: +/generic-approvals?filters=referenceType+eq+"accessRequestId"+and+referenceId+eq+"12345678901234567890123456789012" + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the approval that is to be returned | [default to undefined] + +### Return type + +**Approval2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // ID of the approval that is to be returned +const result = await apiInstance.getApprovalV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-approvals-config-v1 +Get Approval Config +Retrieves a singular approval configuration that matches the given ID + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-approvals-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] | [default to undefined] + +### Return type + +**ApprovalconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 1.2345678901234567E+31; // The id of the object the config applies to, for example one of the following: [(approvalID), (roleID), (entitlementID), (accessProfileID), \"ENTITLEMENT_DESCRIPTIONS\", \"ACCESS_REQUEST_APPROVAL\", \"ACCOUNT_CREATE_APPROVAL_REQUEST\", \"ACCOUNT_DELETE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST\", \"MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST\", (tenantID)] +const result = await apiInstance.getApprovalsConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-approvals-v1 +Get approvals +Gets a list of approvals. + +One of the following query parameters should be present: 'mine', 'approverId', 'requesterId', 'requesteeId'. + +The absence of all query parameters for non admins will default to mine=true (which is the equivalent of 'approverId=[your_identity_id]') +while admins will default to mine=false (which will show all approvals in the org). + +For lookups by access request ID please use the following: + +'/generic-approvals?mine=false&filters=referenceType+eq+"accessRequestId"+and+referenceId+eq+"12345678901234567890123456789012"' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-approvals-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**mine** | **boolean** | Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). | [optional] [default to false] +**requesterId** | **string** | Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. | [optional] [default to undefined] +**requesteeId** | **string** | Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. | [optional] [default to undefined] +**approverId** | **string** | Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. | [optional] [default to undefined] +**count** | **boolean** | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. | [optional] [default to false] +**countOnly** | **boolean** | Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. | [optional] [default to false] +**includeComments** | **boolean** | If set to true in the query, the approval requests returned will include comments. | [optional] [default to false] +**includeApprovers** | **boolean** | If set to true in the query, the approval requests returned will include approvers. | [optional] [default to false] +**includeReassignmentHistory** | **boolean** | If set to true in the query, the approval requests returned will include reassignment history. | [optional] [default to false] +**includeBatchInfo** | **boolean** | If set to true in the query, the approval requests returned will include batch information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const mine: boolean = true; // Determines whether to return the list of approvals assigned to the current caller or all approvals in the org. Defaults to false if admin, true otherwise (which is the equivalent of \'approverId=[your_identity_id]\'). (optional) +const requesterId: string = 17e633e7d57e481569df76323169deb6a; // Returns the list of approvals for a given requester ID. Must match the calling user\'s identity ID unless they are an admin. (optional) +const requesteeId: string = 27e6334g757e481569df76323169db9sc; // Returns the list of approvals for a given requesteeId ID. Must match the calling user\'s identity ID unless they are an admin. (optional) +const approverId: string = 37e6334g557e481569df7g2d3169db9sb; // Returns the list of approvals for a given approverId ID. Must match the calling user\'s identity ID unless they are an admin. (optional) +const count: boolean = true; // Adds X-Total-Count to the header to give the amount of total approvals returned from the query. (optional) +const countOnly: boolean = true; // Adds X-Total-Count to the header to give the amount of total approvals returned from the query. Only returns the count and no approval objects. (optional) +const includeComments: boolean = true; // If set to true in the query, the approval requests returned will include comments. (optional) +const includeApprovers: boolean = true; // If set to true in the query, the approval requests returned will include approvers. (optional) +const includeReassignmentHistory: boolean = true; // If set to true in the query, the approval requests returned will include reassignment history. (optional) +const includeBatchInfo: boolean = true; // If set to true in the query, the approval requests returned will include batch information. (optional) +const filters: string = filters=status eq "PENDING" and type eq "ACCESS_REQUEST_APPROVAL"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, ne, in, co, sw* **name**: *eq, ne, in, co, sw* **priority**: *eq, ne, in, co, sw* **type**: *eq, ne, in, co, sw* **medium**: *eq, ne, in, co, sw* **description**: *eq, ne, in, co, sw* **batchId**: *eq, ne, in, co, sw* **createdDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **dueDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **completedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **search**: *eq, ne, in, co, sw* **referenceId**: *eq, ne, in, co, sw* **referenceType**: *eq, ne, in, co, sw* **referenceName**: *eq, ne, in, co, sw* **requestedTargetId**: *eq, ne, in, co, sw* **requestedTargetType**: *eq, ne, in, co, sw* **requestedTargetName**: *eq, ne, in, co, sw* **requestedTargetRequestType**: *eq, ne, in, co, sw* **modifiedDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **decisionDate**: *eq, ne, in, co, sw, gt, ge, lt, le* **approvalId**: *eq, ne, in, co, sw* **requesterId**: *eq, ne, in, co, sw* **requesteeId**: *eq, ne, in, co, sw* **approverId**: *eq, ne, in, co, sw* (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getApprovalsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## move-approval-v1 +Post Bulk Reassign Approvals +Bulk reassigns specified approval requests on behalf of the caller + +[API Spec](https://developer.sailpoint.com/docs/api/v1/move-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkreassignrequestdtoV1** | **BulkreassignrequestdtoV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const bulkreassignrequestdtoV1: BulkreassignrequestdtoV1 = ; // +const result = await apiInstance.moveApprovalV1(bulkreassignrequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-approvals-config-v1 +Put Approval Config +Upserts a singular approval configuration that matches the given configID and configScope. +For example to update the approval configurations for all Access Request Approvals please use: '/generic-approvals/config/ACCESS_REQUEST_APPROVAL/APPROVAL_TYPE' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-approvals-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT | [default to undefined] +**scope** | **'DOMAIN_OBJECT' | 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | 'APPROVAL_TYPE' | 'TENANT'** | The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT | [default to undefined] +**approvalconfigV1** | **ApprovalconfigV1** | | + +### Return type + +**ApprovalconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = ACCESS_REQUEST_APPROVAL; // The ID defined by the scope field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT +const scope: string = APPROVAL_TYPE; // The scope of the field, where [[id]]:[[scope]] is the following [[roleID]]:ROLE [[entitlementID]]:ENTITLEMENT [[accessProfileID]]:ACCESS_PROFILE ENTITLEMENT_DESCRIPTIONS:APPROVAL_TYPE ACCESS_REQUEST_APPROVAL:APPROVAL_TYPE ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_CREATE_APPROVAL_REQUEST:APPROVAL_TYPE MACHINE_ACCOUNT_DELETE_APPROVAL_REQUEST:APPROVAL_TYPE [[tenantID]]:TENANT [[domainObjectID]]:DOMAIN_OBJECT +const approvalconfigV1: ApprovalconfigV1 = ; // +const result = await apiInstance.putApprovalsConfigV1(id, scope, approvalconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## reject-approval-in-bulk-v1 +Post Bulk Reject Approvals +Bulk reject specified approval requests on behalf of the caller + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-approval-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkrejectrequestdtoV1** | **BulkrejectrequestdtoV1** | | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const bulkrejectrequestdtoV1: BulkrejectrequestdtoV1 = ; // +const result = await apiInstance.rejectApprovalInBulkV1(bulkrejectrequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## reject-approval-v1 +Post Approvals Reject +Rejects a specified approval request on behalf of the caller. This endpoint does not support access request IDs. +If called by an admin and the admin is not listed as an approver, the approval request will be reassigned from a random approver to the admin user and approved. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Approval ID that correlates to an existing approval request that a user wants to reject. | [default to undefined] +**approvalrejectrequestV1** | **ApprovalrejectrequestV1** | | [optional] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // Approval ID that correlates to an existing approval request that a user wants to reject. +const approvalrejectrequestV1: ApprovalrejectrequestV1 = ; // (optional) +const result = await apiInstance.rejectApprovalV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-approvals-attributes-v1 +Post Approvals Attributes +Allows for the edit/addition/removal of the key/value pair additional attributes map for an existing approval request. This endpoint does not support access request IDs. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-approvals-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Approval ID that correlates to an existing approval request that a user wants to change the attributes of. | [default to undefined] +**approvalattributesrequestV1** | **ApprovalattributesrequestV1** | | + +### Return type + +**Approval2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // Approval ID that correlates to an existing approval request that a user wants to change the attributes of. +const approvalattributesrequestV1: ApprovalattributesrequestV1 = ; // +const result = await apiInstance.updateApprovalsAttributesV1(id, approvalattributesrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-approvals-comments-v1 +Post Approvals Comments +Adds comments to a specified approval request. This endpoint does not support access request IDs. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-approvals-comments-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Approval ID that correlates to an existing approval request that a user wants to add a comment to. | [default to undefined] +**approvalcommentsrequestV1** | **ApprovalcommentsrequestV1** | | + +### Return type + +**Approval2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // Approval ID that correlates to an existing approval request that a user wants to add a comment to. +const approvalcommentsrequestV1: ApprovalcommentsrequestV1 = ; // +const result = await apiInstance.updateApprovalsCommentsV1(id, approvalcommentsrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-approvals-reassign-v1 +Post Approvals Reassign +Reassigns an approval request to another identity resulting in that identity being added as an authorized approver. This endpoint does not support access request IDs. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-approvals-reassign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Approval ID that correlates to an existing approval request that a user wants to reassign. | [default to undefined] +**approvalreassignrequestV1** | **ApprovalreassignrequestV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ApprovalsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ApprovalsV1Api(configuration); +const id: string = 38453251-6be2-5f8f-df93-5ce19e295837; // Approval ID that correlates to an existing approval request that a user wants to reassign. +const approvalreassignrequestV1: ApprovalreassignrequestV1 = ; // +const result = await apiInstance.updateApprovalsReassignV1(id, approvalreassignrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/approvals/docs/Methods/Index.md b/sdk-output/approvals/docs/Methods/Index.md new file mode 100644 index 00000000..2972ce26 --- /dev/null +++ b/sdk-output/approvals/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: approvals-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: approvals-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'approvals', 'methods'] +slug: /tools/sdk/typescript/approvals/methods +tags: ['SDK', 'Software Development Kit', 'approvals', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/approvals/docs/Models/Approval2.md b/sdk-output/approvals/docs/Models/Approval2.md new file mode 100644 index 00000000..ef56bc7d --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approval2.md @@ -0,0 +1,47 @@ +--- +id: v1-approval2-v1 +title: Approval2V1 +pagination_label: Approval2V1 +sidebar_label: Approval2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approval2V1', 'v1Approval2V1'] +slug: /tools/sdk/typescript/approvals/models/approval2-v1 +tags: ['SDK', 'Software Development Kit', 'Approval2V1', 'v1Approval2V1'] +--- + +# Approval2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The Approval ID | [default to undefined] +**tenantId** | **(optional)** **string** | The Tenant ID of the Approval | [default to undefined] +**type** | **(optional)** **string** | The type of the approval, such as ENTITLEMENT_DESCRIPTIONS, CUSTOM_ACCESS_REQUEST_APPROVAL, GENERIC_APPROVAL | [default to undefined] +**approvers** | **(optional)** **Array<ApprovalidentityV1>** | Object representation of an approver of an approval | [default to undefined] +**createdDate** | **(optional)** **string** | Date the approval was created | [default to undefined] +**dueDate** | **(optional)** **string** | Date the approval is due | [default to undefined] +**escalationStep** | **(optional)** **string** | Step in the escalation process. If set to 0, the approval is not escalated. If set to 1, the approval is escalated to the first approver in the escalation chain. | [default to undefined] +**serialStep** | **(optional)** **number** | The serial step of the approval in the approval chain. For example, serialStep 1 is the first approval to action in an approval request chain. Parallel approvals are set to 0. | [default to undefined] +**isEscalated** | **(optional)** **boolean** | Whether or not the approval has been escalated. Will reset to false when the approval is actioned on. | [default to false] +**name** | **(optional)** **Array<ApprovalnameV1>** | The name of the approval for a given locale | [default to undefined] +**batchRequest** | **(optional)** **ApprovalbatchV1** | | [default to undefined] +**approvalConfig** | **(optional)** **ApprovalconfigV1** | | [default to undefined] +**description** | **(optional)** **Array<ApprovaldescriptionV1>** | The description of the approval for a given locale | [default to undefined] +**medium** | **(optional)** **string** | Signifies what medium to use when sending notifications (currently only email is utilized) | [default to undefined] +**priority** | **(optional)** **string** | The priority of the approval | [default to undefined] +**requester** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**requestee** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**comments** | **(optional)** **Array<Approvalcomment3V1>** | Object representation of a comment on the approval | [default to undefined] +**approvedBy** | **(optional)** **Array<ApprovalidentityrecordV1>** | Array of approvers who have approved the approval | [default to undefined] +**rejectedBy** | **(optional)** **Array<ApprovalidentityrecordV1>** | Array of approvers who have rejected the approval | [default to undefined] +**assignedTo** | **(optional)** **Array<ApprovalidentityV1>** | Array of identities that the approval request is currently assigned to/waiting on. For parallel approvals, this is set to all approvers left to approve. | [default to undefined] +**completedDate** | **(optional)** **string** | Date the approval was completed | [default to undefined] +**approvalCriteria** | **(optional)** **Approval2ApprovalCriteriaV1** | | [default to undefined] +**additionalAttributes** | **(optional)** **string** | Json string representing additional attributes known about the object to be approved. | [default to undefined] +**referenceData** | **(optional)** **Array<ApprovalreferenceV1>** | Reference data related to the approval | [default to undefined] +**reassignmentHistory** | **(optional)** **Array<ApprovalreassignmenthistoryV1>** | History of whom the approval request was assigned to | [default to undefined] +**staticAttributes** | **(optional)** | Field that can include any static additional info that may be needed by the service that the approval request originated from | [default to undefined] +**modifiedDate** | **(optional)** **string** | Date/time that the approval request was last updated | [default to undefined] +**requestedTarget** | **(optional)** **Array<ApprovalrequestedtargetV1>** | RequestedTarget used to specify the actual object or target the approval request is for | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approval2ApprovalCriteria.md b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteria.md new file mode 100644 index 00000000..c3420bb7 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteria.md @@ -0,0 +1,21 @@ +--- +id: v1-approval2-approval-criteria-v1 +title: Approval2ApprovalCriteriaV1 +pagination_label: Approval2ApprovalCriteriaV1 +sidebar_label: Approval2ApprovalCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approval2ApprovalCriteriaV1', 'v1Approval2ApprovalCriteriaV1'] +slug: /tools/sdk/typescript/approvals/models/approval2-approval-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'Approval2ApprovalCriteriaV1', 'v1Approval2ApprovalCriteriaV1'] +--- + +# Approval2ApprovalCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of approval criteria, such as SERIAL or PARALLEL | [default to undefined] +**approval** | **(optional)** **Approval2ApprovalCriteriaApprovalV1** | | [default to undefined] +**rejection** | **(optional)** **Approval2ApprovalCriteriaRejectionV1** | | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaApproval.md b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaApproval.md new file mode 100644 index 00000000..03cb37cb --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaApproval.md @@ -0,0 +1,20 @@ +--- +id: v1-approval2-approval-criteria-approval-v1 +title: Approval2ApprovalCriteriaApprovalV1 +pagination_label: Approval2ApprovalCriteriaApprovalV1 +sidebar_label: Approval2ApprovalCriteriaApprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approval2ApprovalCriteriaApprovalV1', 'v1Approval2ApprovalCriteriaApprovalV1'] +slug: /tools/sdk/typescript/approvals/models/approval2-approval-criteria-approval-v1 +tags: ['SDK', 'Software Development Kit', 'Approval2ApprovalCriteriaApprovalV1', 'v1Approval2ApprovalCriteriaApprovalV1'] +--- + +# Approval2ApprovalCriteriaApprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**calculationType** | **(optional)** **string** | This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to approve | [default to undefined] +**value** | **(optional)** **number** | The value that needs to be met for the approval criteria | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaRejection.md b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaRejection.md new file mode 100644 index 00000000..a2013e39 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approval2ApprovalCriteriaRejection.md @@ -0,0 +1,20 @@ +--- +id: v1-approval2-approval-criteria-rejection-v1 +title: Approval2ApprovalCriteriaRejectionV1 +pagination_label: Approval2ApprovalCriteriaRejectionV1 +sidebar_label: Approval2ApprovalCriteriaRejectionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approval2ApprovalCriteriaRejectionV1', 'v1Approval2ApprovalCriteriaRejectionV1'] +slug: /tools/sdk/typescript/approvals/models/approval2-approval-criteria-rejection-v1 +tags: ['SDK', 'Software Development Kit', 'Approval2ApprovalCriteriaRejectionV1', 'v1Approval2ApprovalCriteriaRejectionV1'] +--- + +# Approval2ApprovalCriteriaRejectionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**calculationType** | **(optional)** **string** | This defines what the field \"value\" will be used as, either a count or percentage of the total approvers that need to reject | [default to undefined] +**value** | **(optional)** **number** | The value that needs to be met for the rejection criteria | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalapproverequest.md b/sdk-output/approvals/docs/Models/Approvalapproverequest.md new file mode 100644 index 00000000..b5fb933e --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalapproverequest.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalapproverequest-v1 +title: ApprovalapproverequestV1 +pagination_label: ApprovalapproverequestV1 +sidebar_label: ApprovalapproverequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalapproverequestV1', 'v1ApprovalapproverequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalapproverequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalapproverequestV1', 'v1ApprovalapproverequestV1'] +--- + +# ApprovalapproverequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**additionalAttributes** | **(optional)** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [default to undefined] +**comment** | **(optional)** **string** | Comment associated with the request. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalattributesrequest.md b/sdk-output/approvals/docs/Models/Approvalattributesrequest.md new file mode 100644 index 00000000..a0ec4254 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalattributesrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalattributesrequest-v1 +title: ApprovalattributesrequestV1 +pagination_label: ApprovalattributesrequestV1 +sidebar_label: ApprovalattributesrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalattributesrequestV1', 'v1ApprovalattributesrequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalattributesrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalattributesrequestV1', 'v1ApprovalattributesrequestV1'] +--- + +# ApprovalattributesrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**additionalAttributes** | **(optional)** | Additional attributes as key-value pairs that are not part of the standard schema but can be included for custom data. | [default to undefined] +**comment** | **(optional)** **string** | Comment associated with the request. | [default to undefined] +**removeAttributeKeys** | **(optional)** **Array<string>** | List of attribute keys to be removed. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalbatch.md b/sdk-output/approvals/docs/Models/Approvalbatch.md new file mode 100644 index 00000000..6e77c28f --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalbatch.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalbatch-v1 +title: ApprovalbatchV1 +pagination_label: ApprovalbatchV1 +sidebar_label: ApprovalbatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalbatchV1', 'v1ApprovalbatchV1'] +slug: /tools/sdk/typescript/approvals/models/approvalbatch-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalbatchV1', 'v1ApprovalbatchV1'] +--- + +# ApprovalbatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batchId** | **(optional)** **string** | ID of the batch | [default to undefined] +**batchSize** | **(optional)** **number** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalcancelrequest.md b/sdk-output/approvals/docs/Models/Approvalcancelrequest.md new file mode 100644 index 00000000..b580e1e2 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalcancelrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-approvalcancelrequest-v1 +title: ApprovalcancelrequestV1 +pagination_label: ApprovalcancelrequestV1 +sidebar_label: ApprovalcancelrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalcancelrequestV1', 'v1ApprovalcancelrequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalcancelrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalcancelrequestV1', 'v1ApprovalcancelrequestV1'] +--- + +# ApprovalcancelrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Optional comment associated with the cancel request. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalcomment3.md b/sdk-output/approvals/docs/Models/Approvalcomment3.md new file mode 100644 index 00000000..32bf3579 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalcomment3.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalcomment3-v1 +title: Approvalcomment3V1 +pagination_label: Approvalcomment3V1 +sidebar_label: Approvalcomment3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Approvalcomment3V1', 'v1Approvalcomment3V1'] +slug: /tools/sdk/typescript/approvals/models/approvalcomment3-v1 +tags: ['SDK', 'Software Development Kit', 'Approvalcomment3V1', 'v1Approvalcomment3V1'] +--- + +# Approvalcomment3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**author** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**comment** | **(optional)** **string** | Comment to be left on an approval | [default to undefined] +**createdDate** | **(optional)** **string** | Date the comment was created | [default to undefined] +**commentId** | **(optional)** **string** | ID of the comment | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalcommentsrequest.md b/sdk-output/approvals/docs/Models/Approvalcommentsrequest.md new file mode 100644 index 00000000..7027bceb --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalcommentsrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-approvalcommentsrequest-v1 +title: ApprovalcommentsrequestV1 +pagination_label: ApprovalcommentsrequestV1 +sidebar_label: ApprovalcommentsrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalcommentsrequestV1', 'v1ApprovalcommentsrequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalcommentsrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalcommentsrequestV1', 'v1ApprovalcommentsrequestV1'] +--- + +# ApprovalcommentsrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment associated with the request. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalconfig.md b/sdk-output/approvals/docs/Models/Approvalconfig.md new file mode 100644 index 00000000..aa2e90f6 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalconfig.md @@ -0,0 +1,28 @@ +--- +id: v1-approvalconfig-v1 +title: ApprovalconfigV1 +pagination_label: ApprovalconfigV1 +sidebar_label: ApprovalconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigV1', 'v1ApprovalconfigV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigV1', 'v1ApprovalconfigV1'] +--- + +# ApprovalconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reminderConfig** | **(optional)** **ApprovalconfigReminderConfigV1** | | [default to undefined] +**escalationConfig** | **(optional)** **ApprovalconfigEscalationConfigV1** | | [default to undefined] +**timeoutConfig** | **(optional)** **ApprovalconfigTimeoutConfigV1** | | [default to undefined] +**cronTimezone** | **(optional)** **ApprovalconfigCronTimezoneV1** | | [default to undefined] +**serialChain** | **(optional)** **Array<ApprovalconfigSerialChainInnerV1>** | If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. | [default to undefined] +**requiresComment** | **(optional)** **string** | Determines whether a comment is required when approving or rejecting the approval request. | [default to undefined] +**fallbackApprover** | **(optional)** **ApprovalconfigFallbackApproverV1** | | [default to undefined] +**machineIdentityManagerAssignment** | **(optional)** **string** | Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. | [default to MachineIdentityManagerAssignmentV1_ManagerOfRequester] +**circumventApprovalProcess** | **(optional)** **boolean** | When true, all approvals will be created with the status \"PASSED\". | [default to false] +**autoApprove** | **(optional)** **string** | OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigCronTimezone.md b/sdk-output/approvals/docs/Models/ApprovalconfigCronTimezone.md new file mode 100644 index 00000000..28d0e60d --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigCronTimezone.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalconfig-cron-timezone-v1 +title: ApprovalconfigCronTimezoneV1 +pagination_label: ApprovalconfigCronTimezoneV1 +sidebar_label: ApprovalconfigCronTimezoneV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigCronTimezoneV1', 'v1ApprovalconfigCronTimezoneV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-cron-timezone-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigCronTimezoneV1', 'v1ApprovalconfigCronTimezoneV1'] +--- + +# ApprovalconfigCronTimezoneV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | **(optional)** **string** | Timezone location for cron schedules. | [default to undefined] +**offset** | **(optional)** **string** | Timezone offset for cron schedules. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfig.md b/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfig.md new file mode 100644 index 00000000..a2c6bb47 --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfig.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalconfig-escalation-config-v1 +title: ApprovalconfigEscalationConfigV1 +pagination_label: ApprovalconfigEscalationConfigV1 +sidebar_label: ApprovalconfigEscalationConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigEscalationConfigV1', 'v1ApprovalconfigEscalationConfigV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-escalation-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigEscalationConfigV1', 'v1ApprovalconfigEscalationConfigV1'] +--- + +# ApprovalconfigEscalationConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if escalations are enabled. | [default to false] +**daysUntilFirstEscalation** | **(optional)** **number** | Number of days until the first escalation. | [default to undefined] +**escalationCronSchedule** | **(optional)** **string** | Cron schedule for escalations. | [default to undefined] +**escalationChain** | **(optional)** **Array<ApprovalconfigEscalationConfigEscalationChainInnerV1>** | Escalation chain configuration. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md b/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md new file mode 100644 index 00000000..a946a628 --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-escalation-config-escalation-chain-inner-v1 +title: ApprovalconfigEscalationConfigEscalationChainInnerV1 +pagination_label: ApprovalconfigEscalationConfigEscalationChainInnerV1 +sidebar_label: ApprovalconfigEscalationConfigEscalationChainInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigEscalationConfigEscalationChainInnerV1', 'v1ApprovalconfigEscalationConfigEscalationChainInnerV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-escalation-config-escalation-chain-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigEscalationConfigEscalationChainInnerV1', 'v1ApprovalconfigEscalationConfigEscalationChainInnerV1'] +--- + +# ApprovalconfigEscalationConfigEscalationChainInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier** | **(optional)** **number** | Starting at 1 defines the order in which the identities will get assigned | [default to undefined] +**identityId** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'identityType\' field. | [default to undefined] +**identityType** | **(optional)** **string** | Type of identityId in the escalation chain. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigFallbackApprover.md b/sdk-output/approvals/docs/Models/ApprovalconfigFallbackApprover.md new file mode 100644 index 00000000..01261de8 --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigFallbackApprover.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalconfig-fallback-approver-v1 +title: ApprovalconfigFallbackApproverV1 +pagination_label: ApprovalconfigFallbackApproverV1 +sidebar_label: ApprovalconfigFallbackApproverV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigFallbackApproverV1', 'v1ApprovalconfigFallbackApproverV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-fallback-approver-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigFallbackApproverV1', 'v1ApprovalconfigFallbackApproverV1'] +--- + +# ApprovalconfigFallbackApproverV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityID** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'type\' field. | [default to undefined] +**type** | **(optional)** **string** | Type of identityID for the fallback approver. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigReminderConfig.md b/sdk-output/approvals/docs/Models/ApprovalconfigReminderConfig.md new file mode 100644 index 00000000..453cc250 --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigReminderConfig.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalconfig-reminder-config-v1 +title: ApprovalconfigReminderConfigV1 +pagination_label: ApprovalconfigReminderConfigV1 +sidebar_label: ApprovalconfigReminderConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigReminderConfigV1', 'v1ApprovalconfigReminderConfigV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-reminder-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigReminderConfigV1', 'v1ApprovalconfigReminderConfigV1'] +--- + +# ApprovalconfigReminderConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if reminders are enabled. | [default to false] +**daysUntilFirstReminder** | **(optional)** **number** | Number of days until the first reminder. | [default to undefined] +**reminderCronSchedule** | **(optional)** **string** | Cron schedule for reminders. | [default to undefined] +**maxReminders** | **(optional)** **number** | Maximum number of reminders. Max is 20. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigSerialChainInner.md b/sdk-output/approvals/docs/Models/ApprovalconfigSerialChainInner.md new file mode 100644 index 00000000..dadbdf3c --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigSerialChainInner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-serial-chain-inner-v1 +title: ApprovalconfigSerialChainInnerV1 +pagination_label: ApprovalconfigSerialChainInnerV1 +sidebar_label: ApprovalconfigSerialChainInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigSerialChainInnerV1', 'v1ApprovalconfigSerialChainInnerV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-serial-chain-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigSerialChainInnerV1', 'v1ApprovalconfigSerialChainInnerV1'] +--- + +# ApprovalconfigSerialChainInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier** | **(optional)** **number** | Starting at 1 defines the order in which the identities will get assigned | [default to undefined] +**identityId** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'identityType\' field. | [default to undefined] +**identityType** | **(optional)** **string** | Type of identityId in the serial chain. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalconfigTimeoutConfig.md b/sdk-output/approvals/docs/Models/ApprovalconfigTimeoutConfig.md new file mode 100644 index 00000000..e54005b5 --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalconfigTimeoutConfig.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-timeout-config-v1 +title: ApprovalconfigTimeoutConfigV1 +pagination_label: ApprovalconfigTimeoutConfigV1 +sidebar_label: ApprovalconfigTimeoutConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigTimeoutConfigV1', 'v1ApprovalconfigTimeoutConfigV1'] +slug: /tools/sdk/typescript/approvals/models/approvalconfig-timeout-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigTimeoutConfigV1', 'v1ApprovalconfigTimeoutConfigV1'] +--- + +# ApprovalconfigTimeoutConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if timeout is enabled. | [default to false] +**daysUntilTimeout** | **(optional)** **number** | Number of days until approval request times out. Max value is 90. | [default to undefined] +**timeoutResult** | **(optional)** **string** | Result of timeout. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvaldescription.md b/sdk-output/approvals/docs/Models/Approvaldescription.md new file mode 100644 index 00000000..b6c33071 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvaldescription.md @@ -0,0 +1,20 @@ +--- +id: v1-approvaldescription-v1 +title: ApprovaldescriptionV1 +pagination_label: ApprovaldescriptionV1 +sidebar_label: ApprovaldescriptionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovaldescriptionV1', 'v1ApprovaldescriptionV1'] +slug: /tools/sdk/typescript/approvals/models/approvaldescription-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovaldescriptionV1', 'v1ApprovaldescriptionV1'] +--- + +# ApprovaldescriptionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The description of what the approval is asking for | [default to undefined] +**locale** | **(optional)** **string** | What locale the description of the approval is using | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalidentity.md b/sdk-output/approvals/docs/Models/Approvalidentity.md new file mode 100644 index 00000000..dc11d494 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalidentity.md @@ -0,0 +1,25 @@ +--- +id: v1-approvalidentity-v1 +title: ApprovalidentityV1 +pagination_label: ApprovalidentityV1 +sidebar_label: ApprovalidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalidentityV1', 'v1ApprovalidentityV1'] +slug: /tools/sdk/typescript/approvals/models/approvalidentity-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalidentityV1', 'v1ApprovalidentityV1'] +--- + +# ApprovalidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **(optional)** **string** | Email address. | [default to undefined] +**identityID** | **(optional)** **string** | Identity ID of the type of identity defined in the \'type\' field. | [default to undefined] +**members** | **(optional)** **Array<ApprovalidentityMembersInnerV1>** | List of members of a governance group. Will be omitted if the identity is not a governance group. | [default to undefined] +**name** | **(optional)** **string** | Name of the identity. | [default to undefined] +**ownerOf** | **(optional)** **Array<ApprovalidentityOwnerOfInnerV1>** | List of owned items. For example, will show the items in which a ROLE_OWNER owns. Omitted if not an owner of anything. | [default to undefined] +**serialOrder** | **(optional)** **number** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [default to undefined] +**type** | **(optional)** **string** | Type of identityID. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalidentityMembersInner.md b/sdk-output/approvals/docs/Models/ApprovalidentityMembersInner.md new file mode 100644 index 00000000..bd07ceaf --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalidentityMembersInner.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalidentity-members-inner-v1 +title: ApprovalidentityMembersInnerV1 +pagination_label: ApprovalidentityMembersInnerV1 +sidebar_label: ApprovalidentityMembersInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalidentityMembersInnerV1', 'v1ApprovalidentityMembersInnerV1'] +slug: /tools/sdk/typescript/approvals/models/approvalidentity-members-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalidentityMembersInnerV1', 'v1ApprovalidentityMembersInnerV1'] +--- + +# ApprovalidentityMembersInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **(optional)** **string** | Email of the member. | [default to undefined] +**id** | **(optional)** **string** | ID of the member. | [default to undefined] +**name** | **(optional)** **string** | Name of the member. | [default to undefined] +**type** | **(optional)** **string** | Type of the member. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/ApprovalidentityOwnerOfInner.md b/sdk-output/approvals/docs/Models/ApprovalidentityOwnerOfInner.md new file mode 100644 index 00000000..4b6b830c --- /dev/null +++ b/sdk-output/approvals/docs/Models/ApprovalidentityOwnerOfInner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalidentity-owner-of-inner-v1 +title: ApprovalidentityOwnerOfInnerV1 +pagination_label: ApprovalidentityOwnerOfInnerV1 +sidebar_label: ApprovalidentityOwnerOfInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalidentityOwnerOfInnerV1', 'v1ApprovalidentityOwnerOfInnerV1'] +slug: /tools/sdk/typescript/approvals/models/approvalidentity-owner-of-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalidentityOwnerOfInnerV1', 'v1ApprovalidentityOwnerOfInnerV1'] +--- + +# ApprovalidentityOwnerOfInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the object that is owned. | [default to undefined] +**name** | **(optional)** **string** | Name of the object that is owned. | [default to undefined] +**type** | **(optional)** **string** | Type of the object that is owned. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalidentityrecord.md b/sdk-output/approvals/docs/Models/Approvalidentityrecord.md new file mode 100644 index 00000000..334d93fd --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalidentityrecord.md @@ -0,0 +1,25 @@ +--- +id: v1-approvalidentityrecord-v1 +title: ApprovalidentityrecordV1 +pagination_label: ApprovalidentityrecordV1 +sidebar_label: ApprovalidentityrecordV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalidentityrecordV1', 'v1ApprovalidentityrecordV1'] +slug: /tools/sdk/typescript/approvals/models/approvalidentityrecord-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalidentityrecordV1', 'v1ApprovalidentityrecordV1'] +--- + +# ApprovalidentityrecordV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityID** | **(optional)** **string** | Identity ID. | [default to undefined] +**type** | **(optional)** **string** | Type of identity. | [default to undefined] +**name** | **(optional)** **string** | Name of the identity. | [default to undefined] +**actionedAs** | **(optional)** **Array<ApprovalreferenceV1>** | List of references representing actions taken by the identity. | [default to undefined] +**members** | **(optional)** **Array<ApprovalreferenceV1>** | List of references representing members of the identity. | [default to undefined] +**decisionDate** | **(optional)** **string** | Date when the decision was made. | [default to undefined] +**email** | **(optional)** **string** | Email associated with the identity. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalname.md b/sdk-output/approvals/docs/Models/Approvalname.md new file mode 100644 index 00000000..ad34c6e3 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalname.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalname-v1 +title: ApprovalnameV1 +pagination_label: ApprovalnameV1 +sidebar_label: ApprovalnameV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalnameV1', 'v1ApprovalnameV1'] +slug: /tools/sdk/typescript/approvals/models/approvalname-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalnameV1', 'v1ApprovalnameV1'] +--- + +# ApprovalnameV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Name of the approval | [default to undefined] +**locale** | **(optional)** **string** | What locale the name of the approval is using | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalreassignmenthistory.md b/sdk-output/approvals/docs/Models/Approvalreassignmenthistory.md new file mode 100644 index 00000000..317af372 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalreassignmenthistory.md @@ -0,0 +1,24 @@ +--- +id: v1-approvalreassignmenthistory-v1 +title: ApprovalreassignmenthistoryV1 +pagination_label: ApprovalreassignmenthistoryV1 +sidebar_label: ApprovalreassignmenthistoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalreassignmenthistoryV1', 'v1ApprovalreassignmenthistoryV1'] +slug: /tools/sdk/typescript/approvals/models/approvalreassignmenthistory-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalreassignmenthistoryV1', 'v1ApprovalreassignmenthistoryV1'] +--- + +# ApprovalreassignmenthistoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentID** | **(optional)** **string** | Unique identifier for the comment associated with the reassignment. | [default to undefined] +**reassignedFrom** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**reassignedTo** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**reassigner** | **(optional)** **ApprovalidentityV1** | | [default to undefined] +**reassignmentDate** | **(optional)** **string** | Date and time when the reassignment occurred. | [default to undefined] +**reassignmentType** | **(optional)** **string** | Type of reassignment, such as escalation or manual reassignment. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalreassignrequest.md b/sdk-output/approvals/docs/Models/Approvalreassignrequest.md new file mode 100644 index 00000000..274bc5ce --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalreassignrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalreassignrequest-v1 +title: ApprovalreassignrequestV1 +pagination_label: ApprovalreassignrequestV1 +sidebar_label: ApprovalreassignrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalreassignrequestV1', 'v1ApprovalreassignrequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalreassignrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalreassignrequestV1', 'v1ApprovalreassignrequestV1'] +--- + +# ApprovalreassignrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment associated with the reassign request. | [default to undefined] +**reassignFrom** | **(optional)** **string** | Identity from which the approval is being reassigned. If left blank, and the approval is currently assigned to the user calling this endpoint, it will use the calling user\'s identity. If left blank, and the approval is not currently assigned to the user calling this endpoint, you need to be an admin, which would add the reassignTo as a new approver. | [default to undefined] +**reassignTo** | **(optional)** **string** | Identity to which the approval is being reassigned. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalreference.md b/sdk-output/approvals/docs/Models/Approvalreference.md new file mode 100644 index 00000000..878d9213 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalreference.md @@ -0,0 +1,23 @@ +--- +id: v1-approvalreference-v1 +title: ApprovalreferenceV1 +pagination_label: ApprovalreferenceV1 +sidebar_label: ApprovalreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalreferenceV1', 'v1ApprovalreferenceV1'] +slug: /tools/sdk/typescript/approvals/models/approvalreference-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalreferenceV1', 'v1ApprovalreferenceV1'] +--- + +# ApprovalreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the reference object | [default to undefined] +**type** | **(optional)** **string** | What reference object does this ID correspond to | [default to undefined] +**name** | **(optional)** **string** | Name of the reference object | [default to undefined] +**email** | **(optional)** **string** | Email associated with the reference object | [default to undefined] +**serialOrder** | **(optional)** **number** | The serial step of the identity in the approval. For example serialOrder 1 is the first identity to action in an approval request chain. Parallel approvals are set to 0. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalrejectrequest.md b/sdk-output/approvals/docs/Models/Approvalrejectrequest.md new file mode 100644 index 00000000..ae4219eb --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalrejectrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-approvalrejectrequest-v1 +title: ApprovalrejectrequestV1 +pagination_label: ApprovalrejectrequestV1 +sidebar_label: ApprovalrejectrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalrejectrequestV1', 'v1ApprovalrejectrequestV1'] +slug: /tools/sdk/typescript/approvals/models/approvalrejectrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalrejectrequestV1', 'v1ApprovalrejectrequestV1'] +--- + +# ApprovalrejectrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment associated with the reject request. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Approvalrequestedtarget.md b/sdk-output/approvals/docs/Models/Approvalrequestedtarget.md new file mode 100644 index 00000000..ffb055b1 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Approvalrequestedtarget.md @@ -0,0 +1,25 @@ +--- +id: v1-approvalrequestedtarget-v1 +title: ApprovalrequestedtargetV1 +pagination_label: ApprovalrequestedtargetV1 +sidebar_label: ApprovalrequestedtargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalrequestedtargetV1', 'v1ApprovalrequestedtargetV1'] +slug: /tools/sdk/typescript/approvals/models/approvalrequestedtarget-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalrequestedtargetV1', 'v1ApprovalrequestedtargetV1'] +--- + +# ApprovalrequestedtargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**forcedAuthSignature** | **(optional)** **string** | Signature required for forced authentication. | [default to undefined] +**id** | **(optional)** **string** | ID of the requested target. | [default to undefined] +**name** | **(optional)** **string** | Name of the requested target. | [default to undefined] +**reauthRequired** | **(optional)** **boolean** | Indicates if reauthentication is required. | [default to false] +**removalDate** | **(optional)** **string** | Date when the target will be removed. | [default to undefined] +**requestType** | **(optional)** **string** | Type of the request. | [default to undefined] +**targetType** | **(optional)** **string** | Type of the target. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Bulkapproverequestdto.md b/sdk-output/approvals/docs/Models/Bulkapproverequestdto.md new file mode 100644 index 00000000..70822a69 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Bulkapproverequestdto.md @@ -0,0 +1,21 @@ +--- +id: v1-bulkapproverequestdto-v1 +title: BulkapproverequestdtoV1 +pagination_label: BulkapproverequestdtoV1 +sidebar_label: BulkapproverequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkapproverequestdtoV1', 'v1BulkapproverequestdtoV1'] +slug: /tools/sdk/typescript/approvals/models/bulkapproverequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'BulkapproverequestdtoV1', 'v1BulkapproverequestdtoV1'] +--- + +# BulkapproverequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalIds** | **(optional)** **Array<string>** | Array of Approval IDs to be bulk approved | [default to undefined] +**comment** | **(optional)** **string** | Optional comment to include with the bulk approval request | [default to undefined] +**additionalAttributes** | **(optional)** | Additional attributes to include with the bulk approval request | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Bulkcancelrequestdto.md b/sdk-output/approvals/docs/Models/Bulkcancelrequestdto.md new file mode 100644 index 00000000..71597ee7 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Bulkcancelrequestdto.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkcancelrequestdto-v1 +title: BulkcancelrequestdtoV1 +pagination_label: BulkcancelrequestdtoV1 +sidebar_label: BulkcancelrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkcancelrequestdtoV1', 'v1BulkcancelrequestdtoV1'] +slug: /tools/sdk/typescript/approvals/models/bulkcancelrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'BulkcancelrequestdtoV1', 'v1BulkcancelrequestdtoV1'] +--- + +# BulkcancelrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalIds** | **(optional)** **Array<string>** | Array of Approval IDs to be bulk cancelled | [default to undefined] +**comment** | **(optional)** **string** | Optional comment to include with the bulk cancellation request | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Bulkreassignrequestdto.md b/sdk-output/approvals/docs/Models/Bulkreassignrequestdto.md new file mode 100644 index 00000000..162c0355 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Bulkreassignrequestdto.md @@ -0,0 +1,22 @@ +--- +id: v1-bulkreassignrequestdto-v1 +title: BulkreassignrequestdtoV1 +pagination_label: BulkreassignrequestdtoV1 +sidebar_label: BulkreassignrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkreassignrequestdtoV1', 'v1BulkreassignrequestdtoV1'] +slug: /tools/sdk/typescript/approvals/models/bulkreassignrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'BulkreassignrequestdtoV1', 'v1BulkreassignrequestdtoV1'] +--- + +# BulkreassignrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalIds** | **(optional)** **Array<string>** | Array of Approval IDs to be bulk reassigned | [default to undefined] +**comment** | **(optional)** **string** | Optional comment to include with the bulk reassignment request | [default to undefined] +**reassignFrom** | **(optional)** **string** | Identity ID from which the approval requests are being reassigned | [default to undefined] +**reassignTo** | **(optional)** **string** | ReassignTo signifies the Identity ID that the approval request is being reassigned to | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Bulkrejectrequestdto.md b/sdk-output/approvals/docs/Models/Bulkrejectrequestdto.md new file mode 100644 index 00000000..6403f870 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Bulkrejectrequestdto.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkrejectrequestdto-v1 +title: BulkrejectrequestdtoV1 +pagination_label: BulkrejectrequestdtoV1 +sidebar_label: BulkrejectrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkrejectrequestdtoV1', 'v1BulkrejectrequestdtoV1'] +slug: /tools/sdk/typescript/approvals/models/bulkrejectrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'BulkrejectrequestdtoV1', 'v1BulkrejectrequestdtoV1'] +--- + +# BulkrejectrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalIds** | **(optional)** **Array<string>** | Array of Approval IDs to be bulk rejected | [default to undefined] +**comment** | **(optional)** **string** | Optional comment to include with the bulk reject request | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Errormessagedto.md b/sdk-output/approvals/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..d7aa472d --- /dev/null +++ b/sdk-output/approvals/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/approvals/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Errorresponsedto.md b/sdk-output/approvals/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..eed73d00 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/approvals/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/GetApprovalsV1401Response.md b/sdk-output/approvals/docs/Models/GetApprovalsV1401Response.md new file mode 100644 index 00000000..9855c1cf --- /dev/null +++ b/sdk-output/approvals/docs/Models/GetApprovalsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-approvals-v1401-response-v1 +title: GetApprovalsV1401ResponseV1 +pagination_label: GetApprovalsV1401ResponseV1 +sidebar_label: GetApprovalsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetApprovalsV1401ResponseV1', 'v1GetApprovalsV1401ResponseV1'] +slug: /tools/sdk/typescript/approvals/models/get-approvals-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetApprovalsV1401ResponseV1', 'v1GetApprovalsV1401ResponseV1'] +--- + +# GetApprovalsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/GetApprovalsV1429Response.md b/sdk-output/approvals/docs/Models/GetApprovalsV1429Response.md new file mode 100644 index 00000000..7e2599e5 --- /dev/null +++ b/sdk-output/approvals/docs/Models/GetApprovalsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-approvals-v1429-response-v1 +title: GetApprovalsV1429ResponseV1 +pagination_label: GetApprovalsV1429ResponseV1 +sidebar_label: GetApprovalsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetApprovalsV1429ResponseV1', 'v1GetApprovalsV1429ResponseV1'] +slug: /tools/sdk/typescript/approvals/models/get-approvals-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetApprovalsV1429ResponseV1', 'v1GetApprovalsV1429ResponseV1'] +--- + +# GetApprovalsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/approvals/docs/Models/Index.md b/sdk-output/approvals/docs/Models/Index.md new file mode 100644 index 00000000..9bb8dedd --- /dev/null +++ b/sdk-output/approvals/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: approvals-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: approvals-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'approvals', 'models'] +slug: /tools/sdk/typescript/approvals/models +tags: ['SDK', 'Software Development Kit', 'approvals', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/approvals/docs/Models/Localeorigin.md b/sdk-output/approvals/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a86115d8 --- /dev/null +++ b/sdk-output/approvals/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/approvals/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/approvals/docs/Models/README.md b/sdk-output/approvals/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/approvals/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/apps/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/apps/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..0693c753 --- /dev/null +++ b/sdk-output/apps/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,251 @@ +- path: /source-apps/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#create-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const sourceappcreatedtoV1: SourceappcreatedtoV1 = {"name":"new app name","description":"app description","matchAllAccounts":true,"accountSource":{"id":"edcb0951812949d085b60cd8bf35bc78"}}; // SourceappcreatedtoV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createSourceAppV1(sourceappcreatedtoV1); + console.log(result); +- path: /source-apps/v1/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#delete-access-profiles-from-source-app-by-bulk-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the source app (default to undefined) + const requestBody: Array<string> = ["c9575abb5e3a4e3db82b2f989a738aa2","c9dc28e148a24d65b3ccb5fb8ca5ddd9"]; // Array | List of access profile IDs for removal + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteAccessProfilesFromSourceAppByBulkV1(id, requestBody); + console.log(result); +- path: /source-apps/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#delete-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | source app ID. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteSourceAppV1(id); + console.log(result); +- path: /source-apps/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#get-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the source app (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSourceAppV1(id); + console.log(result); +- path: /source-apps/v1/{id}/access-profiles + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-access-profiles-for-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the source app (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'name eq "developer access profile"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAccessProfilesForSourceAppV1(id); + console.log(result); +- path: /source-apps/v1/all + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-all-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) (default to undefined) + const filters: string = 'enabled eq true'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAllSourceAppV1(); + console.log(result); +- path: /user-apps/v1/all + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-all-user-apps-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const filters: string = 'name eq "user app name"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAllUserAppsV1(filters); + console.log(result); +- path: /source-apps/v1/assigned + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-assigned-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) (default to undefined) + const filters: string = 'name eq "source app name"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAssignedSourceAppV1(); + console.log(result); +- path: /user-apps/v1/{id}/available-accounts + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-available-accounts-for-user-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the user app (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAvailableAccountsForUserAppV1(id); + console.log(result); +- path: /source-apps/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-available-source-apps-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) (default to undefined) + const filters: string = 'name eq "source app name"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listAvailableSourceAppsV1(); + console.log(result); +- path: /user-apps/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#list-owned-user-apps-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'name eq "user app name"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listOwnedUserAppsV1(); + console.log(result); +- path: /source-apps/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#patch-source-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the source app to patch (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/enabled","value":true},{"op":"replace","path":"/matchAllAccounts","value":true}]; // Array | (optional) + const result = await apiInstance.patchSourceAppV1(id); + console.log(result); +- path: /user-apps/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#patch-user-app-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the user app to patch (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | (optional) + const result = await apiInstance.patchUserAppV1(id); + console.log(result); +- path: /source-apps/v1/bulk-update + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/apps/methods/apps#update-source-apps-in-bulk-v1 + source: | + import { AppsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AppsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const sourceappbulkupdaterequestV1: SourceappbulkupdaterequestV1 = ; // SourceappbulkupdaterequestV1 | (optional) + const result = await apiInstance.updateSourceAppsInBulkV1(); + console.log(result); diff --git a/sdk-output/apps/docs/Methods/AppsV1Api.md b/sdk-output/apps/docs/Methods/AppsV1Api.md new file mode 100644 index 00000000..d0c2b501 --- /dev/null +++ b/sdk-output/apps/docs/Methods/AppsV1Api.md @@ -0,0 +1,697 @@ +--- +id: v1-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Apps', 'v1Apps'] +slug: /tools/sdk/typescript/apps/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'v1Apps'] +--- + +# AppsV1Api + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-app-v1**](#create-source-app-v1) | **POST** `/source-apps/v1` | Create source app +[**delete-access-profiles-from-source-app-by-bulk-v1**](#delete-access-profiles-from-source-app-by-bulk-v1) | **POST** `/source-apps/v1/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**delete-source-app-v1**](#delete-source-app-v1) | **DELETE** `/source-apps/v1/{id}` | Delete source app by id +[**get-source-app-v1**](#get-source-app-v1) | **GET** `/source-apps/v1/{id}` | Get source app by id +[**list-access-profiles-for-source-app-v1**](#list-access-profiles-for-source-app-v1) | **GET** `/source-apps/v1/{id}/access-profiles` | List access profiles for the specified source app +[**list-all-source-app-v1**](#list-all-source-app-v1) | **GET** `/source-apps/v1/all` | List all source apps +[**list-all-user-apps-v1**](#list-all-user-apps-v1) | **GET** `/user-apps/v1/all` | List all user apps +[**list-assigned-source-app-v1**](#list-assigned-source-app-v1) | **GET** `/source-apps/v1/assigned` | List assigned source apps +[**list-available-accounts-for-user-app-v1**](#list-available-accounts-for-user-app-v1) | **GET** `/user-apps/v1/{id}/available-accounts` | List available accounts for user app +[**list-available-source-apps-v1**](#list-available-source-apps-v1) | **GET** `/source-apps/v1` | List available source apps +[**list-owned-user-apps-v1**](#list-owned-user-apps-v1) | **GET** `/user-apps/v1` | List owned user apps +[**patch-source-app-v1**](#patch-source-app-v1) | **PATCH** `/source-apps/v1/{id}` | Patch source app by id +[**patch-user-app-v1**](#patch-user-app-v1) | **PATCH** `/user-apps/v1/{id}` | Patch user app by id +[**update-source-apps-in-bulk-v1**](#update-source-apps-in-bulk-v1) | **POST** `/source-apps/v1/bulk-update` | Bulk update source apps + + +## create-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create source app +This endpoint creates a source app using the given source app payload + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceappcreatedtoV1** | **SourceappcreatedtoV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourceappV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const sourceappcreatedtoV1: SourceappcreatedtoV1 = {"name":"new app name","description":"app description","matchAllAccounts":true,"accountSource":{"id":"edcb0951812949d085b60cd8bf35bc78"}}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createSourceAppV1(sourceappcreatedtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-access-profiles-from-source-app-by-bulk-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Bulk remove access profiles from the specified source app +This API returns the final list of access profiles for the specified source app after removing + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-access-profiles-from-source-app-by-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the source app | [default to undefined] +**requestBody** | **Array<string>** | List of access profile IDs for removal | +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the source app +const requestBody: Array<string> = ["c9575abb5e3a4e3db82b2f989a738aa2","c9dc28e148a24d65b3ccb5fb8ca5ddd9"]; // List of access profile IDs for removal +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteAccessProfilesFromSourceAppByBulkV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## delete-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete source app by id +Use this API to delete a specific source app + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | source app ID. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourceappV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // source app ID. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteSourceAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get source app by id +This API returns a source app by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the source app | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourceappV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the source app +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSourceAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-access-profiles-for-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List access profiles for the specified source app +This API returns the list of access profiles for the specified source app + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-access-profiles-for-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the source app | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the source app +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "developer access profile"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAccessProfilesForSourceAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-all-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List all source apps +This API returns the list of all source apps for the org. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-all-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +const filters: string = enabled eq true; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, ge, le* **owner.id**: *eq, in* **enabled**: *eq* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAllSourceAppV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-all-user-apps-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List all user apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-all-user-apps-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const filters: string = name eq "user app name"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAllUserAppsV1(filters); +console.log(result); +``` + +[[Back to top]](#) + +## list-assigned-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List assigned source apps +This API returns the list of source apps assigned for logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-assigned-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) +const filters: string = name eq "source app name"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAssignedSourceAppV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-available-accounts-for-user-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List available accounts for user app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-available-accounts-for-user-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the user app | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the user app +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAvailableAccountsForUserAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-available-source-apps-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List available source apps +This API returns the list of source apps available for access request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-available-source-apps-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +const filters: string = name eq "source app name"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listAvailableSourceAppsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-owned-user-apps-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List owned user apps +This API returns the list of user apps assigned to logged in user + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-owned-user-apps-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "user app name"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listOwnedUserAppsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-source-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch source app by id +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-source-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the source app to patch | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | [optional] + +### Return type + +**SourceapppatchdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the source app to patch +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/enabled","value":true},{"op":"replace","path":"/matchAllAccounts","value":true}]; // (optional) +const result = await apiInstance.patchSourceAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## patch-user-app-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch user app by id +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-user-app-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the user app to patch | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | [optional] + +### Return type + +**UserappV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the user app to patch +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // (optional) +const result = await apiInstance.patchUserAppV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-source-apps-in-bulk-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Bulk update source apps +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-source-apps-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**sourceappbulkupdaterequestV1** | **SourceappbulkupdaterequestV1** | | [optional] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { AppsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AppsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const sourceappbulkupdaterequestV1: SourceappbulkupdaterequestV1 = ; // (optional) +const result = await apiInstance.updateSourceAppsInBulkV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/apps/docs/Methods/Index.md b/sdk-output/apps/docs/Methods/Index.md new file mode 100644 index 00000000..cb5402d2 --- /dev/null +++ b/sdk-output/apps/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: apps-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: apps-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'apps', 'methods'] +slug: /tools/sdk/typescript/apps/methods +tags: ['SDK', 'Software Development Kit', 'apps', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/apps/docs/Models/Accessprofiledetails.md b/sdk-output/apps/docs/Models/Accessprofiledetails.md new file mode 100644 index 00000000..05858f48 --- /dev/null +++ b/sdk-output/apps/docs/Models/Accessprofiledetails.md @@ -0,0 +1,41 @@ +--- +id: v1-accessprofiledetails-v1 +title: AccessprofiledetailsV1 +pagination_label: AccessprofiledetailsV1 +sidebar_label: AccessprofiledetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofiledetailsV1', 'v1AccessprofiledetailsV1'] +slug: /tools/sdk/typescript/apps/models/accessprofiledetails-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofiledetailsV1', 'v1AccessprofiledetailsV1'] +--- + +# AccessprofiledetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the Access Profile | [default to undefined] +**name** | **(optional)** **string** | Name of the Access Profile | [default to undefined] +**description** | **(optional)** **string** | Information about the Access Profile | [default to undefined] +**created** | **(optional)** **string** | Date the Access Profile was created | [default to undefined] +**modified** | **(optional)** **string** | Date the Access Profile was last modified. | [default to undefined] +**disabled** | **(optional)** **boolean** | Whether the Access Profile is enabled. | [default to true] +**requestable** | **(optional)** **boolean** | Whether the Access Profile is requestable via access request. | [default to false] +**_protected** | **(optional)** **boolean** | Whether the Access Profile is protected. | [default to false] +**ownerId** | **(optional)** **string** | The owner ID of the Access Profile | [default to undefined] +**sourceId** | **(optional)** **number** | The source ID of the Access Profile | [default to undefined] +**sourceName** | **(optional)** **string** | The source name of the Access Profile | [default to undefined] +**appId** | **(optional)** **number** | The source app ID of the Access Profile | [default to undefined] +**appName** | **(optional)** **string** | The source app name of the Access Profile | [default to undefined] +**applicationId** | **(optional)** **string** | The id of the application | [default to undefined] +**type** | **(optional)** **string** | The type of the access profile | [default to undefined] +**entitlements** | **(optional)** **Array<string>** | List of IDs of entitlements | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements in the access profile | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Access Profile is assigned. | [default to undefined] +**approvalSchemes** | **(optional)** **string** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [default to undefined] +**revokeRequestApprovalSchemes** | **(optional)** **string** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [default to undefined] +**requestCommentsRequired** | **(optional)** **boolean** | Whether the access profile require request comment for access request. | [default to false] +**deniedCommentsRequired** | **(optional)** **boolean** | Whether denied comment is required when access request is denied. | [default to false] +**accountSelector** | **(optional)** **AccessprofiledetailsAccountSelectorV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/AccessprofiledetailsAccountSelector.md b/sdk-output/apps/docs/Models/AccessprofiledetailsAccountSelector.md new file mode 100644 index 00000000..89dde1c9 --- /dev/null +++ b/sdk-output/apps/docs/Models/AccessprofiledetailsAccountSelector.md @@ -0,0 +1,19 @@ +--- +id: v1-accessprofiledetails-account-selector-v1 +title: AccessprofiledetailsAccountSelectorV1 +pagination_label: AccessprofiledetailsAccountSelectorV1 +sidebar_label: AccessprofiledetailsAccountSelectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofiledetailsAccountSelectorV1', 'v1AccessprofiledetailsAccountSelectorV1'] +slug: /tools/sdk/typescript/apps/models/accessprofiledetails-account-selector-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofiledetailsAccountSelectorV1', 'v1AccessprofiledetailsAccountSelectorV1'] +--- + +# AccessprofiledetailsAccountSelectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selectors** | **(optional)** **Array<AppaccessprofileselectorV1>** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Appaccessprofileselector.md b/sdk-output/apps/docs/Models/Appaccessprofileselector.md new file mode 100644 index 00000000..5d3fb184 --- /dev/null +++ b/sdk-output/apps/docs/Models/Appaccessprofileselector.md @@ -0,0 +1,20 @@ +--- +id: v1-appaccessprofileselector-v1 +title: AppaccessprofileselectorV1 +pagination_label: AppaccessprofileselectorV1 +sidebar_label: AppaccessprofileselectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AppaccessprofileselectorV1', 'v1AppaccessprofileselectorV1'] +slug: /tools/sdk/typescript/apps/models/appaccessprofileselector-v1 +tags: ['SDK', 'Software Development Kit', 'AppaccessprofileselectorV1', 'v1AppaccessprofileselectorV1'] +--- + +# AppaccessprofileselectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationId** | **(optional)** **string** | The application id | [default to undefined] +**accountMatchConfig** | **(optional)** **AppaccessprofileselectorAccountMatchConfigV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfig.md b/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfig.md new file mode 100644 index 00000000..53a0980d --- /dev/null +++ b/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfig.md @@ -0,0 +1,19 @@ +--- +id: v1-appaccessprofileselector-account-match-config-v1 +title: AppaccessprofileselectorAccountMatchConfigV1 +pagination_label: AppaccessprofileselectorAccountMatchConfigV1 +sidebar_label: AppaccessprofileselectorAccountMatchConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AppaccessprofileselectorAccountMatchConfigV1', 'v1AppaccessprofileselectorAccountMatchConfigV1'] +slug: /tools/sdk/typescript/apps/models/appaccessprofileselector-account-match-config-v1 +tags: ['SDK', 'Software Development Kit', 'AppaccessprofileselectorAccountMatchConfigV1', 'v1AppaccessprofileselectorAccountMatchConfigV1'] +--- + +# AppaccessprofileselectorAccountMatchConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**matchExpression** | **(optional)** **AppaccessprofileselectorAccountMatchConfigMatchExpressionV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfigMatchExpression.md b/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfigMatchExpression.md new file mode 100644 index 00000000..83d76c67 --- /dev/null +++ b/sdk-output/apps/docs/Models/AppaccessprofileselectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,20 @@ +--- +id: v1-appaccessprofileselector-account-match-config-match-expression-v1 +title: AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 +pagination_label: AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 +sidebar_label: AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AppaccessprofileselectorAccountMatchConfigMatchExpressionV1', 'v1AppaccessprofileselectorAccountMatchConfigMatchExpressionV1'] +slug: /tools/sdk/typescript/apps/models/appaccessprofileselector-account-match-config-match-expression-v1 +tags: ['SDK', 'Software Development Kit', 'AppaccessprofileselectorAccountMatchConfigMatchExpressionV1', 'v1AppaccessprofileselectorAccountMatchConfigMatchExpressionV1'] +--- + +# AppaccessprofileselectorAccountMatchConfigMatchExpressionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**matchTerms** | **(optional)** **Array<MatchtermV1>** | | [default to undefined] +**and** | **(optional)** **boolean** | If it is AND operators for match terms | [default to true] + diff --git a/sdk-output/apps/docs/Models/Appaccountdetails.md b/sdk-output/apps/docs/Models/Appaccountdetails.md new file mode 100644 index 00000000..f7326be8 --- /dev/null +++ b/sdk-output/apps/docs/Models/Appaccountdetails.md @@ -0,0 +1,21 @@ +--- +id: v1-appaccountdetails-v1 +title: AppaccountdetailsV1 +pagination_label: AppaccountdetailsV1 +sidebar_label: AppaccountdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AppaccountdetailsV1', 'v1AppaccountdetailsV1'] +slug: /tools/sdk/typescript/apps/models/appaccountdetails-v1 +tags: ['SDK', 'Software Development Kit', 'AppaccountdetailsV1', 'v1AppaccountdetailsV1'] +--- + +# AppaccountdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appId** | **(optional)** **string** | The source app ID | [default to undefined] +**appDisplayName** | **(optional)** **string** | The source app display name | [default to undefined] +**sourceAccount** | **(optional)** **AppaccountdetailsSourceAccountV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/AppaccountdetailsSourceAccount.md b/sdk-output/apps/docs/Models/AppaccountdetailsSourceAccount.md new file mode 100644 index 00000000..0bd458e4 --- /dev/null +++ b/sdk-output/apps/docs/Models/AppaccountdetailsSourceAccount.md @@ -0,0 +1,23 @@ +--- +id: v1-appaccountdetails-source-account-v1 +title: AppaccountdetailsSourceAccountV1 +pagination_label: AppaccountdetailsSourceAccountV1 +sidebar_label: AppaccountdetailsSourceAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AppaccountdetailsSourceAccountV1', 'v1AppaccountdetailsSourceAccountV1'] +slug: /tools/sdk/typescript/apps/models/appaccountdetails-source-account-v1 +tags: ['SDK', 'Software Development Kit', 'AppaccountdetailsSourceAccountV1', 'v1AppaccountdetailsSourceAccountV1'] +--- + +# AppaccountdetailsSourceAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The account ID | [default to undefined] +**nativeIdentity** | **(optional)** **string** | The native identity of account | [default to undefined] +**displayName** | **(optional)** **string** | The display name of account | [default to undefined] +**sourceId** | **(optional)** **string** | The source ID of account | [default to undefined] +**sourceDisplayName** | **(optional)** **string** | The source name of account | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/ArrayInner.md b/sdk-output/apps/docs/Models/ArrayInner.md new file mode 100644 index 00000000..c0620021 --- /dev/null +++ b/sdk-output/apps/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/apps/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/apps/docs/Models/Basereferencedto.md b/sdk-output/apps/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..41c7423d --- /dev/null +++ b/sdk-output/apps/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/apps/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Dtotype.md b/sdk-output/apps/docs/Models/Dtotype.md new file mode 100644 index 00000000..ccebbb18 --- /dev/null +++ b/sdk-output/apps/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/apps/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/apps/docs/Models/Errormessagedto.md b/sdk-output/apps/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..5d93db64 --- /dev/null +++ b/sdk-output/apps/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/apps/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Errorresponsedto.md b/sdk-output/apps/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f5e178f4 --- /dev/null +++ b/sdk-output/apps/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/apps/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/GetSourceAppV1401Response.md b/sdk-output/apps/docs/Models/GetSourceAppV1401Response.md new file mode 100644 index 00000000..4660d4f6 --- /dev/null +++ b/sdk-output/apps/docs/Models/GetSourceAppV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-source-app-v1401-response-v1 +title: GetSourceAppV1401ResponseV1 +pagination_label: GetSourceAppV1401ResponseV1 +sidebar_label: GetSourceAppV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSourceAppV1401ResponseV1', 'v1GetSourceAppV1401ResponseV1'] +slug: /tools/sdk/typescript/apps/models/get-source-app-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSourceAppV1401ResponseV1', 'v1GetSourceAppV1401ResponseV1'] +--- + +# GetSourceAppV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/GetSourceAppV1429Response.md b/sdk-output/apps/docs/Models/GetSourceAppV1429Response.md new file mode 100644 index 00000000..f9bbef3d --- /dev/null +++ b/sdk-output/apps/docs/Models/GetSourceAppV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-source-app-v1429-response-v1 +title: GetSourceAppV1429ResponseV1 +pagination_label: GetSourceAppV1429ResponseV1 +sidebar_label: GetSourceAppV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSourceAppV1429ResponseV1', 'v1GetSourceAppV1429ResponseV1'] +slug: /tools/sdk/typescript/apps/models/get-source-app-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSourceAppV1429ResponseV1', 'v1GetSourceAppV1429ResponseV1'] +--- + +# GetSourceAppV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Index.md b/sdk-output/apps/docs/Models/Index.md new file mode 100644 index 00000000..2c63e758 --- /dev/null +++ b/sdk-output/apps/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: apps-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: apps-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'apps', 'models'] +slug: /tools/sdk/typescript/apps/models +tags: ['SDK', 'Software Development Kit', 'apps', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/apps/docs/Models/Jsonpatchoperation.md b/sdk-output/apps/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..0a9c5aee --- /dev/null +++ b/sdk-output/apps/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/apps/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/JsonpatchoperationValue.md b/sdk-output/apps/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..51f5b1d8 --- /dev/null +++ b/sdk-output/apps/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/apps/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/apps/docs/Models/Localeorigin.md b/sdk-output/apps/docs/Models/Localeorigin.md new file mode 100644 index 00000000..62adfc82 --- /dev/null +++ b/sdk-output/apps/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/apps/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/apps/docs/Models/Matchterm.md b/sdk-output/apps/docs/Models/Matchterm.md new file mode 100644 index 00000000..ae275487 --- /dev/null +++ b/sdk-output/apps/docs/Models/Matchterm.md @@ -0,0 +1,24 @@ +--- +id: v1-matchterm-v1 +title: MatchtermV1 +pagination_label: MatchtermV1 +sidebar_label: MatchtermV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MatchtermV1', 'v1MatchtermV1'] +slug: /tools/sdk/typescript/apps/models/matchterm-v1 +tags: ['SDK', 'Software Development Kit', 'MatchtermV1', 'v1MatchtermV1'] +--- + +# MatchtermV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The attribute name | [default to undefined] +**value** | **(optional)** **string** | The attribute value | [default to undefined] +**op** | **(optional)** **string** | The operator between name and value | [default to undefined] +**container** | **(optional)** **boolean** | If it is a container or a real match term | [default to false] +**and** | **(optional)** **boolean** | If it is AND logical operator for the children match terms | [default to false] +**children** | **(optional)** **Array<{ [key: string]: any; }>** | The children under this match term | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/README.md b/sdk-output/apps/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/apps/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/apps/docs/Models/Sourceapp.md b/sdk-output/apps/docs/Models/Sourceapp.md new file mode 100644 index 00000000..f4ec9560 --- /dev/null +++ b/sdk-output/apps/docs/Models/Sourceapp.md @@ -0,0 +1,30 @@ +--- +id: v1-sourceapp-v1 +title: SourceappV1 +pagination_label: SourceappV1 +sidebar_label: SourceappV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceappV1', 'v1SourceappV1'] +slug: /tools/sdk/typescript/apps/models/sourceapp-v1 +tags: ['SDK', 'Software Development Kit', 'SourceappV1', 'v1SourceappV1'] +--- + +# SourceappV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source app id | [default to undefined] +**cloudAppId** | **(optional)** **string** | The deprecated source app id | [default to undefined] +**name** | **(optional)** **string** | The source app name | [default to undefined] +**created** | **(optional)** **string** | Time when the source app was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the source app was last modified | [default to undefined] +**enabled** | **(optional)** **boolean** | True if the source app is enabled | [default to false] +**provisionRequestEnabled** | **(optional)** **boolean** | True if the app allows access request | [default to false] +**description** | **(optional)** **string** | The description of the source app | [default to undefined] +**matchAllAccounts** | **(optional)** **boolean** | True if the source app match all accounts | [default to false] +**appCenterEnabled** | **(optional)** **boolean** | True if the app is visible in the request center | [default to true] +**accountSource** | **(optional)** **SourceappAccountSourceV1** | | [default to undefined] +**owner** | **(optional)** **BasereferencedtoV1** | The owner of source app | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/SourceappAccountSource.md b/sdk-output/apps/docs/Models/SourceappAccountSource.md new file mode 100644 index 00000000..de375dc8 --- /dev/null +++ b/sdk-output/apps/docs/Models/SourceappAccountSource.md @@ -0,0 +1,23 @@ +--- +id: v1-sourceapp-account-source-v1 +title: SourceappAccountSourceV1 +pagination_label: SourceappAccountSourceV1 +sidebar_label: SourceappAccountSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceappAccountSourceV1', 'v1SourceappAccountSourceV1'] +slug: /tools/sdk/typescript/apps/models/sourceapp-account-source-v1 +tags: ['SDK', 'Software Development Kit', 'SourceappAccountSourceV1', 'v1SourceappAccountSourceV1'] +--- + +# SourceappAccountSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] +**useForPasswordManagement** | **(optional)** **boolean** | If the source is used for password management | [default to false] +**passwordPolicies** | **(optional)** **Array<BasereferencedtoV1>** | The password policies for the source | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Sourceappbulkupdaterequest.md b/sdk-output/apps/docs/Models/Sourceappbulkupdaterequest.md new file mode 100644 index 00000000..9e9ca028 --- /dev/null +++ b/sdk-output/apps/docs/Models/Sourceappbulkupdaterequest.md @@ -0,0 +1,20 @@ +--- +id: v1-sourceappbulkupdaterequest-v1 +title: SourceappbulkupdaterequestV1 +pagination_label: SourceappbulkupdaterequestV1 +sidebar_label: SourceappbulkupdaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceappbulkupdaterequestV1', 'v1SourceappbulkupdaterequestV1'] +slug: /tools/sdk/typescript/apps/models/sourceappbulkupdaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'SourceappbulkupdaterequestV1', 'v1SourceappbulkupdaterequestV1'] +--- + +# SourceappbulkupdaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appIds** | **Array<string>** | List of source app ids to update | [default to undefined] +**jsonPatch** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the source app. | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Sourceappcreatedto.md b/sdk-output/apps/docs/Models/Sourceappcreatedto.md new file mode 100644 index 00000000..add2bd20 --- /dev/null +++ b/sdk-output/apps/docs/Models/Sourceappcreatedto.md @@ -0,0 +1,22 @@ +--- +id: v1-sourceappcreatedto-v1 +title: SourceappcreatedtoV1 +pagination_label: SourceappcreatedtoV1 +sidebar_label: SourceappcreatedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceappcreatedtoV1', 'v1SourceappcreatedtoV1'] +slug: /tools/sdk/typescript/apps/models/sourceappcreatedto-v1 +tags: ['SDK', 'Software Development Kit', 'SourceappcreatedtoV1', 'v1SourceappcreatedtoV1'] +--- + +# SourceappcreatedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The source app name | [default to undefined] +**description** | **string** | The description of the source app | [default to undefined] +**matchAllAccounts** | **(optional)** **boolean** | True if the source app match all accounts | [default to false] +**accountSource** | **SourceappcreatedtoAccountSourceV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/SourceappcreatedtoAccountSource.md b/sdk-output/apps/docs/Models/SourceappcreatedtoAccountSource.md new file mode 100644 index 00000000..71771c67 --- /dev/null +++ b/sdk-output/apps/docs/Models/SourceappcreatedtoAccountSource.md @@ -0,0 +1,21 @@ +--- +id: v1-sourceappcreatedto-account-source-v1 +title: SourceappcreatedtoAccountSourceV1 +pagination_label: SourceappcreatedtoAccountSourceV1 +sidebar_label: SourceappcreatedtoAccountSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceappcreatedtoAccountSourceV1', 'v1SourceappcreatedtoAccountSourceV1'] +slug: /tools/sdk/typescript/apps/models/sourceappcreatedto-account-source-v1 +tags: ['SDK', 'Software Development Kit', 'SourceappcreatedtoAccountSourceV1', 'v1SourceappcreatedtoAccountSourceV1'] +--- + +# SourceappcreatedtoAccountSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Sourceapppatchdto.md b/sdk-output/apps/docs/Models/Sourceapppatchdto.md new file mode 100644 index 00000000..dc4bf88e --- /dev/null +++ b/sdk-output/apps/docs/Models/Sourceapppatchdto.md @@ -0,0 +1,31 @@ +--- +id: v1-sourceapppatchdto-v1 +title: SourceapppatchdtoV1 +pagination_label: SourceapppatchdtoV1 +sidebar_label: SourceapppatchdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceapppatchdtoV1', 'v1SourceapppatchdtoV1'] +slug: /tools/sdk/typescript/apps/models/sourceapppatchdto-v1 +tags: ['SDK', 'Software Development Kit', 'SourceapppatchdtoV1', 'v1SourceapppatchdtoV1'] +--- + +# SourceapppatchdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source app id | [default to undefined] +**cloudAppId** | **(optional)** **string** | The deprecated source app id | [default to undefined] +**name** | **(optional)** **string** | The source app name | [default to undefined] +**created** | **(optional)** **string** | Time when the source app was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the source app was last modified | [default to undefined] +**enabled** | **(optional)** **boolean** | True if the source app is enabled | [default to false] +**provisionRequestEnabled** | **(optional)** **boolean** | True if the app allows access request | [default to false] +**description** | **(optional)** **string** | The description of the source app | [default to undefined] +**matchAllAccounts** | **(optional)** **boolean** | True if the source app match all accounts | [default to false] +**appCenterEnabled** | **(optional)** **boolean** | True if the app is visible in the request center | [default to true] +**accessProfiles** | **(optional)** **Array<string>** | List of IDs of access profiles | [default to undefined] +**accountSource** | **(optional)** **SourceappAccountSourceV1** | | [default to undefined] +**owner** | **(optional)** **BasereferencedtoV1** | The owner of source app | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/Userapp.md b/sdk-output/apps/docs/Models/Userapp.md new file mode 100644 index 00000000..fa416291 --- /dev/null +++ b/sdk-output/apps/docs/Models/Userapp.md @@ -0,0 +1,29 @@ +--- +id: v1-userapp-v1 +title: UserappV1 +pagination_label: UserappV1 +sidebar_label: UserappV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserappV1', 'v1UserappV1'] +slug: /tools/sdk/typescript/apps/models/userapp-v1 +tags: ['SDK', 'Software Development Kit', 'UserappV1', 'v1UserappV1'] +--- + +# UserappV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The user app id | [default to undefined] +**created** | **(optional)** **string** | Time when the user app was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the user app was last modified | [default to undefined] +**hasMultipleAccounts** | **(optional)** **boolean** | True if the owner has multiple accounts for the source | [default to false] +**useForPasswordManagement** | **(optional)** **boolean** | True if the source has password feature | [default to false] +**provisionRequestEnabled** | **(optional)** **boolean** | True if the app allows access request | [default to false] +**appCenterEnabled** | **(optional)** **boolean** | True if the app is visible in the request center | [default to true] +**sourceApp** | **(optional)** **UserappSourceAppV1** | | [default to undefined] +**source** | **(optional)** **UserappSourceV1** | | [default to undefined] +**account** | **(optional)** **UserappAccountV1** | | [default to undefined] +**owner** | **(optional)** **UserappOwnerV1** | | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/UserappAccount.md b/sdk-output/apps/docs/Models/UserappAccount.md new file mode 100644 index 00000000..e6d30928 --- /dev/null +++ b/sdk-output/apps/docs/Models/UserappAccount.md @@ -0,0 +1,21 @@ +--- +id: v1-userapp-account-v1 +title: UserappAccountV1 +pagination_label: UserappAccountV1 +sidebar_label: UserappAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserappAccountV1', 'v1UserappAccountV1'] +slug: /tools/sdk/typescript/apps/models/userapp-account-v1 +tags: ['SDK', 'Software Development Kit', 'UserappAccountV1', 'v1UserappAccountV1'] +--- + +# UserappAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the account ID | [default to undefined] +**type** | **(optional)** **string** | It will always be \"ACCOUNT\" | [default to undefined] +**name** | **(optional)** **string** | the account name | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/UserappOwner.md b/sdk-output/apps/docs/Models/UserappOwner.md new file mode 100644 index 00000000..51d94942 --- /dev/null +++ b/sdk-output/apps/docs/Models/UserappOwner.md @@ -0,0 +1,22 @@ +--- +id: v1-userapp-owner-v1 +title: UserappOwnerV1 +pagination_label: UserappOwnerV1 +sidebar_label: UserappOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserappOwnerV1', 'v1UserappOwnerV1'] +slug: /tools/sdk/typescript/apps/models/userapp-owner-v1 +tags: ['SDK', 'Software Development Kit', 'UserappOwnerV1', 'v1UserappOwnerV1'] +--- + +# UserappOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | It will always be \"IDENTITY\" | [default to undefined] +**name** | **(optional)** **string** | The identity name | [default to undefined] +**alias** | **(optional)** **string** | The identity alias | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/UserappSource.md b/sdk-output/apps/docs/Models/UserappSource.md new file mode 100644 index 00000000..26d1a7fd --- /dev/null +++ b/sdk-output/apps/docs/Models/UserappSource.md @@ -0,0 +1,21 @@ +--- +id: v1-userapp-source-v1 +title: UserappSourceV1 +pagination_label: UserappSourceV1 +sidebar_label: UserappSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserappSourceV1', 'v1UserappSourceV1'] +slug: /tools/sdk/typescript/apps/models/userapp-source-v1 +tags: ['SDK', 'Software Development Kit', 'UserappSourceV1', 'v1UserappSourceV1'] +--- + +# UserappSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the source ID | [default to undefined] +**type** | **(optional)** **string** | It will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | the source name | [default to undefined] + diff --git a/sdk-output/apps/docs/Models/UserappSourceApp.md b/sdk-output/apps/docs/Models/UserappSourceApp.md new file mode 100644 index 00000000..dca787d5 --- /dev/null +++ b/sdk-output/apps/docs/Models/UserappSourceApp.md @@ -0,0 +1,21 @@ +--- +id: v1-userapp-source-app-v1 +title: UserappSourceAppV1 +pagination_label: UserappSourceAppV1 +sidebar_label: UserappSourceAppV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserappSourceAppV1', 'v1UserappSourceAppV1'] +slug: /tools/sdk/typescript/apps/models/userapp-source-app-v1 +tags: ['SDK', 'Software Development Kit', 'UserappSourceAppV1', 'v1UserappSourceAppV1'] +--- + +# UserappSourceAppV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the source app ID | [default to undefined] +**type** | **(optional)** **string** | It will always be \"APPLICATION\" | [default to undefined] +**name** | **(optional)** **string** | the source app name | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/auth_profile/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5aef58ff --- /dev/null +++ b/sdk-output/auth_profile/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,48 @@ +- path: /auth-profiles/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/auth_profile/methods/auth-profile#get-profile-config-list-v1 + source: | + import { AuthProfileV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AuthProfileV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getProfileConfigListV1(); + console.log(result); +- path: /auth-profiles/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/auth_profile/methods/auth-profile#get-profile-config-v1 + source: | + import { AuthProfileV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AuthProfileV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Auth Profile to patch. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getProfileConfigV1(id); + console.log(result); +- path: /auth-profiles/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/auth_profile/methods/auth-profile#patch-profile-config-v1 + source: | + import { AuthProfileV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AuthProfileV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Auth Profile to patch. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchProfileConfigV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/auth_profile/docs/Methods/AuthProfileV1Api.md b/sdk-output/auth_profile/docs/Methods/AuthProfileV1Api.md new file mode 100644 index 00000000..2279238f --- /dev/null +++ b/sdk-output/auth_profile/docs/Methods/AuthProfileV1Api.md @@ -0,0 +1,158 @@ +--- +id: v1-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthProfile', 'v1AuthProfile'] +slug: /tools/sdk/typescript/auth_profile/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'v1AuthProfile'] +--- + +# AuthProfileV1Api + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-profile-config-list-v1**](#get-profile-config-list-v1) | **GET** `/auth-profiles/v1` | Get list of auth profiles +[**get-profile-config-v1**](#get-profile-config-v1) | **GET** `/auth-profiles/v1/{id}` | Get auth profile +[**patch-profile-config-v1**](#patch-profile-config-v1) | **PATCH** `/auth-profiles/v1/{id}` | Patch a specified auth profile + + +## get-profile-config-list-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get list of auth profiles +This API returns a list of auth profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-profile-config-list-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AuthProfileV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AuthProfileV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getProfileConfigListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-profile-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get auth profile +This API returns auth profile information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-profile-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Auth Profile to patch. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AuthprofileV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AuthProfileV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AuthProfileV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of the Auth Profile to patch. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getProfileConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## patch-profile-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch a specified auth profile +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-profile-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Auth Profile to patch. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AuthprofileV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AuthProfileV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AuthProfileV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of the Auth Profile to patch. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchProfileConfigV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/auth_profile/docs/Methods/Index.md b/sdk-output/auth_profile/docs/Methods/Index.md new file mode 100644 index 00000000..290f0dca --- /dev/null +++ b/sdk-output/auth_profile/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: auth_profile-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: auth_profile-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'auth_profile', 'methods'] +slug: /tools/sdk/typescript/auth_profile/methods +tags: ['SDK', 'Software Development Kit', 'auth_profile', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/auth_profile/docs/Models/ArrayInner.md b/sdk-output/auth_profile/docs/Models/ArrayInner.md new file mode 100644 index 00000000..04d659ab --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/auth_profile/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/auth_profile/docs/Models/Authprofile.md b/sdk-output/auth_profile/docs/Models/Authprofile.md new file mode 100644 index 00000000..2383e424 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Authprofile.md @@ -0,0 +1,25 @@ +--- +id: v1-authprofile-v1 +title: AuthprofileV1 +pagination_label: AuthprofileV1 +sidebar_label: AuthprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthprofileV1', 'v1AuthprofileV1'] +slug: /tools/sdk/typescript/auth_profile/models/authprofile-v1 +tags: ['SDK', 'Software Development Kit', 'AuthprofileV1', 'v1AuthprofileV1'] +--- + +# AuthprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Authentication Profile name. | [default to undefined] +**offNetwork** | **(optional)** **boolean** | Use it to block access from off network. | [default to false] +**untrustedGeography** | **(optional)** **boolean** | Use it to block access from untrusted geoographies. | [default to false] +**applicationId** | **(optional)** **string** | Application ID. | [default to undefined] +**applicationName** | **(optional)** **string** | Application name. | [default to undefined] +**type** | **(optional)** **string** | Type of the Authentication Profile. | [default to undefined] +**strongAuthLogin** | **(optional)** **boolean** | Use it to enable strong authentication. | [default to false] + diff --git a/sdk-output/auth_profile/docs/Models/Authprofilesummary.md b/sdk-output/auth_profile/docs/Models/Authprofilesummary.md new file mode 100644 index 00000000..68d25571 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Authprofilesummary.md @@ -0,0 +1,20 @@ +--- +id: v1-authprofilesummary-v1 +title: AuthprofilesummaryV1 +pagination_label: AuthprofilesummaryV1 +sidebar_label: AuthprofilesummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthprofilesummaryV1', 'v1AuthprofilesummaryV1'] +slug: /tools/sdk/typescript/auth_profile/models/authprofilesummary-v1 +tags: ['SDK', 'Software Development Kit', 'AuthprofilesummaryV1', 'v1AuthprofilesummaryV1'] +--- + +# AuthprofilesummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **(optional)** **string** | Tenant name. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/Errormessagedto.md b/sdk-output/auth_profile/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..3a6c504e --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/auth_profile/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/Errorresponsedto.md b/sdk-output/auth_profile/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..bcafcaeb --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/auth_profile/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1401Response.md b/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1401Response.md new file mode 100644 index 00000000..a4ffd474 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-profile-config-list-v1401-response-v1 +title: GetProfileConfigListV1401ResponseV1 +pagination_label: GetProfileConfigListV1401ResponseV1 +sidebar_label: GetProfileConfigListV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetProfileConfigListV1401ResponseV1', 'v1GetProfileConfigListV1401ResponseV1'] +slug: /tools/sdk/typescript/auth_profile/models/get-profile-config-list-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetProfileConfigListV1401ResponseV1', 'v1GetProfileConfigListV1401ResponseV1'] +--- + +# GetProfileConfigListV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1429Response.md b/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1429Response.md new file mode 100644 index 00000000..e85a3e47 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/GetProfileConfigListV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-profile-config-list-v1429-response-v1 +title: GetProfileConfigListV1429ResponseV1 +pagination_label: GetProfileConfigListV1429ResponseV1 +sidebar_label: GetProfileConfigListV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetProfileConfigListV1429ResponseV1', 'v1GetProfileConfigListV1429ResponseV1'] +slug: /tools/sdk/typescript/auth_profile/models/get-profile-config-list-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetProfileConfigListV1429ResponseV1', 'v1GetProfileConfigListV1429ResponseV1'] +--- + +# GetProfileConfigListV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/Index.md b/sdk-output/auth_profile/docs/Models/Index.md new file mode 100644 index 00000000..eeb5f47b --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: auth_profile-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: auth_profile-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'auth_profile', 'models'] +slug: /tools/sdk/typescript/auth_profile/models +tags: ['SDK', 'Software Development Kit', 'auth_profile', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/auth_profile/docs/Models/Jsonpatchoperation.md b/sdk-output/auth_profile/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..12e44c66 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/auth_profile/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/auth_profile/docs/Models/JsonpatchoperationValue.md b/sdk-output/auth_profile/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..6ffa0a1a --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/auth_profile/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/auth_profile/docs/Models/Localeorigin.md b/sdk-output/auth_profile/docs/Models/Localeorigin.md new file mode 100644 index 00000000..5f2234be --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/auth_profile/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/auth_profile/docs/Models/README.md b/sdk-output/auth_profile/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/auth_profile/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/auth_users/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/auth_users/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a94b6838 --- /dev/null +++ b/sdk-output/auth_users/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,31 @@ +- path: /auth-users/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/auth_users/methods/auth-users#get-auth-user-v1 + source: | + import { AuthUsersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AuthUsersV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity ID (default to undefined) + const result = await apiInstance.getAuthUserV1(id); + console.log(result); +- path: /auth-users/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/auth_users/methods/auth-users#patch-auth-user-v1 + source: | + import { AuthUsersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new AuthUsersV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity ID (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/capabilities","value":["ORG_ADMIN"]}]; // Array | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.patchAuthUserV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/auth_users/docs/Methods/AuthUsersV1Api.md b/sdk-output/auth_users/docs/Methods/AuthUsersV1Api.md new file mode 100644 index 00000000..43b918a7 --- /dev/null +++ b/sdk-output/auth_users/docs/Methods/AuthUsersV1Api.md @@ -0,0 +1,108 @@ +--- +id: v1-auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthUsers', 'v1AuthUsers'] +slug: /tools/sdk/typescript/auth_users/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'v1AuthUsers'] +--- + +# AuthUsersV1Api + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-auth-user-v1**](#get-auth-user-v1) | **GET** `/auth-users/v1/{id}` | Auth user details +[**patch-auth-user-v1**](#patch-auth-user-v1) | **PATCH** `/auth-users/v1/{id}` | Auth user update + + +## get-auth-user-v1 +Auth user details +Return the specified user's authentication system details. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auth-user-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity ID | [default to undefined] + +### Return type + +**AuthuserV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { AuthUsersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AuthUsersV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity ID +const result = await apiInstance.getAuthUserV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## patch-auth-user-v1 +Auth user update +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-auth-user-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity ID | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**AuthuserV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { AuthUsersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new AuthUsersV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity ID +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/capabilities","value":["ORG_ADMIN"]}]; // A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.patchAuthUserV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/auth_users/docs/Methods/Index.md b/sdk-output/auth_users/docs/Methods/Index.md new file mode 100644 index 00000000..3fbf409d --- /dev/null +++ b/sdk-output/auth_users/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: auth_users-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: auth_users-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'auth_users', 'methods'] +slug: /tools/sdk/typescript/auth_users/methods +tags: ['SDK', 'Software Development Kit', 'auth_users', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/auth_users/docs/Models/ArrayInner.md b/sdk-output/auth_users/docs/Models/ArrayInner.md new file mode 100644 index 00000000..79c5ad06 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/auth_users/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/auth_users/docs/Models/Authuser.md b/sdk-output/auth_users/docs/Models/Authuser.md new file mode 100644 index 00000000..6859b88c --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Authuser.md @@ -0,0 +1,36 @@ +--- +id: v1-authuser-v1 +title: AuthuserV1 +pagination_label: AuthuserV1 +sidebar_label: AuthuserV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthuserV1', 'v1AuthuserV1'] +slug: /tools/sdk/typescript/auth_users/models/authuser-v1 +tags: ['SDK', 'Software Development Kit', 'AuthuserV1', 'v1AuthuserV1'] +--- + +# AuthuserV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenant** | **(optional)** **string** | Tenant name. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**uid** | **(optional)** **string** | Identity\'s unique identitifier. | [default to undefined] +**profile** | **(optional)** **string** | ID of the auth profile associated with the auth user. | [default to undefined] +**identificationNumber** | **(optional)** **string** | Auth user\'s employee number. | [default to undefined] +**email** | **(optional)** **string** | Auth user\'s email. | [default to undefined] +**phone** | **(optional)** **string** | Auth user\'s phone number. | [default to undefined] +**workPhone** | **(optional)** **string** | Auth user\'s work phone number. | [default to undefined] +**personalEmail** | **(optional)** **string** | Auth user\'s personal email. | [default to undefined] +**firstname** | **(optional)** **string** | Auth user\'s first name. | [default to undefined] +**lastname** | **(optional)** **string** | Auth user\'s last name. | [default to undefined] +**displayName** | **(optional)** **string** | Auth user\'s name in displayed format. | [default to undefined] +**alias** | **(optional)** **string** | Auth user\'s alias. | [default to undefined] +**lastPasswordChangeDate** | **(optional)** **string** | Date of last password change. | [default to undefined] +**lastLoginTimestamp** | **(optional)** **number** | Timestamp of the last login (long type value). | [default to undefined] +**currentLoginTimestamp** | **(optional)** **number** | Timestamp of the current login (long type value). | [default to undefined] +**lastUnlockTimestamp** | **(optional)** **string** | The date and time when the user was last unlocked. | [default to undefined] +**capabilities** | **(optional)** **Array<string>** | Array of the auth user\'s capabilities. | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/Errormessagedto.md b/sdk-output/auth_users/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..f906add8 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/auth_users/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/Errorresponsedto.md b/sdk-output/auth_users/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..855dc899 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/auth_users/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/GetAuthUserV1401Response.md b/sdk-output/auth_users/docs/Models/GetAuthUserV1401Response.md new file mode 100644 index 00000000..449a1a33 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/GetAuthUserV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auth-user-v1401-response-v1 +title: GetAuthUserV1401ResponseV1 +pagination_label: GetAuthUserV1401ResponseV1 +sidebar_label: GetAuthUserV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAuthUserV1401ResponseV1', 'v1GetAuthUserV1401ResponseV1'] +slug: /tools/sdk/typescript/auth_users/models/get-auth-user-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAuthUserV1401ResponseV1', 'v1GetAuthUserV1401ResponseV1'] +--- + +# GetAuthUserV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/GetAuthUserV1429Response.md b/sdk-output/auth_users/docs/Models/GetAuthUserV1429Response.md new file mode 100644 index 00000000..396b2041 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/GetAuthUserV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auth-user-v1429-response-v1 +title: GetAuthUserV1429ResponseV1 +pagination_label: GetAuthUserV1429ResponseV1 +sidebar_label: GetAuthUserV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAuthUserV1429ResponseV1', 'v1GetAuthUserV1429ResponseV1'] +slug: /tools/sdk/typescript/auth_users/models/get-auth-user-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAuthUserV1429ResponseV1', 'v1GetAuthUserV1429ResponseV1'] +--- + +# GetAuthUserV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/Index.md b/sdk-output/auth_users/docs/Models/Index.md new file mode 100644 index 00000000..42960a45 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: auth_users-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: auth_users-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'auth_users', 'models'] +slug: /tools/sdk/typescript/auth_users/models +tags: ['SDK', 'Software Development Kit', 'auth_users', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/auth_users/docs/Models/Jsonpatchoperation.md b/sdk-output/auth_users/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..8f6cf427 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/auth_users/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/auth_users/docs/Models/JsonpatchoperationValue.md b/sdk-output/auth_users/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..7ad1e66e --- /dev/null +++ b/sdk-output/auth_users/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/auth_users/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/auth_users/docs/Models/Localeorigin.md b/sdk-output/auth_users/docs/Models/Localeorigin.md new file mode 100644 index 00000000..b16a8226 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/auth_users/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/auth_users/docs/Models/README.md b/sdk-output/auth_users/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/auth_users/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/branding/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/branding/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..6ab19a73 --- /dev/null +++ b/sdk-output/branding/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,89 @@ +- path: /brandings/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/branding/methods/branding#create-branding-item-v1 + source: | + import { BrandingV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new BrandingV1Api(configuration); + const name: string = 'name_example'; // string | name of branding item (default to undefined) + const productName: string = 'productName_example'; // string | product name (default to undefined) + const actionButtonColor: string = 'actionButtonColor_example'; // string | hex value of color for action button (optional) (default to undefined) + const activeLinkColor: string = 'activeLinkColor_example'; // string | hex value of color for link (optional) (default to undefined) + const navigationColor: string = 'navigationColor_example'; // string | hex value of color for navigation bar (optional) (default to undefined) + const emailFromAddress: string = 'emailFromAddress_example'; // string | email from address (optional) (default to undefined) + const loginInformationalMessage: string = 'loginInformationalMessage_example'; // string | login information message (optional) (default to undefined) + const fileStandard: File = BINARY_DATA_HERE; // File | png file with logo (optional) (default to undefined) + const result = await apiInstance.createBrandingItemV1(name, productName); + console.log(result); +- path: /brandings/v1/{name} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/branding/methods/branding#delete-branding-v1 + source: | + import { BrandingV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new BrandingV1Api(configuration); + const name: string = 'default'; // string | The name of the branding item to be deleted (default to undefined) + const result = await apiInstance.deleteBrandingV1(name); + console.log(result); +- path: /brandings/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/branding/methods/branding#get-branding-list-v1 + source: | + import { BrandingV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new BrandingV1Api(configuration); + const result = await apiInstance.getBrandingListV1(); + console.log(result); +- path: /brandings/v1/{name} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/branding/methods/branding#get-branding-v1 + source: | + import { BrandingV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new BrandingV1Api(configuration); + const name: string = 'default'; // string | The name of the branding item to be retrieved (default to undefined) + const result = await apiInstance.getBrandingV1(name); + console.log(result); +- path: /brandings/v1/{name} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/branding/methods/branding#set-branding-item-v1 + source: | + import { BrandingV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new BrandingV1Api(configuration); + const name: string = 'default'; // string | The name of the branding item to be retrieved (default to undefined) + const name2: string = 'name_example'; // string | name of branding item (default to undefined) + const productName: string = 'productName_example'; // string | product name (default to undefined) + const actionButtonColor: string = 'actionButtonColor_example'; // string | hex value of color for action button (optional) (default to undefined) + const activeLinkColor: string = 'activeLinkColor_example'; // string | hex value of color for link (optional) (default to undefined) + const navigationColor: string = 'navigationColor_example'; // string | hex value of color for navigation bar (optional) (default to undefined) + const emailFromAddress: string = 'emailFromAddress_example'; // string | email from address (optional) (default to undefined) + const loginInformationalMessage: string = 'loginInformationalMessage_example'; // string | login information message (optional) (default to undefined) + const fileStandard: File = BINARY_DATA_HERE; // File | png file with logo (optional) (default to undefined) + const result = await apiInstance.setBrandingItemV1(name, name2, productName); + console.log(result); diff --git a/sdk-output/branding/docs/Methods/BrandingV1Api.md b/sdk-output/branding/docs/Methods/BrandingV1Api.md new file mode 100644 index 00000000..78f18f45 --- /dev/null +++ b/sdk-output/branding/docs/Methods/BrandingV1Api.md @@ -0,0 +1,245 @@ +--- +id: v1-branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Branding', 'v1Branding'] +slug: /tools/sdk/typescript/branding/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'v1Branding'] +--- + +# BrandingV1Api + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certs/reviewing/index.html) for more information about certifications. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-branding-item-v1**](#create-branding-item-v1) | **POST** `/brandings/v1` | Create a branding item +[**delete-branding-v1**](#delete-branding-v1) | **DELETE** `/brandings/v1/{name}` | Delete a branding item +[**get-branding-list-v1**](#get-branding-list-v1) | **GET** `/brandings/v1` | List of branding items +[**get-branding-v1**](#get-branding-v1) | **GET** `/brandings/v1/{name}` | Get a branding item +[**set-branding-item-v1**](#set-branding-item-v1) | **PUT** `/brandings/v1/{name}` | Update a branding item + + +## create-branding-item-v1 +Create a branding item +This API endpoint creates a branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-branding-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | name of branding item | [default to undefined] +**productName** | **string** | product name | [default to undefined] +**actionButtonColor** | **string** | hex value of color for action button | [optional] [default to undefined] +**activeLinkColor** | **string** | hex value of color for link | [optional] [default to undefined] +**navigationColor** | **string** | hex value of color for navigation bar | [optional] [default to undefined] +**emailFromAddress** | **string** | email from address | [optional] [default to undefined] +**loginInformationalMessage** | **string** | login information message | [optional] [default to undefined] +**fileStandard** | **File** | png file with logo | [optional] [default to undefined] + +### Return type + +**BrandingitemV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { BrandingV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new BrandingV1Api(configuration); +const name: string = name_example; // name of branding item +const productName: string = productName_example; // product name +const actionButtonColor: string = actionButtonColor_example; // hex value of color for action button (optional) +const activeLinkColor: string = activeLinkColor_example; // hex value of color for link (optional) +const navigationColor: string = navigationColor_example; // hex value of color for navigation bar (optional) +const emailFromAddress: string = emailFromAddress_example; // email from address (optional) +const loginInformationalMessage: string = loginInformationalMessage_example; // login information message (optional) +const fileStandard: File = BINARY_DATA_HERE; // png file with logo (optional) +const result = await apiInstance.createBrandingItemV1(name, productName); +console.log(result); +``` + +[[Back to top]](#) + +## delete-branding-v1 +Delete a branding item +This API endpoint delete information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-branding-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The name of the branding item to be deleted | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { BrandingV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new BrandingV1Api(configuration); +const name: string = default; // The name of the branding item to be deleted +const result = await apiInstance.deleteBrandingV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## get-branding-list-v1 +List of branding items +This API endpoint returns a list of branding items. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-branding-list-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { BrandingV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new BrandingV1Api(configuration); +const result = await apiInstance.getBrandingListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-branding-v1 +Get a branding item +This API endpoint retrieves information for an existing branding item by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-branding-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The name of the branding item to be retrieved | [default to undefined] + +### Return type + +**BrandingitemV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { BrandingV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new BrandingV1Api(configuration); +const name: string = default; // The name of the branding item to be retrieved +const result = await apiInstance.getBrandingV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## set-branding-item-v1 +Update a branding item +This API endpoint updates information for an existing branding item. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-branding-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The name of the branding item to be retrieved | [default to undefined] +**name2** | **string** | name of branding item | [default to undefined] +**productName** | **string** | product name | [default to undefined] +**actionButtonColor** | **string** | hex value of color for action button | [optional] [default to undefined] +**activeLinkColor** | **string** | hex value of color for link | [optional] [default to undefined] +**navigationColor** | **string** | hex value of color for navigation bar | [optional] [default to undefined] +**emailFromAddress** | **string** | email from address | [optional] [default to undefined] +**loginInformationalMessage** | **string** | login information message | [optional] [default to undefined] +**fileStandard** | **File** | png file with logo | [optional] [default to undefined] + +### Return type + +**BrandingitemV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { BrandingV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new BrandingV1Api(configuration); +const name: string = default; // The name of the branding item to be retrieved +const name2: string = name_example; // name of branding item +const productName: string = productName_example; // product name +const actionButtonColor: string = actionButtonColor_example; // hex value of color for action button (optional) +const activeLinkColor: string = activeLinkColor_example; // hex value of color for link (optional) +const navigationColor: string = navigationColor_example; // hex value of color for navigation bar (optional) +const emailFromAddress: string = emailFromAddress_example; // email from address (optional) +const loginInformationalMessage: string = loginInformationalMessage_example; // login information message (optional) +const fileStandard: File = BINARY_DATA_HERE; // png file with logo (optional) +const result = await apiInstance.setBrandingItemV1(name, name2, productName); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/branding/docs/Methods/Index.md b/sdk-output/branding/docs/Methods/Index.md new file mode 100644 index 00000000..0d722a8c --- /dev/null +++ b/sdk-output/branding/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: branding-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: branding-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'branding', 'methods'] +slug: /tools/sdk/typescript/branding/methods +tags: ['SDK', 'Software Development Kit', 'branding', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/branding/docs/Models/Brandingitem.md b/sdk-output/branding/docs/Models/Brandingitem.md new file mode 100644 index 00000000..abaabca4 --- /dev/null +++ b/sdk-output/branding/docs/Models/Brandingitem.md @@ -0,0 +1,26 @@ +--- +id: v1-brandingitem-v1 +title: BrandingitemV1 +pagination_label: BrandingitemV1 +sidebar_label: BrandingitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BrandingitemV1', 'v1BrandingitemV1'] +slug: /tools/sdk/typescript/branding/models/brandingitem-v1 +tags: ['SDK', 'Software Development Kit', 'BrandingitemV1', 'v1BrandingitemV1'] +--- + +# BrandingitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | name of branding item | [default to undefined] +**productName** | **(optional)** **string** | product name | [default to undefined] +**actionButtonColor** | **(optional)** **string** | hex value of color for action button | [default to undefined] +**activeLinkColor** | **(optional)** **string** | hex value of color for link | [default to undefined] +**navigationColor** | **(optional)** **string** | hex value of color for navigation bar | [default to undefined] +**emailFromAddress** | **(optional)** **string** | email from address | [default to undefined] +**standardLogoURL** | **(optional)** **string** | url to standard logo | [default to undefined] +**loginInformationalMessage** | **(optional)** **string** | login information message | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/Brandingitemcreate.md b/sdk-output/branding/docs/Models/Brandingitemcreate.md new file mode 100644 index 00000000..71a9194c --- /dev/null +++ b/sdk-output/branding/docs/Models/Brandingitemcreate.md @@ -0,0 +1,26 @@ +--- +id: v1-brandingitemcreate-v1 +title: BrandingitemcreateV1 +pagination_label: BrandingitemcreateV1 +sidebar_label: BrandingitemcreateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BrandingitemcreateV1', 'v1BrandingitemcreateV1'] +slug: /tools/sdk/typescript/branding/models/brandingitemcreate-v1 +tags: ['SDK', 'Software Development Kit', 'BrandingitemcreateV1', 'v1BrandingitemcreateV1'] +--- + +# BrandingitemcreateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | name of branding item | [default to undefined] +**productName** | **string** | product name | [default to undefined] +**actionButtonColor** | **(optional)** **string** | hex value of color for action button | [default to undefined] +**activeLinkColor** | **(optional)** **string** | hex value of color for link | [default to undefined] +**navigationColor** | **(optional)** **string** | hex value of color for navigation bar | [default to undefined] +**emailFromAddress** | **(optional)** **string** | email from address | [default to undefined] +**loginInformationalMessage** | **(optional)** **string** | login information message | [default to undefined] +**fileStandard** | **(optional)** **File** | png file with logo | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/Errormessagedto.md b/sdk-output/branding/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..2041b4a2 --- /dev/null +++ b/sdk-output/branding/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/branding/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/Errorresponsedto.md b/sdk-output/branding/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..a5d1af55 --- /dev/null +++ b/sdk-output/branding/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/branding/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/GetBrandingListV1401Response.md b/sdk-output/branding/docs/Models/GetBrandingListV1401Response.md new file mode 100644 index 00000000..35b05eff --- /dev/null +++ b/sdk-output/branding/docs/Models/GetBrandingListV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-branding-list-v1401-response-v1 +title: GetBrandingListV1401ResponseV1 +pagination_label: GetBrandingListV1401ResponseV1 +sidebar_label: GetBrandingListV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetBrandingListV1401ResponseV1', 'v1GetBrandingListV1401ResponseV1'] +slug: /tools/sdk/typescript/branding/models/get-branding-list-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetBrandingListV1401ResponseV1', 'v1GetBrandingListV1401ResponseV1'] +--- + +# GetBrandingListV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/GetBrandingListV1429Response.md b/sdk-output/branding/docs/Models/GetBrandingListV1429Response.md new file mode 100644 index 00000000..05f20572 --- /dev/null +++ b/sdk-output/branding/docs/Models/GetBrandingListV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-branding-list-v1429-response-v1 +title: GetBrandingListV1429ResponseV1 +pagination_label: GetBrandingListV1429ResponseV1 +sidebar_label: GetBrandingListV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetBrandingListV1429ResponseV1', 'v1GetBrandingListV1429ResponseV1'] +slug: /tools/sdk/typescript/branding/models/get-branding-list-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetBrandingListV1429ResponseV1', 'v1GetBrandingListV1429ResponseV1'] +--- + +# GetBrandingListV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/branding/docs/Models/Index.md b/sdk-output/branding/docs/Models/Index.md new file mode 100644 index 00000000..bbd0eed2 --- /dev/null +++ b/sdk-output/branding/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: branding-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: branding-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'branding', 'models'] +slug: /tools/sdk/typescript/branding/models +tags: ['SDK', 'Software Development Kit', 'branding', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/branding/docs/Models/Localeorigin.md b/sdk-output/branding/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dcf9c11c --- /dev/null +++ b/sdk-output/branding/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/branding/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/branding/docs/Models/README.md b/sdk-output/branding/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/branding/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_campaign_filters/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/certification_campaign_filters/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..1b0eee5c --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,78 @@ +- path: /campaign-filters/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters#create-campaign-filter-v1 + source: | + import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignFiltersV1Api(configuration); + const campaignfilterdetailsV1: CampaignfilterdetailsV1 = ; // CampaignfilterdetailsV1 | + const result = await apiInstance.createCampaignFilterV1(campaignfilterdetailsV1); + console.log(result); +- path: /campaign-filters/v1/delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters#delete-campaign-filters-v1 + source: | + import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignFiltersV1Api(configuration); + const requestBody: Array<string> = ; // Array | A json list of IDs of campaign filters to delete. + const result = await apiInstance.deleteCampaignFiltersV1(requestBody); + console.log(result); +- path: /campaign-filters/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters#get-campaign-filter-by-id-v1 + source: | + import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignFiltersV1Api(configuration); + const id: string = 'e9f9a1397b842fd5a65842087040d3ac'; // string | The ID of the campaign filter to be retrieved. (default to undefined) + const result = await apiInstance.getCampaignFilterByIdV1(id); + console.log(result); +- path: /campaign-filters/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters#list-campaign-filters-v1 + source: | + import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignFiltersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const start: number = 0; // number | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const includeSystemFilters: boolean = true; // boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to true) + const result = await apiInstance.listCampaignFiltersV1(); + console.log(result); +- path: /campaign-filters/v1/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters#update-campaign-filter-v1 + source: | + import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignFiltersV1Api(configuration); + const id: string = 'e9f9a1397b842fd5a65842087040d3ac'; // string | The ID of the campaign filter being modified. (default to undefined) + const campaignfilterdetailsV1: CampaignfilterdetailsV1 = ; // CampaignfilterdetailsV1 | A campaign filter details with updated field values. + const result = await apiInstance.updateCampaignFilterV1(id, campaignfilterdetailsV1); + console.log(result); diff --git a/sdk-output/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersV1Api.md b/sdk-output/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersV1Api.md new file mode 100644 index 00000000..859d8eaf --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersV1Api.md @@ -0,0 +1,247 @@ +--- +id: v1-certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationCampaignFilters', 'v1CertificationCampaignFilters'] +slug: /tools/sdk/typescript/certification_campaign_filters/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'v1CertificationCampaignFilters'] +--- + +# CertificationCampaignFiltersV1Api + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-campaign-filter-v1**](#create-campaign-filter-v1) | **POST** `/campaign-filters/v1` | Create campaign filter +[**delete-campaign-filters-v1**](#delete-campaign-filters-v1) | **POST** `/campaign-filters/v1/delete` | Deletes campaign filters +[**get-campaign-filter-by-id-v1**](#get-campaign-filter-by-id-v1) | **GET** `/campaign-filters/v1/{id}` | Get campaign filter by id +[**list-campaign-filters-v1**](#list-campaign-filters-v1) | **GET** `/campaign-filters/v1` | List campaign filters +[**update-campaign-filter-v1**](#update-campaign-filter-v1) | **POST** `/campaign-filters/v1/{id}` | Updates a campaign filter + + +## create-campaign-filter-v1 +Create campaign filter +Use this API to create a campaign filter based on filter details and criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-campaign-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**campaignfilterdetailsV1** | **CampaignfilterdetailsV1** | | + +### Return type + +**CampaignfilterdetailsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignFiltersV1Api(configuration); +const campaignfilterdetailsV1: CampaignfilterdetailsV1 = ; // +const result = await apiInstance.createCampaignFilterV1(campaignfilterdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-campaign-filters-v1 +Deletes campaign filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-campaign-filters-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestBody** | **Array<string>** | A json list of IDs of campaign filters to delete. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignFiltersV1Api(configuration); +const requestBody: Array<string> = ; // A json list of IDs of campaign filters to delete. +const result = await apiInstance.deleteCampaignFiltersV1(requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-filter-by-id-v1 +Get campaign filter by id +Retrieves information for an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-filter-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the campaign filter to be retrieved. | [default to undefined] + +### Return type + +**CampaignfilterdetailsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignFiltersV1Api(configuration); +const id: string = e9f9a1397b842fd5a65842087040d3ac; // The ID of the campaign filter to be retrieved. +const result = await apiInstance.getCampaignFilterByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-campaign-filters-v1 +List campaign filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-campaign-filters-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**start** | **number** | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**includeSystemFilters** | **boolean** | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. | [optional] [default to true] + +### Return type + +**ListCampaignFiltersV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignFiltersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const start: number = 0; // Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const includeSystemFilters: boolean = true; // If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) +const result = await apiInstance.listCampaignFiltersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-campaign-filter-v1 +Updates a campaign filter +Updates an existing campaign filter using the filter's ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-campaign-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the campaign filter being modified. | [default to undefined] +**campaignfilterdetailsV1** | **CampaignfilterdetailsV1** | A campaign filter details with updated field values. | + +### Return type + +**CampaignfilterdetailsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignFiltersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignFiltersV1Api(configuration); +const id: string = e9f9a1397b842fd5a65842087040d3ac; // The ID of the campaign filter being modified. +const campaignfilterdetailsV1: CampaignfilterdetailsV1 = ; // A campaign filter details with updated field values. +const result = await apiInstance.updateCampaignFilterV1(id, campaignfilterdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/certification_campaign_filters/docs/Methods/Index.md b/sdk-output/certification_campaign_filters/docs/Methods/Index.md new file mode 100644 index 00000000..0c368f2f --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: certification_campaign_filters-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: certification_campaign_filters-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_campaign_filters', 'methods'] +slug: /tools/sdk/typescript/certification_campaign_filters/methods +tags: ['SDK', 'Software Development Kit', 'certification_campaign_filters', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/certification_campaign_filters/docs/Models/Campaignfilterdetails.md b/sdk-output/certification_campaign_filters/docs/Models/Campaignfilterdetails.md new file mode 100644 index 00000000..8298e085 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Campaignfilterdetails.md @@ -0,0 +1,25 @@ +--- +id: v1-campaignfilterdetails-v1 +title: CampaignfilterdetailsV1 +pagination_label: CampaignfilterdetailsV1 +sidebar_label: CampaignfilterdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignfilterdetailsV1', 'v1CampaignfilterdetailsV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/campaignfilterdetails-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignfilterdetailsV1', 'v1CampaignfilterdetailsV1'] +--- + +# CampaignfilterdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the campaign filter | [default to undefined] +**name** | **string** | Campaign filter name. | [default to undefined] +**description** | **(optional)** **string** | Campaign filter description. | [default to undefined] +**owner** | **string** | Owner of the filter. This field automatically populates at creation time with the current user. | [default to undefined] +**mode** | **string** | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | [default to undefined] +**criteriaList** | **(optional)** **Array<CampaignfilterdetailsCriteriaListInnerV1>** | List of criteria. | [default to undefined] +**isSystemFilter** | **boolean** | If true, the filter is created by the system. If false, the filter is created by a user. | [default to false] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/CampaignfilterdetailsCriteriaListInner.md b/sdk-output/certification_campaign_filters/docs/Models/CampaignfilterdetailsCriteriaListInner.md new file mode 100644 index 00000000..189789cc --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/CampaignfilterdetailsCriteriaListInner.md @@ -0,0 +1,28 @@ +--- +id: v1-campaignfilterdetails-criteria-list-inner-v1 +title: CampaignfilterdetailsCriteriaListInnerV1 +pagination_label: CampaignfilterdetailsCriteriaListInnerV1 +sidebar_label: CampaignfilterdetailsCriteriaListInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignfilterdetailsCriteriaListInnerV1', 'v1CampaignfilterdetailsCriteriaListInnerV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/campaignfilterdetails-criteria-list-inner-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignfilterdetailsCriteriaListInnerV1', 'v1CampaignfilterdetailsCriteriaListInnerV1'] +--- + +# CampaignfilterdetailsCriteriaListInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **CriteriatypeV1** | | [default to undefined] +**operation** | **(optional)** **OperationV1** | | [default to undefined] +**property** | **string** | Specified key from the type of criteria. | [default to undefined] +**value** | **string** | Value for the specified key from the type of criteria. | [default to undefined] +**negateResult** | **(optional)** **boolean** | If true, the filter will negate the result of the criteria. | [default to false] +**shortCircuit** | **(optional)** **boolean** | If true, the filter will short circuit the evaluation of the criteria. | [default to false] +**recordChildMatches** | **(optional)** **boolean** | If true, the filter will record child matches for the criteria. | [default to false] +**id** | **(optional)** **string** | The unique ID of the criteria. | [default to undefined] +**suppressMatchedItems** | **(optional)** **boolean** | If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. | [default to false] +**children** | **(optional)** **Array<object>** | List of child criteria. | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Criteriatype.md b/sdk-output/certification_campaign_filters/docs/Models/Criteriatype.md new file mode 100644 index 00000000..52619e20 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Criteriatype.md @@ -0,0 +1,39 @@ +--- +id: v1-criteriatype-v1 +title: CriteriatypeV1 +pagination_label: CriteriatypeV1 +sidebar_label: CriteriatypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CriteriatypeV1', 'v1CriteriatypeV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/criteriatype-v1 +tags: ['SDK', 'Software Development Kit', 'CriteriatypeV1', 'v1CriteriatypeV1'] +--- + +# CriteriatypeV1 + +## Enum + + +* `Composite` (value: `'COMPOSITE'`) + +* `Role` (value: `'ROLE'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityAttribute` (value: `'IDENTITY_ATTRIBUTE'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Source` (value: `'SOURCE'`) + +* `Account` (value: `'ACCOUNT'`) + +* `AggregatedEntitlement` (value: `'AGGREGATED_ENTITLEMENT'`) + +* `InvalidCertifiableEntity` (value: `'INVALID_CERTIFIABLE_ENTITY'`) + +* `InvalidCertifiableBundle` (value: `'INVALID_CERTIFIABLE_BUNDLE'`) + + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Errormessagedto.md b/sdk-output/certification_campaign_filters/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..08151800 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Errorresponsedto.md b/sdk-output/certification_campaign_filters/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..8a026980 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Index.md b/sdk-output/certification_campaign_filters/docs/Models/Index.md new file mode 100644 index 00000000..19086ded --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: certification_campaign_filters-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: certification_campaign_filters-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_campaign_filters', 'models'] +slug: /tools/sdk/typescript/certification_campaign_filters/models +tags: ['SDK', 'Software Development Kit', 'certification_campaign_filters', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1200Response.md b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1200Response.md new file mode 100644 index 00000000..34928ea3 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1200Response.md @@ -0,0 +1,20 @@ +--- +id: v1-list-campaign-filters-v1200-response-v1 +title: ListCampaignFiltersV1200ResponseV1 +pagination_label: ListCampaignFiltersV1200ResponseV1 +sidebar_label: ListCampaignFiltersV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListCampaignFiltersV1200ResponseV1', 'v1ListCampaignFiltersV1200ResponseV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/list-campaign-filters-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListCampaignFiltersV1200ResponseV1', 'v1ListCampaignFiltersV1200ResponseV1'] +--- + +# ListCampaignFiltersV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **(optional)** **Array<CampaignfilterdetailsV1>** | List of campaign filters. | [default to undefined] +**count** | **(optional)** **number** | Number of filters returned. | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1401Response.md b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1401Response.md new file mode 100644 index 00000000..fc4b702e --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-campaign-filters-v1401-response-v1 +title: ListCampaignFiltersV1401ResponseV1 +pagination_label: ListCampaignFiltersV1401ResponseV1 +sidebar_label: ListCampaignFiltersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListCampaignFiltersV1401ResponseV1', 'v1ListCampaignFiltersV1401ResponseV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/list-campaign-filters-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListCampaignFiltersV1401ResponseV1', 'v1ListCampaignFiltersV1401ResponseV1'] +--- + +# ListCampaignFiltersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1429Response.md b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1429Response.md new file mode 100644 index 00000000..fcf0de7a --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/ListCampaignFiltersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-campaign-filters-v1429-response-v1 +title: ListCampaignFiltersV1429ResponseV1 +pagination_label: ListCampaignFiltersV1429ResponseV1 +sidebar_label: ListCampaignFiltersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListCampaignFiltersV1429ResponseV1', 'v1ListCampaignFiltersV1429ResponseV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/list-campaign-filters-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListCampaignFiltersV1429ResponseV1', 'v1ListCampaignFiltersV1429ResponseV1'] +--- + +# ListCampaignFiltersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Localeorigin.md b/sdk-output/certification_campaign_filters/docs/Models/Localeorigin.md new file mode 100644 index 00000000..f82ace14 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/certification_campaign_filters/docs/Models/Operation.md b/sdk-output/certification_campaign_filters/docs/Models/Operation.md new file mode 100644 index 00000000..699aadb2 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/Operation.md @@ -0,0 +1,31 @@ +--- +id: v1-operation-v1 +title: OperationV1 +pagination_label: OperationV1 +sidebar_label: OperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OperationV1', 'v1OperationV1'] +slug: /tools/sdk/typescript/certification_campaign_filters/models/operation-v1 +tags: ['SDK', 'Software Development Kit', 'OperationV1', 'v1OperationV1'] +--- + +# OperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `NotEquals` (value: `'NOT_EQUALS'`) + +* `Contains` (value: `'CONTAINS'`) + +* `StartsWith` (value: `'STARTS_WITH'`) + +* `EndsWith` (value: `'ENDS_WITH'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/certification_campaign_filters/docs/Models/README.md b/sdk-output/certification_campaign_filters/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_campaign_filters/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_campaigns/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/certification_campaigns/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..89d491ed --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,346 @@ +- path: /campaigns/v1/{id}/complete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#complete-campaign-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Campaign ID. (default to undefined) + const campaigncompleteoptionsV1: CampaigncompleteoptionsV1 = ; // CampaigncompleteoptionsV1 | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) + const result = await apiInstance.completeCampaignV1(id); + console.log(result); +- path: /campaign-templates/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#create-campaign-template-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const campaigntemplateV1: CampaigntemplateV1 = ; // CampaigntemplateV1 | + const result = await apiInstance.createCampaignTemplateV1(campaigntemplateV1); + console.log(result); +- path: /campaigns/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#create-campaign-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const campaign2V1: Campaign2V1 = ; // Campaign2V1 | + const result = await apiInstance.createCampaignV1(campaign2V1); + console.log(result); +- path: /campaign-templates/v1/{id}/schedule + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#delete-campaign-template-schedule-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '04bedce387bd47b2ae1f86eb0bb36dee'; // string | ID of the campaign template whose schedule is being deleted. (default to undefined) + const result = await apiInstance.deleteCampaignTemplateScheduleV1(id); + console.log(result); +- path: /campaign-templates/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#delete-campaign-template-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of the campaign template being deleted. (default to undefined) + const result = await apiInstance.deleteCampaignTemplateV1(id); + console.log(result); +- path: /campaigns/v1/delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#delete-campaigns-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const campaignsdeleterequestV1: CampaignsdeleterequestV1 = ; // CampaignsdeleterequestV1 | IDs of the campaigns to delete. + const result = await apiInstance.deleteCampaignsV1(campaignsdeleterequestV1); + console.log(result); +- path: /campaigns/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-active-campaigns-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const detail: string = 'FULL'; // 'SLIM' | 'FULL' | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq "Manager Campaign"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) (default to undefined) + const result = await apiInstance.getActiveCampaignsV1(); + console.log(result); +- path: /campaigns/v1/reports-configuration + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-reports-config-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const result = await apiInstance.getCampaignReportsConfigV1(); + console.log(result); +- path: /campaigns/v1/{id}/reports + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-reports-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c91808571bcfcf80171c23e4b4221fc'; // string | ID of the campaign whose reports are being fetched. (default to undefined) + const result = await apiInstance.getCampaignReportsV1(id); + console.log(result); +- path: /campaign-templates/v1/{id}/schedule + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-template-schedule-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '04bedce387bd47b2ae1f86eb0bb36dee'; // string | ID of the campaign template whose schedule is being fetched. (default to undefined) + const result = await apiInstance.getCampaignTemplateScheduleV1(id); + console.log(result); +- path: /campaign-templates/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-template-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | Requested campaign template\'s ID. (default to undefined) + const result = await apiInstance.getCampaignTemplateV1(id); + console.log(result); +- path: /campaign-templates/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-templates-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const filters: string = 'name eq "manager template"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) (default to undefined) + const result = await apiInstance.getCampaignTemplatesV1(); + console.log(result); +- path: /campaigns/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#get-campaign-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c91808571bcfcf80171c23e4b4221fc'; // string | ID of the campaign to be retrieved. (default to undefined) + const detail: string = 'FULL'; // 'SLIM' | 'FULL' | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) (default to undefined) + const result = await apiInstance.getCampaignV1(id); + console.log(result); +- path: /campaigns/v1/{id}/reassign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#move-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The certification campaign ID (default to undefined) + const adminreviewreassignV1: AdminreviewreassignV1 = ; // AdminreviewreassignV1 | + const result = await apiInstance.moveV1(id, adminreviewreassignV1); + console.log(result); +- path: /campaign-templates/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#patch-campaign-template-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of the campaign template being modified. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/campaign/filter/id","value":"ff80818155fe8c080155fe8d925b0316"}]; // Array | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + const result = await apiInstance.patchCampaignTemplateV1(id, jsonpatchoperationV1); + console.log(result); +- path: /campaigns/v1/reports-configuration + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#set-campaign-reports-config-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const campaignreportsconfigV1: CampaignreportsconfigV1 = ; // CampaignreportsconfigV1 | Campaign report configuration. + const result = await apiInstance.setCampaignReportsConfigV1(campaignreportsconfigV1); + console.log(result); +- path: /campaign-templates/v1/{id}/schedule + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#set-campaign-template-schedule-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '04bedce387bd47b2ae1f86eb0bb36dee'; // string | ID of the campaign template being scheduled. (default to undefined) + const schedule2V1: Schedule2V1 = {"type":"MONTHLY","hours":{"type":"LIST","values":["17"]},"days":{"type":"LIST","values":["15"]}}; // Schedule2V1 | (optional) + const result = await apiInstance.setCampaignTemplateScheduleV1(id); + console.log(result); +- path: /campaigns/v1/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#start-campaign-remediation-scan-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c91808571bcfcf80171c23e4b4221fc'; // string | ID of the campaign the remediation scan is being run for. (default to undefined) + const result = await apiInstance.startCampaignRemediationScanV1(id); + console.log(result); +- path: /campaigns/v1/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#start-campaign-report-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c91808571bcfcf80171c23e4b4221fc'; // string | ID of the campaign the report is being run for. (default to undefined) + const type: ReporttypeV1 = ; // ReporttypeV1 | Type of the report to run. (default to undefined) + const result = await apiInstance.startCampaignReportV1(id, type); + console.log(result); +- path: /campaigns/v1/{id}/activate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#start-campaign-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Campaign ID. (default to undefined) + const activatecampaignoptionsV1: ActivatecampaignoptionsV1 = ; // ActivatecampaignoptionsV1 | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) + const result = await apiInstance.startCampaignV1(id); + console.log(result); +- path: /campaign-templates/v1/{id}/generate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#start-generate-campaign-template-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of the campaign template to use for generation. (default to undefined) + const result = await apiInstance.startGenerateCampaignTemplateV1(id); + console.log(result); +- path: /campaigns/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_campaigns/methods/certification-campaigns#update-campaign-v1 + source: | + import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationCampaignsV1Api(configuration); + const id: string = '2c91808571bcfcf80171c23e4b4221fc'; // string | ID of the campaign template being modified. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"This field has been updated!"},{"op":"copy","from":"/name","path":"/description"}]; // Array | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + const result = await apiInstance.updateCampaignV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/certification_campaigns/docs/Methods/CertificationCampaignsV1Api.md b/sdk-output/certification_campaigns/docs/Methods/CertificationCampaignsV1Api.md new file mode 100644 index 00000000..3eef1be0 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Methods/CertificationCampaignsV1Api.md @@ -0,0 +1,1015 @@ +--- +id: v1-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationCampaigns', 'v1CertificationCampaigns'] +slug: /tools/sdk/typescript/certification_campaigns/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'v1CertificationCampaigns'] +--- + +# CertificationCampaignsV1Api + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certs/reviewing/index.html). + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-campaign-v1**](#complete-campaign-v1) | **POST** `/campaigns/v1/{id}/complete` | Complete a campaign +[**create-campaign-template-v1**](#create-campaign-template-v1) | **POST** `/campaign-templates/v1` | Create a campaign template +[**create-campaign-v1**](#create-campaign-v1) | **POST** `/campaigns/v1` | Create a campaign +[**delete-campaign-template-schedule-v1**](#delete-campaign-template-schedule-v1) | **DELETE** `/campaign-templates/v1/{id}/schedule` | Delete campaign template schedule +[**delete-campaign-template-v1**](#delete-campaign-template-v1) | **DELETE** `/campaign-templates/v1/{id}` | Delete a campaign template +[**delete-campaigns-v1**](#delete-campaigns-v1) | **POST** `/campaigns/v1/delete` | Delete campaigns +[**get-active-campaigns-v1**](#get-active-campaigns-v1) | **GET** `/campaigns/v1` | List campaigns +[**get-campaign-reports-config-v1**](#get-campaign-reports-config-v1) | **GET** `/campaigns/v1/reports-configuration` | Get campaign reports configuration +[**get-campaign-reports-v1**](#get-campaign-reports-v1) | **GET** `/campaigns/v1/{id}/reports` | Get campaign reports +[**get-campaign-template-schedule-v1**](#get-campaign-template-schedule-v1) | **GET** `/campaign-templates/v1/{id}/schedule` | Get campaign template schedule +[**get-campaign-template-v1**](#get-campaign-template-v1) | **GET** `/campaign-templates/v1/{id}` | Get a campaign template +[**get-campaign-templates-v1**](#get-campaign-templates-v1) | **GET** `/campaign-templates/v1` | List campaign templates +[**get-campaign-v1**](#get-campaign-v1) | **GET** `/campaigns/v1/{id}` | Get campaign +[**move-v1**](#move-v1) | **POST** `/campaigns/v1/{id}/reassign` | Reassign certifications +[**patch-campaign-template-v1**](#patch-campaign-template-v1) | **PATCH** `/campaign-templates/v1/{id}` | Update a campaign template +[**set-campaign-reports-config-v1**](#set-campaign-reports-config-v1) | **PUT** `/campaigns/v1/reports-configuration` | Set campaign reports configuration +[**set-campaign-template-schedule-v1**](#set-campaign-template-schedule-v1) | **PUT** `/campaign-templates/v1/{id}/schedule` | Set campaign template schedule +[**start-campaign-remediation-scan-v1**](#start-campaign-remediation-scan-v1) | **POST** `/campaigns/v1/{id}/run-remediation-scan` | Run campaign remediation scan +[**start-campaign-report-v1**](#start-campaign-report-v1) | **POST** `/campaigns/v1/{id}/run-report/{type}` | Run campaign report +[**start-campaign-v1**](#start-campaign-v1) | **POST** `/campaigns/v1/{id}/activate` | Activate a campaign +[**start-generate-campaign-template-v1**](#start-generate-campaign-template-v1) | **POST** `/campaign-templates/v1/{id}/generate` | Generate a campaign from template +[**update-campaign-v1**](#update-campaign-v1) | **PATCH** `/campaigns/v1/{id}` | Update a campaign + + +## complete-campaign-v1 +Complete a campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/complete-campaign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Campaign ID. | [default to undefined] +**campaigncompleteoptionsV1** | **CampaigncompleteoptionsV1** | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE | [optional] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Campaign ID. +const campaigncompleteoptionsV1: CampaigncompleteoptionsV1 = ; // Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional) +const result = await apiInstance.completeCampaignV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## create-campaign-template-v1 +Create a campaign template +Use this API to create a certification campaign template based on campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-campaign-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**campaigntemplateV1** | **CampaigntemplateV1** | | + +### Return type + +**CampaigntemplateV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const campaigntemplateV1: CampaigntemplateV1 = ; // +const result = await apiInstance.createCampaignTemplateV1(campaigntemplateV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-campaign-v1 +Create a campaign +Use this API to create a certification campaign with the information provided in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-campaign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**campaign2V1** | **Campaign2V1** | | + +### Return type + +**Campaign2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const campaign2V1: Campaign2V1 = ; // +const result = await apiInstance.createCampaignV1(campaign2V1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-campaign-template-schedule-v1 +Delete campaign template schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-campaign-template-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template whose schedule is being deleted. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template whose schedule is being deleted. +const result = await apiInstance.deleteCampaignTemplateScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-campaign-template-v1 +Delete a campaign template +Use this API to delete a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-campaign-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template being deleted. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template being deleted. +const result = await apiInstance.deleteCampaignTemplateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-campaigns-v1 +Delete campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-campaigns-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**campaignsdeleterequestV1** | **CampaignsdeleterequestV1** | IDs of the campaigns to delete. | + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const campaignsdeleterequestV1: CampaignsdeleterequestV1 = ; // IDs of the campaigns to delete. +const result = await apiInstance.deleteCampaignsV1(campaignsdeleterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-active-campaigns-v1 +List campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-active-campaigns-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**detail** | **'SLIM' | 'FULL'** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const detail: string = FULL; // Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "Manager Campaign"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) +const result = await apiInstance.getActiveCampaignsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-reports-config-v1 +Get campaign reports configuration +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-reports-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**CampaignreportsconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const result = await apiInstance.getCampaignReportsConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-reports-v1 +Get campaign reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-reports-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign whose reports are being fetched. | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign whose reports are being fetched. +const result = await apiInstance.getCampaignReportsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-template-schedule-v1 +Get campaign template schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-template-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template whose schedule is being fetched. | [default to undefined] + +### Return type + +**Schedule2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template whose schedule is being fetched. +const result = await apiInstance.getCampaignTemplateScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-template-v1 +Get a campaign template +Use this API to fetch a certification campaign template by ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Requested campaign template\'s ID. | [default to undefined] + +### Return type + +**CampaigntemplateV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // Requested campaign template\'s ID. +const result = await apiInstance.getCampaignTemplateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-templates-v1 +List campaign templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-templates-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const filters: string = name eq "manager template"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) +const result = await apiInstance.getCampaignTemplatesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-campaign-v1 +Get campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-campaign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign to be retrieved. | [default to undefined] +**detail** | **'SLIM' | 'FULL'** | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. | [optional] [default to undefined] + +### Return type + +**GetCampaignV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign to be retrieved. +const detail: string = FULL; // Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) +const result = await apiInstance.getCampaignV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## move-v1 +Reassign certifications +This API reassigns the specified certifications from one identity to another. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/move-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The certification campaign ID | [default to undefined] +**adminreviewreassignV1** | **AdminreviewreassignV1** | | + +### Return type + +**CertificationtaskV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The certification campaign ID +const adminreviewreassignV1: AdminreviewreassignV1 = ; // +const result = await apiInstance.moveV1(id, adminreviewreassignV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-campaign-template-v1 +Update a campaign template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-campaign-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template being modified. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) | + +### Return type + +**CampaigntemplateV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template being modified. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/campaign/filter/id","value":"ff80818155fe8c080155fe8d925b0316"}]; // A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) +const result = await apiInstance.patchCampaignTemplateV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-campaign-reports-config-v1 +Set campaign reports configuration +Use this API to overwrite the configuration for campaign reports. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-campaign-reports-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**campaignreportsconfigV1** | **CampaignreportsconfigV1** | Campaign report configuration. | + +### Return type + +**CampaignreportsconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const campaignreportsconfigV1: CampaignreportsconfigV1 = ; // Campaign report configuration. +const result = await apiInstance.setCampaignReportsConfigV1(campaignreportsconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-campaign-template-schedule-v1 +Set campaign template schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-campaign-template-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template being scheduled. | [default to undefined] +**schedule2V1** | **Schedule2V1** | | [optional] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 04bedce387bd47b2ae1f86eb0bb36dee; // ID of the campaign template being scheduled. +const schedule2V1: Schedule2V1 = {"type":"MONTHLY","hours":{"type":"LIST","values":["17"]},"days":{"type":"LIST","values":["15"]}}; // (optional) +const result = await apiInstance.setCampaignTemplateScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## start-campaign-remediation-scan-v1 +Run campaign remediation scan +Use this API to run a remediation scan task for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-campaign-remediation-scan-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign the remediation scan is being run for. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign the remediation scan is being run for. +const result = await apiInstance.startCampaignRemediationScanV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## start-campaign-report-v1 +Run campaign report +Use this API to run a report for a certification campaign. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-campaign-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign the report is being run for. | [default to undefined] +**type** | **ReporttypeV1** | Type of the report to run. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign the report is being run for. +const type: ReporttypeV1 = ; // Type of the report to run. +const result = await apiInstance.startCampaignReportV1(id, type); +console.log(result); +``` + +[[Back to top]](#) + +## start-campaign-v1 +Activate a campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-campaign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Campaign ID. | [default to undefined] +**activatecampaignoptionsV1** | **ActivatecampaignoptionsV1** | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. | [optional] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Campaign ID. +const activatecampaignoptionsV1: ActivatecampaignoptionsV1 = ; // Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional) +const result = await apiInstance.startCampaignV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## start-generate-campaign-template-v1 +Generate a campaign from template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-generate-campaign-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template to use for generation. | [default to undefined] + +### Return type + +**CampaignreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the campaign template to use for generation. +const result = await apiInstance.startGenerateCampaignTemplateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-campaign-v1 +Update a campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-campaign-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the campaign template being modified. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline | + +### Return type + +**SlimcampaignV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationCampaignsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationCampaignsV1Api(configuration); +const id: string = 2c91808571bcfcf80171c23e4b4221fc; // ID of the campaign template being modified. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"This field has been updated!"},{"op":"copy","from":"/name","path":"/description"}]; // A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline +const result = await apiInstance.updateCampaignV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/certification_campaigns/docs/Methods/Index.md b/sdk-output/certification_campaigns/docs/Methods/Index.md new file mode 100644 index 00000000..f3f0b31c --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: certification_campaigns-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: certification_campaigns-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_campaigns', 'methods'] +slug: /tools/sdk/typescript/certification_campaigns/methods +tags: ['SDK', 'Software Development Kit', 'certification_campaigns', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/certification_campaigns/docs/Models/Accessconstraint.md b/sdk-output/certification_campaigns/docs/Models/Accessconstraint.md new file mode 100644 index 00000000..5a62eb13 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Accessconstraint.md @@ -0,0 +1,21 @@ +--- +id: v1-accessconstraint-v1 +title: AccessconstraintV1 +pagination_label: AccessconstraintV1 +sidebar_label: AccessconstraintV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessconstraintV1', 'v1AccessconstraintV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/accessconstraint-v1 +tags: ['SDK', 'Software Development Kit', 'AccessconstraintV1', 'v1AccessconstraintV1'] +--- + +# AccessconstraintV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of Access | [default to undefined] +**ids** | **(optional)** **Array<string>** | Must be set only if operator is SELECTED. | [default to undefined] +**operator** | **string** | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Activatecampaignoptions.md b/sdk-output/certification_campaigns/docs/Models/Activatecampaignoptions.md new file mode 100644 index 00000000..9193adc6 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Activatecampaignoptions.md @@ -0,0 +1,19 @@ +--- +id: v1-activatecampaignoptions-v1 +title: ActivatecampaignoptionsV1 +pagination_label: ActivatecampaignoptionsV1 +sidebar_label: ActivatecampaignoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ActivatecampaignoptionsV1', 'v1ActivatecampaignoptionsV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/activatecampaignoptions-v1 +tags: ['SDK', 'Software Development Kit', 'ActivatecampaignoptionsV1', 'v1ActivatecampaignoptionsV1'] +--- + +# ActivatecampaignoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timeZone** | **(optional)** **string** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as \'Z\') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [default to 'Z'] + diff --git a/sdk-output/certification_campaigns/docs/Models/Adminreviewreassign.md b/sdk-output/certification_campaigns/docs/Models/Adminreviewreassign.md new file mode 100644 index 00000000..70f1def0 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Adminreviewreassign.md @@ -0,0 +1,21 @@ +--- +id: v1-adminreviewreassign-v1 +title: AdminreviewreassignV1 +pagination_label: AdminreviewreassignV1 +sidebar_label: AdminreviewreassignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdminreviewreassignV1', 'v1AdminreviewreassignV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/adminreviewreassign-v1 +tags: ['SDK', 'Software Development Kit', 'AdminreviewreassignV1', 'v1AdminreviewreassignV1'] +--- + +# AdminreviewreassignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certificationIds** | **(optional)** **Array<string>** | List of certification IDs to reassign | [default to undefined] +**reassignTo** | **(optional)** **AdminreviewreassignReassignToV1** | | [default to undefined] +**reason** | **(optional)** **string** | Comment to explain why the certification was reassigned | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/AdminreviewreassignReassignTo.md b/sdk-output/certification_campaigns/docs/Models/AdminreviewreassignReassignTo.md new file mode 100644 index 00000000..20d35a47 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/AdminreviewreassignReassignTo.md @@ -0,0 +1,20 @@ +--- +id: v1-adminreviewreassign-reassign-to-v1 +title: AdminreviewreassignReassignToV1 +pagination_label: AdminreviewreassignReassignToV1 +sidebar_label: AdminreviewreassignReassignToV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdminreviewreassignReassignToV1', 'v1AdminreviewreassignReassignToV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/adminreviewreassign-reassign-to-v1 +tags: ['SDK', 'Software Development Kit', 'AdminreviewreassignReassignToV1', 'v1AdminreviewreassignReassignToV1'] +--- + +# AdminreviewreassignReassignToV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID to which the review is being assigned. | [default to undefined] +**type** | **(optional)** **string** | The type of the ID provided. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/ArrayInner.md b/sdk-output/certification_campaigns/docs/Models/ArrayInner.md new file mode 100644 index 00000000..4eb9bfb5 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2.md b/sdk-output/certification_campaigns/docs/Models/Campaign2.md new file mode 100644 index 00000000..ea85ef0f --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2.md @@ -0,0 +1,41 @@ +--- +id: v1-campaign2-v1 +title: Campaign2V1 +pagination_label: Campaign2V1 +sidebar_label: Campaign2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2V1', 'v1Campaign2V1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2V1', 'v1Campaign2V1'] +--- + +# Campaign2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the campaign | [readonly] [default to undefined] +**name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**deadline** | **(optional)** **string** | The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [default to undefined] +**type** | **string** | The type of campaign. Could be extended in the future. | [default to undefined] +**emailNotificationEnabled** | **(optional)** **boolean** | Enables email notification for this campaign | [default to false] +**autoRevokeAllowed** | **(optional)** **boolean** | Allows auto revoke for this campaign | [default to false] +**recommendationsEnabled** | **(optional)** **boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [default to false] +**status** | **(optional)** **string** | The campaign\'s current status. | [readonly] [default to undefined] +**correlatedStatus** | **(optional)** **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**created** | **(optional)** **string** | Created time of the campaign | [readonly] [default to undefined] +**totalCertifications** | **(optional)** **number** | The total number of certifications in this campaign. | [readonly] [default to undefined] +**completedCertifications** | **(optional)** **number** | The number of completed certifications in this campaign. | [readonly] [default to undefined] +**alerts** | **(optional)** **Array<CampaignalertV1>** | A list of errors and warnings that have accumulated. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Modified time of the campaign | [readonly] [default to undefined] +**filter** | **(optional)** **Campaign2AllOfFilterV1** | | [default to undefined] +**sunsetCommentsRequired** | **(optional)** **boolean** | Determines if comments on sunset date changes are required. | [default to true] +**sourceOwnerCampaignInfo** | **(optional)** **Campaign2AllOfSourceOwnerCampaignInfoV1** | | [default to undefined] +**searchCampaignInfo** | **(optional)** **Campaign2AllOfSearchCampaignInfoV1** | | [default to undefined] +**roleCompositionCampaignInfo** | **(optional)** **Campaign2AllOfRoleCompositionCampaignInfoV1** | | [default to undefined] +**machineAccountCampaignInfo** | **(optional)** **Campaign2AllOfMachineAccountCampaignInfoV1** | | [default to undefined] +**sourcesWithOrphanEntitlements** | **(optional)** **Array<Campaign2AllOfSourcesWithOrphanEntitlementsV1>** | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [readonly] [default to undefined] +**mandatoryCommentRequirement** | **(optional)** **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfFilter.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfFilter.md new file mode 100644 index 00000000..fefb63f8 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfFilter.md @@ -0,0 +1,21 @@ +--- +id: v1-campaign2-all-of-filter-v1 +title: Campaign2AllOfFilterV1 +pagination_label: Campaign2AllOfFilterV1 +sidebar_label: Campaign2AllOfFilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfFilterV1', 'v1Campaign2AllOfFilterV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-filter-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfFilterV1', 'v1Campaign2AllOfFilterV1'] +--- + +# Campaign2AllOfFilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of whatever type of filter is being used. | [default to undefined] +**type** | **(optional)** **string** | Type of the filter | [default to undefined] +**name** | **(optional)** **string** | Name of the filter | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfMachineAccountCampaignInfo.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfMachineAccountCampaignInfo.md new file mode 100644 index 00000000..39d8c0e1 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfMachineAccountCampaignInfo.md @@ -0,0 +1,20 @@ +--- +id: v1-campaign2-all-of-machine-account-campaign-info-v1 +title: Campaign2AllOfMachineAccountCampaignInfoV1 +pagination_label: Campaign2AllOfMachineAccountCampaignInfoV1 +sidebar_label: Campaign2AllOfMachineAccountCampaignInfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfMachineAccountCampaignInfoV1', 'v1Campaign2AllOfMachineAccountCampaignInfoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-machine-account-campaign-info-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfMachineAccountCampaignInfoV1', 'v1Campaign2AllOfMachineAccountCampaignInfoV1'] +--- + +# Campaign2AllOfMachineAccountCampaignInfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceIds** | **(optional)** **Array<string>** | The list of sources to be included in the campaign. | [default to undefined] +**reviewerType** | **(optional)** **string** | The reviewer\'s type. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfo.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfo.md new file mode 100644 index 00000000..8fdca05e --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,24 @@ +--- +id: v1-campaign2-all-of-role-composition-campaign-info-v1 +title: Campaign2AllOfRoleCompositionCampaignInfoV1 +pagination_label: Campaign2AllOfRoleCompositionCampaignInfoV1 +sidebar_label: Campaign2AllOfRoleCompositionCampaignInfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfRoleCompositionCampaignInfoV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-role-composition-campaign-info-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfRoleCompositionCampaignInfoV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoV1'] +--- + +# Campaign2AllOfRoleCompositionCampaignInfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reviewerId** | **(optional)** **string** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [default to undefined] +**reviewer** | **(optional)** **Campaign2AllOfRoleCompositionCampaignInfoReviewerV1** | | [default to undefined] +**roleIds** | **(optional)** **Array<string>** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [default to undefined] +**remediatorRef** | **Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1** | | [default to undefined] +**query** | **(optional)** **string** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [default to undefined] +**description** | **(optional)** **string** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoRemediatorRef.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 00000000..7690091a --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,21 @@ +--- +id: v1-campaign2-all-of-role-composition-campaign-info-remediator-ref-v1 +title: Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 +pagination_label: Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 +sidebar_label: Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-role-composition-campaign-info-remediator-ref-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1'] +--- + +# Campaign2AllOfRoleCompositionCampaignInfoRemediatorRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Legal Remediator Type | [default to undefined] +**id** | **string** | The ID of the remediator. | [default to undefined] +**name** | **(optional)** **string** | The name of the remediator. | [readonly] [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoReviewer.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoReviewer.md new file mode 100644 index 00000000..79fabaae --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfRoleCompositionCampaignInfoReviewer.md @@ -0,0 +1,21 @@ +--- +id: v1-campaign2-all-of-role-composition-campaign-info-reviewer-v1 +title: Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 +pagination_label: Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 +sidebar_label: Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfRoleCompositionCampaignInfoReviewerV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoReviewerV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-role-composition-campaign-info-reviewer-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfRoleCompositionCampaignInfoReviewerV1', 'v1Campaign2AllOfRoleCompositionCampaignInfoReviewerV1'] +--- + +# Campaign2AllOfRoleCompositionCampaignInfoReviewerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The reviewer\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | The reviewer\'s ID. | [default to undefined] +**name** | **(optional)** **string** | The reviewer\'s name. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfo.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfo.md new file mode 100644 index 00000000..1ff0d8f5 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfo.md @@ -0,0 +1,24 @@ +--- +id: v1-campaign2-all-of-search-campaign-info-v1 +title: Campaign2AllOfSearchCampaignInfoV1 +pagination_label: Campaign2AllOfSearchCampaignInfoV1 +sidebar_label: Campaign2AllOfSearchCampaignInfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfSearchCampaignInfoV1', 'v1Campaign2AllOfSearchCampaignInfoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-search-campaign-info-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfSearchCampaignInfoV1', 'v1Campaign2AllOfSearchCampaignInfoV1'] +--- + +# Campaign2AllOfSearchCampaignInfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of search campaign represented. | [default to undefined] +**description** | **(optional)** **string** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [default to undefined] +**reviewer** | **(optional)** **Campaign2AllOfSearchCampaignInfoReviewerV1** | | [default to undefined] +**query** | **(optional)** **string** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [default to undefined] +**identityIds** | **(optional)** **Array<string>** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [default to undefined] +**accessConstraints** | **(optional)** **Array<AccessconstraintV1>** | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfoReviewer.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfoReviewer.md new file mode 100644 index 00000000..a30627a8 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,21 @@ +--- +id: v1-campaign2-all-of-search-campaign-info-reviewer-v1 +title: Campaign2AllOfSearchCampaignInfoReviewerV1 +pagination_label: Campaign2AllOfSearchCampaignInfoReviewerV1 +sidebar_label: Campaign2AllOfSearchCampaignInfoReviewerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfSearchCampaignInfoReviewerV1', 'v1Campaign2AllOfSearchCampaignInfoReviewerV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-search-campaign-info-reviewer-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfSearchCampaignInfoReviewerV1', 'v1Campaign2AllOfSearchCampaignInfoReviewerV1'] +--- + +# Campaign2AllOfSearchCampaignInfoReviewerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The reviewer\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | The reviewer\'s ID. | [default to undefined] +**name** | **(optional)** **string** | The reviewer\'s name. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourceOwnerCampaignInfo.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourceOwnerCampaignInfo.md new file mode 100644 index 00000000..d6075ecb --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,19 @@ +--- +id: v1-campaign2-all-of-source-owner-campaign-info-v1 +title: Campaign2AllOfSourceOwnerCampaignInfoV1 +pagination_label: Campaign2AllOfSourceOwnerCampaignInfoV1 +sidebar_label: Campaign2AllOfSourceOwnerCampaignInfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfSourceOwnerCampaignInfoV1', 'v1Campaign2AllOfSourceOwnerCampaignInfoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-source-owner-campaign-info-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfSourceOwnerCampaignInfoV1', 'v1Campaign2AllOfSourceOwnerCampaignInfoV1'] +--- + +# Campaign2AllOfSourceOwnerCampaignInfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceIds** | **(optional)** **Array<string>** | The list of sources to be included in the campaign. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourcesWithOrphanEntitlements.md b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 00000000..08333116 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaign2AllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,21 @@ +--- +id: v1-campaign2-all-of-sources-with-orphan-entitlements-v1 +title: Campaign2AllOfSourcesWithOrphanEntitlementsV1 +pagination_label: Campaign2AllOfSourcesWithOrphanEntitlementsV1 +sidebar_label: Campaign2AllOfSourcesWithOrphanEntitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Campaign2AllOfSourcesWithOrphanEntitlementsV1', 'v1Campaign2AllOfSourcesWithOrphanEntitlementsV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaign2-all-of-sources-with-orphan-entitlements-v1 +tags: ['SDK', 'Software Development Kit', 'Campaign2AllOfSourcesWithOrphanEntitlementsV1', 'v1Campaign2AllOfSourcesWithOrphanEntitlementsV1'] +--- + +# Campaign2AllOfSourcesWithOrphanEntitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the source | [default to undefined] +**type** | **(optional)** **string** | Type | [default to undefined] +**name** | **(optional)** **string** | Name of the source | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaignalert.md b/sdk-output/certification_campaigns/docs/Models/Campaignalert.md new file mode 100644 index 00000000..480fa3b1 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaignalert.md @@ -0,0 +1,20 @@ +--- +id: v1-campaignalert-v1 +title: CampaignalertV1 +pagination_label: CampaignalertV1 +sidebar_label: CampaignalertV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignalertV1', 'v1CampaignalertV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaignalert-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignalertV1', 'v1CampaignalertV1'] +--- + +# CampaignalertV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**level** | **(optional)** **string** | Denotes the level of the message | [default to undefined] +**localizations** | **(optional)** **Array<ErrormessagedtoV1>** | | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaigncompleteoptions.md b/sdk-output/certification_campaigns/docs/Models/Campaigncompleteoptions.md new file mode 100644 index 00000000..9bab27d4 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaigncompleteoptions.md @@ -0,0 +1,19 @@ +--- +id: v1-campaigncompleteoptions-v1 +title: CampaigncompleteoptionsV1 +pagination_label: CampaigncompleteoptionsV1 +sidebar_label: CampaigncompleteoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigncompleteoptionsV1', 'v1CampaigncompleteoptionsV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaigncompleteoptions-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigncompleteoptionsV1', 'v1CampaigncompleteoptionsV1'] +--- + +# CampaigncompleteoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**autoCompleteAction** | **(optional)** **string** | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [default to AutoCompleteActionV1_Approve] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaignreference.md b/sdk-output/certification_campaigns/docs/Models/Campaignreference.md new file mode 100644 index 00000000..ccc6e645 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaignreference.md @@ -0,0 +1,25 @@ +--- +id: v1-campaignreference-v1 +title: CampaignreferenceV1 +pagination_label: CampaignreferenceV1 +sidebar_label: CampaignreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaignreference-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +--- + +# CampaignreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the campaign. | [default to undefined] +**name** | **string** | The name of the campaign. | [default to undefined] +**type** | **string** | The type of object that is being referenced. | [default to undefined] +**campaignType** | **string** | The type of the campaign. | [default to undefined] +**description** | **string** | The description of the campaign set by the admin who created it. | [default to undefined] +**correlatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**mandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaignreport.md b/sdk-output/certification_campaigns/docs/Models/Campaignreport.md new file mode 100644 index 00000000..4505fb09 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaignreport.md @@ -0,0 +1,24 @@ +--- +id: v1-campaignreport-v1 +title: CampaignreportV1 +pagination_label: CampaignreportV1 +sidebar_label: CampaignreportV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignreportV1', 'v1CampaignreportV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaignreport-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignreportV1', 'v1CampaignreportV1'] +--- + +# CampaignreportV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy violation report result DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy violation report result ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of the SOD policy violation report result. | [default to undefined] +**status** | **(optional)** **string** | Status of a SOD policy violation report. | [default to undefined] +**reportType** | **ReporttypeV1** | | [default to undefined] +**lastRunAt** | **(optional)** **string** | The most recent date and time this report was run | [readonly] [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaignreportsconfig.md b/sdk-output/certification_campaigns/docs/Models/Campaignreportsconfig.md new file mode 100644 index 00000000..48e808d7 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaignreportsconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-campaignreportsconfig-v1 +title: CampaignreportsconfigV1 +pagination_label: CampaignreportsconfigV1 +sidebar_label: CampaignreportsconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignreportsconfigV1', 'v1CampaignreportsconfigV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaignreportsconfig-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignreportsconfigV1', 'v1CampaignreportsconfigV1'] +--- + +# CampaignreportsconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityAttributeColumns** | **(optional)** **Array<string>** | list of identity attribute columns | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaignsdeleterequest.md b/sdk-output/certification_campaigns/docs/Models/Campaignsdeleterequest.md new file mode 100644 index 00000000..9e3022cd --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaignsdeleterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-campaignsdeleterequest-v1 +title: CampaignsdeleterequestV1 +pagination_label: CampaignsdeleterequestV1 +sidebar_label: CampaignsdeleterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignsdeleterequestV1', 'v1CampaignsdeleterequestV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaignsdeleterequest-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignsdeleterequestV1', 'v1CampaignsdeleterequestV1'] +--- + +# CampaignsdeleterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **(optional)** **Array<string>** | The ids of the campaigns to delete | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Campaigntemplate.md b/sdk-output/certification_campaigns/docs/Models/Campaigntemplate.md new file mode 100644 index 00000000..23751fdc --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Campaigntemplate.md @@ -0,0 +1,27 @@ +--- +id: v1-campaigntemplate-v1 +title: CampaigntemplateV1 +pagination_label: CampaigntemplateV1 +sidebar_label: CampaigntemplateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigntemplateV1', 'v1CampaigntemplateV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaigntemplate-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigntemplateV1', 'v1CampaigntemplateV1'] +--- + +# CampaigntemplateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the campaign template | [default to undefined] +**name** | **string** | This template\'s name. Has no bearing on generated campaigns\' names. | [default to undefined] +**description** | **string** | This template\'s description. Has no bearing on generated campaigns\' descriptions. | [default to undefined] +**created** | **string** | Creation date of Campaign Template | [readonly] [default to undefined] +**modified** | **string** | Modification date of Campaign Template | [readonly] [default to undefined] +**scheduled** | **(optional)** **boolean** | Indicates if this campaign template has been scheduled. | [readonly] [default to false] +**ownerRef** | **(optional)** **CampaigntemplateOwnerRefV1** | | [default to undefined] +**deadlineDuration** | **(optional)** **string** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign\'s deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was \"P2W\" (two weeks), the resulting campaign\'s deadline would be 2020-01-15 (the current date plus 14 days). | [default to undefined] +**campaign** | **Campaign2V1** | | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/CampaigntemplateOwnerRef.md b/sdk-output/certification_campaigns/docs/Models/CampaigntemplateOwnerRef.md new file mode 100644 index 00000000..f5434428 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/CampaigntemplateOwnerRef.md @@ -0,0 +1,22 @@ +--- +id: v1-campaigntemplate-owner-ref-v1 +title: CampaigntemplateOwnerRefV1 +pagination_label: CampaigntemplateOwnerRefV1 +sidebar_label: CampaigntemplateOwnerRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigntemplateOwnerRefV1', 'v1CampaigntemplateOwnerRefV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/campaigntemplate-owner-ref-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigntemplateOwnerRefV1', 'v1CampaigntemplateOwnerRefV1'] +--- + +# CampaigntemplateOwnerRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the owner | [default to undefined] +**type** | **(optional)** **string** | Type of the owner | [default to undefined] +**name** | **(optional)** **string** | Name of the owner | [default to undefined] +**email** | **(optional)** **string** | Email of the owner | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Certificationtask.md b/sdk-output/certification_campaigns/docs/Models/Certificationtask.md new file mode 100644 index 00000000..8a2cbb2d --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Certificationtask.md @@ -0,0 +1,26 @@ +--- +id: v1-certificationtask-v1 +title: CertificationtaskV1 +pagination_label: CertificationtaskV1 +sidebar_label: CertificationtaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationtaskV1', 'v1CertificationtaskV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/certificationtask-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationtaskV1', 'v1CertificationtaskV1'] +--- + +# CertificationtaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the certification task. | [default to undefined] +**type** | **(optional)** **string** | The type of the certification task. More values may be added in the future. | [default to undefined] +**targetType** | **(optional)** **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [default to undefined] +**targetId** | **(optional)** **string** | The ID of the item being operated on by this task. | [default to undefined] +**status** | **(optional)** **string** | The status of the task. | [default to undefined] +**errors** | **(optional)** **Array<ErrormessagedtoV1>** | List of error messages | [default to undefined] +**reassignmentTrailDTOs** | **(optional)** **Array<ReassignmenttraildtoV1>** | Reassignment trails that lead to self certification identity | [default to undefined] +**created** | **(optional)** **string** | The date and time on which this task was created. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Errormessagedto.md b/sdk-output/certification_campaigns/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b7fe30d3 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Errorresponsedto.md b/sdk-output/certification_campaigns/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..952d85c4 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1200ResponseInner.md b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1200ResponseInner.md new file mode 100644 index 00000000..50ec566e --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1200ResponseInner.md @@ -0,0 +1,41 @@ +--- +id: v1-get-active-campaigns-v1200-response-inner-v1 +title: GetActiveCampaignsV1200ResponseInnerV1 +pagination_label: GetActiveCampaignsV1200ResponseInnerV1 +sidebar_label: GetActiveCampaignsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetActiveCampaignsV1200ResponseInnerV1', 'v1GetActiveCampaignsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/get-active-campaigns-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaignsV1200ResponseInnerV1', 'v1GetActiveCampaignsV1200ResponseInnerV1'] +--- + +# GetActiveCampaignsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the campaign | [readonly] [default to undefined] +**name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**deadline** | **(optional)** **string** | The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [default to undefined] +**type** | **string** | The type of campaign. Could be extended in the future. | [default to undefined] +**emailNotificationEnabled** | **(optional)** **boolean** | Enables email notification for this campaign | [default to false] +**autoRevokeAllowed** | **(optional)** **boolean** | Allows auto revoke for this campaign | [default to false] +**recommendationsEnabled** | **(optional)** **boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [default to false] +**status** | **(optional)** **string** | The campaign\'s current status. | [readonly] [default to undefined] +**correlatedStatus** | **(optional)** **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**created** | **(optional)** **string** | Created time of the campaign | [readonly] [default to undefined] +**totalCertifications** | **(optional)** **number** | The total number of certifications in this campaign. | [readonly] [default to undefined] +**completedCertifications** | **(optional)** **number** | The number of completed certifications in this campaign. | [readonly] [default to undefined] +**alerts** | **(optional)** **Array<CampaignalertV1>** | A list of errors and warnings that have accumulated. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Modified time of the campaign | [readonly] [default to undefined] +**filter** | **(optional)** **Campaign2AllOfFilterV1** | | [default to undefined] +**sunsetCommentsRequired** | **(optional)** **boolean** | Determines if comments on sunset date changes are required. | [default to true] +**sourceOwnerCampaignInfo** | **(optional)** **Campaign2AllOfSourceOwnerCampaignInfoV1** | | [default to undefined] +**searchCampaignInfo** | **(optional)** **Campaign2AllOfSearchCampaignInfoV1** | | [default to undefined] +**roleCompositionCampaignInfo** | **(optional)** **Campaign2AllOfRoleCompositionCampaignInfoV1** | | [default to undefined] +**machineAccountCampaignInfo** | **(optional)** **Campaign2AllOfMachineAccountCampaignInfoV1** | | [default to undefined] +**sourcesWithOrphanEntitlements** | **(optional)** **Array<Campaign2AllOfSourcesWithOrphanEntitlementsV1>** | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [readonly] [default to undefined] +**mandatoryCommentRequirement** | **(optional)** **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1401Response.md b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1401Response.md new file mode 100644 index 00000000..796d3e83 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-active-campaigns-v1401-response-v1 +title: GetActiveCampaignsV1401ResponseV1 +pagination_label: GetActiveCampaignsV1401ResponseV1 +sidebar_label: GetActiveCampaignsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetActiveCampaignsV1401ResponseV1', 'v1GetActiveCampaignsV1401ResponseV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/get-active-campaigns-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaignsV1401ResponseV1', 'v1GetActiveCampaignsV1401ResponseV1'] +--- + +# GetActiveCampaignsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1429Response.md b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1429Response.md new file mode 100644 index 00000000..a1e7fe94 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/GetActiveCampaignsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-active-campaigns-v1429-response-v1 +title: GetActiveCampaignsV1429ResponseV1 +pagination_label: GetActiveCampaignsV1429ResponseV1 +sidebar_label: GetActiveCampaignsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetActiveCampaignsV1429ResponseV1', 'v1GetActiveCampaignsV1429ResponseV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/get-active-campaigns-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaignsV1429ResponseV1', 'v1GetActiveCampaignsV1429ResponseV1'] +--- + +# GetActiveCampaignsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/GetCampaignV1200Response.md b/sdk-output/certification_campaigns/docs/Models/GetCampaignV1200Response.md new file mode 100644 index 00000000..0ac1ad8e --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/GetCampaignV1200Response.md @@ -0,0 +1,41 @@ +--- +id: v1-get-campaign-v1200-response-v1 +title: GetCampaignV1200ResponseV1 +pagination_label: GetCampaignV1200ResponseV1 +sidebar_label: GetCampaignV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetCampaignV1200ResponseV1', 'v1GetCampaignV1200ResponseV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/get-campaign-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetCampaignV1200ResponseV1', 'v1GetCampaignV1200ResponseV1'] +--- + +# GetCampaignV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the campaign | [readonly] [default to undefined] +**name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**deadline** | **(optional)** **string** | The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [default to undefined] +**type** | **string** | The type of campaign. Could be extended in the future. | [default to undefined] +**emailNotificationEnabled** | **(optional)** **boolean** | Enables email notification for this campaign | [default to false] +**autoRevokeAllowed** | **(optional)** **boolean** | Allows auto revoke for this campaign | [default to false] +**recommendationsEnabled** | **(optional)** **boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [default to false] +**status** | **(optional)** **string** | The campaign\'s current status. | [readonly] [default to undefined] +**correlatedStatus** | **(optional)** **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**created** | **(optional)** **string** | Created time of the campaign | [readonly] [default to undefined] +**totalCertifications** | **(optional)** **number** | The total number of certifications in this campaign. | [readonly] [default to undefined] +**completedCertifications** | **(optional)** **number** | The number of completed certifications in this campaign. | [readonly] [default to undefined] +**alerts** | **(optional)** **Array<CampaignalertV1>** | A list of errors and warnings that have accumulated. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Modified time of the campaign | [readonly] [default to undefined] +**filter** | **(optional)** **Campaign2AllOfFilterV1** | | [default to undefined] +**sunsetCommentsRequired** | **(optional)** **boolean** | Determines if comments on sunset date changes are required. | [default to true] +**sourceOwnerCampaignInfo** | **(optional)** **Campaign2AllOfSourceOwnerCampaignInfoV1** | | [default to undefined] +**searchCampaignInfo** | **(optional)** **Campaign2AllOfSearchCampaignInfoV1** | | [default to undefined] +**roleCompositionCampaignInfo** | **(optional)** **Campaign2AllOfRoleCompositionCampaignInfoV1** | | [default to undefined] +**machineAccountCampaignInfo** | **(optional)** **Campaign2AllOfMachineAccountCampaignInfoV1** | | [default to undefined] +**sourcesWithOrphanEntitlements** | **(optional)** **Array<Campaign2AllOfSourcesWithOrphanEntitlementsV1>** | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [readonly] [default to undefined] +**mandatoryCommentRequirement** | **(optional)** **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Index.md b/sdk-output/certification_campaigns/docs/Models/Index.md new file mode 100644 index 00000000..a215dec9 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: certification_campaigns-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: certification_campaigns-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_campaigns', 'models'] +slug: /tools/sdk/typescript/certification_campaigns/models +tags: ['SDK', 'Software Development Kit', 'certification_campaigns', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/certification_campaigns/docs/Models/Jsonpatchoperation.md b/sdk-output/certification_campaigns/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..7e9d2e5f --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/JsonpatchoperationValue.md b/sdk-output/certification_campaigns/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..9c45c73e --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/certification_campaigns/docs/Models/Localeorigin.md b/sdk-output/certification_campaigns/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e0489d19 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/certification_campaigns/docs/Models/README.md b/sdk-output/certification_campaigns/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_campaigns/docs/Models/Reassignmenttraildto.md b/sdk-output/certification_campaigns/docs/Models/Reassignmenttraildto.md new file mode 100644 index 00000000..616b4638 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Reassignmenttraildto.md @@ -0,0 +1,21 @@ +--- +id: v1-reassignmenttraildto-v1 +title: ReassignmenttraildtoV1 +pagination_label: ReassignmenttraildtoV1 +sidebar_label: ReassignmenttraildtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmenttraildtoV1', 'v1ReassignmenttraildtoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/reassignmenttraildto-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmenttraildtoV1', 'v1ReassignmenttraildtoV1'] +--- + +# ReassignmenttraildtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previousOwner** | **(optional)** **string** | The ID of previous owner identity. | [default to undefined] +**newOwner** | **(optional)** **string** | The ID of new owner identity. | [default to undefined] +**reassignmentType** | **(optional)** **string** | The type of reassignment. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Reportresultreference.md b/sdk-output/certification_campaigns/docs/Models/Reportresultreference.md new file mode 100644 index 00000000..e8950c9e --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Reportresultreference.md @@ -0,0 +1,22 @@ +--- +id: v1-reportresultreference-v1 +title: ReportresultreferenceV1 +pagination_label: ReportresultreferenceV1 +sidebar_label: ReportresultreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportresultreferenceV1', 'v1ReportresultreferenceV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/reportresultreference-v1 +tags: ['SDK', 'Software Development Kit', 'ReportresultreferenceV1', 'v1ReportresultreferenceV1'] +--- + +# ReportresultreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy violation report result DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy violation report result ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of the SOD policy violation report result. | [default to undefined] +**status** | **(optional)** **string** | Status of a SOD policy violation report. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Reporttype.md b/sdk-output/certification_campaigns/docs/Models/Reporttype.md new file mode 100644 index 00000000..b5d01aad --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Reporttype.md @@ -0,0 +1,25 @@ +--- +id: v1-reporttype-v1 +title: ReporttypeV1 +pagination_label: ReporttypeV1 +sidebar_label: ReporttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReporttypeV1', 'v1ReporttypeV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/reporttype-v1 +tags: ['SDK', 'Software Development Kit', 'ReporttypeV1', 'v1ReporttypeV1'] +--- + +# ReporttypeV1 + +## Enum + + +* `CampaignCompositionReport` (value: `'CAMPAIGN_COMPOSITION_REPORT'`) + +* `CampaignRemediationStatusReport` (value: `'CAMPAIGN_REMEDIATION_STATUS_REPORT'`) + +* `CampaignStatusReport` (value: `'CAMPAIGN_STATUS_REPORT'`) + +* `CertificationSignoffReport` (value: `'CERTIFICATION_SIGNOFF_REPORT'`) + + diff --git a/sdk-output/certification_campaigns/docs/Models/Schedule2.md b/sdk-output/certification_campaigns/docs/Models/Schedule2.md new file mode 100644 index 00000000..a31323e3 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Schedule2.md @@ -0,0 +1,24 @@ +--- +id: v1-schedule2-v1 +title: Schedule2V1 +pagination_label: Schedule2V1 +sidebar_label: Schedule2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Schedule2V1', 'v1Schedule2V1'] +slug: /tools/sdk/typescript/certification_campaigns/models/schedule2-v1 +tags: ['SDK', 'Software Development Kit', 'Schedule2V1', 'v1Schedule2V1'] +--- + +# Schedule2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have \'hours\' set, but not \'days\'; a WEEKLY schedule can have both \'hours\' and \'days\' set. | [default to undefined] +**months** | **(optional)** **Schedule2MonthsV1** | | [default to undefined] +**days** | **(optional)** **Schedule2DaysV1** | | [default to undefined] +**hours** | **Schedule2HoursV1** | | [default to undefined] +**expiration** | **(optional)** **string** | Specifies the time after which this schedule will no longer occur. | [default to undefined] +**timeZoneId** | **(optional)** **string** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST. | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Schedule2Days.md b/sdk-output/certification_campaigns/docs/Models/Schedule2Days.md new file mode 100644 index 00000000..f41971ea --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Schedule2Days.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule2-days-v1 +title: Schedule2DaysV1 +pagination_label: Schedule2DaysV1 +sidebar_label: Schedule2DaysV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Schedule2DaysV1', 'v1Schedule2DaysV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/schedule2-days-v1 +tags: ['SDK', 'Software Development Kit', 'Schedule2DaysV1', 'v1Schedule2DaysV1'] +--- + +# Schedule2DaysV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Enum type to specify days value | [default to undefined] +**values** | **Array<string>** | Values of the days based on the enum type mentioned above | [default to undefined] +**interval** | **(optional)** **number** | Interval between the cert generations | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Schedule2Hours.md b/sdk-output/certification_campaigns/docs/Models/Schedule2Hours.md new file mode 100644 index 00000000..52158531 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Schedule2Hours.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule2-hours-v1 +title: Schedule2HoursV1 +pagination_label: Schedule2HoursV1 +sidebar_label: Schedule2HoursV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Schedule2HoursV1', 'v1Schedule2HoursV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/schedule2-hours-v1 +tags: ['SDK', 'Software Development Kit', 'Schedule2HoursV1', 'v1Schedule2HoursV1'] +--- + +# Schedule2HoursV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Enum type to specify hours value | [default to undefined] +**values** | **Array<string>** | Values of the days based on the enum type mentioned above | [default to undefined] +**interval** | **(optional)** **number** | Interval between the cert generations | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Schedule2Months.md b/sdk-output/certification_campaigns/docs/Models/Schedule2Months.md new file mode 100644 index 00000000..ed0ebf6f --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Schedule2Months.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule2-months-v1 +title: Schedule2MonthsV1 +pagination_label: Schedule2MonthsV1 +sidebar_label: Schedule2MonthsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Schedule2MonthsV1', 'v1Schedule2MonthsV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/schedule2-months-v1 +tags: ['SDK', 'Software Development Kit', 'Schedule2MonthsV1', 'v1Schedule2MonthsV1'] +--- + +# Schedule2MonthsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Enum type to specify months value | [default to undefined] +**values** | **Array<string>** | Values of the months based on the enum type mentioned above | [default to undefined] +**interval** | **(optional)** **number** | Interval between the cert generations | [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Slimcampaign.md b/sdk-output/certification_campaigns/docs/Models/Slimcampaign.md new file mode 100644 index 00000000..7ea67fa8 --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Slimcampaign.md @@ -0,0 +1,32 @@ +--- +id: v1-slimcampaign-v1 +title: SlimcampaignV1 +pagination_label: SlimcampaignV1 +sidebar_label: SlimcampaignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SlimcampaignV1', 'v1SlimcampaignV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/slimcampaign-v1 +tags: ['SDK', 'Software Development Kit', 'SlimcampaignV1', 'v1SlimcampaignV1'] +--- + +# SlimcampaignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the campaign | [readonly] [default to undefined] +**name** | **string** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**description** | **string** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [default to undefined] +**deadline** | **(optional)** **string** | The campaign\'s completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [default to undefined] +**type** | **string** | The type of campaign. Could be extended in the future. | [default to undefined] +**emailNotificationEnabled** | **(optional)** **boolean** | Enables email notification for this campaign | [default to false] +**autoRevokeAllowed** | **(optional)** **boolean** | Allows auto revoke for this campaign | [default to false] +**recommendationsEnabled** | **(optional)** **boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [default to false] +**status** | **(optional)** **string** | The campaign\'s current status. | [readonly] [default to undefined] +**correlatedStatus** | **(optional)** **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**created** | **(optional)** **string** | Created time of the campaign | [readonly] [default to undefined] +**totalCertifications** | **(optional)** **number** | The total number of certifications in this campaign. | [readonly] [default to undefined] +**completedCertifications** | **(optional)** **number** | The number of completed certifications in this campaign. | [readonly] [default to undefined] +**alerts** | **(optional)** **Array<CampaignalertV1>** | A list of errors and warnings that have accumulated. | [readonly] [default to undefined] + diff --git a/sdk-output/certification_campaigns/docs/Models/Sodreportresultdto.md b/sdk-output/certification_campaigns/docs/Models/Sodreportresultdto.md new file mode 100644 index 00000000..4e1fbe7d --- /dev/null +++ b/sdk-output/certification_campaigns/docs/Models/Sodreportresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-sodreportresultdto-v1 +title: SodreportresultdtoV1 +pagination_label: SodreportresultdtoV1 +sidebar_label: SodreportresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodreportresultdtoV1', 'v1SodreportresultdtoV1'] +slug: /tools/sdk/typescript/certification_campaigns/models/sodreportresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'SodreportresultdtoV1', 'v1SodreportresultdtoV1'] +--- + +# SodreportresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy violation report result DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy violation report result ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of the SOD policy violation report result. | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/certification_summaries/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..050ec69e --- /dev/null +++ b/sdk-output/certification_summaries/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,73 @@ +- path: /certifications/v1/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_summaries/methods/certification-summaries#get-identity-access-summaries-v1 + source: | + import { CertificationSummariesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationSummariesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const type: string = 'ACCESS_PROFILE'; // 'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT' | The type of access review item to retrieve summaries for (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'access.name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) (default to undefined) + const result = await apiInstance.getIdentityAccessSummariesV1(id, type); + console.log(result); +- path: /certifications/v1/{id}/decision-summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_summaries/methods/certification-summaries#get-identity-decision-summary-v1 + source: | + import { CertificationSummariesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationSummariesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The certification ID (default to undefined) + const filters: string = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) (default to undefined) + const result = await apiInstance.getIdentityDecisionSummaryV1(id); + console.log(result); +- path: /certifications/v1/{id}/identity-summaries + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_summaries/methods/certification-summaries#get-identity-summaries-v1 + source: | + import { CertificationSummariesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationSummariesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const result = await apiInstance.getIdentitySummariesV1(id); + console.log(result); +- path: /certifications/v1/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certification_summaries/methods/certification-summaries#get-identity-summary-v1 + source: | + import { CertificationSummariesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationSummariesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const identitySummaryId: string = '2c91808772a504f50172a9540e501ba8'; // string | The identity summary ID (default to undefined) + const result = await apiInstance.getIdentitySummaryV1(id, identitySummaryId); + console.log(result); diff --git a/sdk-output/certification_summaries/docs/Methods/CertificationSummariesV1Api.md b/sdk-output/certification_summaries/docs/Methods/CertificationSummariesV1Api.md new file mode 100644 index 00000000..6e18095a --- /dev/null +++ b/sdk-output/certification_summaries/docs/Methods/CertificationSummariesV1Api.md @@ -0,0 +1,215 @@ +--- +id: v1-certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationSummaries', 'v1CertificationSummaries'] +slug: /tools/sdk/typescript/certification_summaries/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'v1CertificationSummaries'] +--- + +# CertificationSummariesV1Api + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certs/reviewing/index.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-identity-access-summaries-v1**](#get-identity-access-summaries-v1) | **GET** `/certifications/v1/{id}/access-summaries/{type}` | Access summaries +[**get-identity-decision-summary-v1**](#get-identity-decision-summary-v1) | **GET** `/certifications/v1/{id}/decision-summary` | Summary of certification decisions +[**get-identity-summaries-v1**](#get-identity-summaries-v1) | **GET** `/certifications/v1/{id}/identity-summaries` | Identity summaries for campaign certification +[**get-identity-summary-v1**](#get-identity-summary-v1) | **GET** `/certifications/v1/{id}/identity-summaries/{identitySummaryId}` | Summary for identity + + +## get-identity-access-summaries-v1 +Access summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-access-summaries-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**type** | **'ROLE' | 'ACCESS_PROFILE' | 'ENTITLEMENT'** | The type of access review item to retrieve summaries for | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationSummariesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationSummariesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const type: string = ACCESS_PROFILE; // The type of access review item to retrieve summaries for +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = access.id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +const sorters: string = access.name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) +const result = await apiInstance.getIdentityAccessSummariesV1(id, type); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-decision-summary-v1 +Summary of certification decisions +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-decision-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The certification ID | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* | [optional] [default to undefined] + +### Return type + +**IdentitycertdecisionsummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationSummariesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationSummariesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The certification ID +const filters: string = identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) +const result = await apiInstance.getIdentityDecisionSummaryV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-summaries-v1 +Identity summaries for campaign certification +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-summaries-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationSummariesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationSummariesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const result = await apiInstance.getIdentitySummariesV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-summary-v1 +Summary for identity +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**identitySummaryId** | **string** | The identity summary ID | [default to undefined] + +### Return type + +**CertificationidentitysummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationSummariesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationSummariesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const identitySummaryId: string = 2c91808772a504f50172a9540e501ba8; // The identity summary ID +const result = await apiInstance.getIdentitySummaryV1(id, identitySummaryId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/certification_summaries/docs/Methods/Index.md b/sdk-output/certification_summaries/docs/Methods/Index.md new file mode 100644 index 00000000..e6034941 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: certification_summaries-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: certification_summaries-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_summaries', 'methods'] +slug: /tools/sdk/typescript/certification_summaries/methods +tags: ['SDK', 'Software Development Kit', 'certification_summaries', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/certification_summaries/docs/Models/Accesssummary.md b/sdk-output/certification_summaries/docs/Models/Accesssummary.md new file mode 100644 index 00000000..a3ca831d --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Accesssummary.md @@ -0,0 +1,22 @@ +--- +id: v1-accesssummary-v1 +title: AccesssummaryV1 +pagination_label: AccesssummaryV1 +sidebar_label: AccesssummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesssummaryV1', 'v1AccesssummaryV1'] +slug: /tools/sdk/typescript/certification_summaries/models/accesssummary-v1 +tags: ['SDK', 'Software Development Kit', 'AccesssummaryV1', 'v1AccesssummaryV1'] +--- + +# AccesssummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | **(optional)** **AccesssummaryAccessV1** | | [default to undefined] +**entitlement** | **(optional)** **ReviewableentitlementV1** | | [default to undefined] +**accessProfile** | **(optional)** **ReviewableaccessprofileV1** | | [default to undefined] +**role** | **(optional)** **ReviewableroleV1** | | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/AccesssummaryAccess.md b/sdk-output/certification_summaries/docs/Models/AccesssummaryAccess.md new file mode 100644 index 00000000..87725ce9 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/AccesssummaryAccess.md @@ -0,0 +1,21 @@ +--- +id: v1-accesssummary-access-v1 +title: AccesssummaryAccessV1 +pagination_label: AccesssummaryAccessV1 +sidebar_label: AccesssummaryAccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesssummaryAccessV1', 'v1AccesssummaryAccessV1'] +slug: /tools/sdk/typescript/certification_summaries/models/accesssummary-access-v1 +tags: ['SDK', 'Software Development Kit', 'AccesssummaryAccessV1', 'v1AccesssummaryAccessV1'] +--- + +# AccesssummaryAccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The ID of the item being certified | [default to undefined] +**name** | **(optional)** **string** | The name of the item being certified | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Activityinsights.md b/sdk-output/certification_summaries/docs/Models/Activityinsights.md new file mode 100644 index 00000000..99521eeb --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Activityinsights.md @@ -0,0 +1,21 @@ +--- +id: v1-activityinsights-v1 +title: ActivityinsightsV1 +pagination_label: ActivityinsightsV1 +sidebar_label: ActivityinsightsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ActivityinsightsV1', 'v1ActivityinsightsV1'] +slug: /tools/sdk/typescript/certification_summaries/models/activityinsights-v1 +tags: ['SDK', 'Software Development Kit', 'ActivityinsightsV1', 'v1ActivityinsightsV1'] +--- + +# ActivityinsightsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountID** | **(optional)** **string** | UUID of the account | [default to undefined] +**usageDays** | **(optional)** **number** | The number of days of activity | [default to undefined] +**usageDaysState** | **(optional)** **string** | Status indicating if the activity is complete or unknown | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Certificationidentitysummary.md b/sdk-output/certification_summaries/docs/Models/Certificationidentitysummary.md new file mode 100644 index 00000000..513b060a --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Certificationidentitysummary.md @@ -0,0 +1,22 @@ +--- +id: v1-certificationidentitysummary-v1 +title: CertificationidentitysummaryV1 +pagination_label: CertificationidentitysummaryV1 +sidebar_label: CertificationidentitysummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationidentitysummaryV1', 'v1CertificationidentitysummaryV1'] +slug: /tools/sdk/typescript/certification_summaries/models/certificationidentitysummary-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationidentitysummaryV1', 'v1CertificationidentitysummaryV1'] +--- + +# CertificationidentitysummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the identity summary | [default to undefined] +**name** | **(optional)** **string** | Name of the linked identity | [default to undefined] +**identityId** | **(optional)** **string** | The ID of the identity being certified | [default to undefined] +**completed** | **(optional)** **boolean** | Indicates whether the review items for the linked identity\'s certification have been completed | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Dataaccess.md b/sdk-output/certification_summaries/docs/Models/Dataaccess.md new file mode 100644 index 00000000..071f0ea8 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Dataaccess.md @@ -0,0 +1,21 @@ +--- +id: v1-dataaccess-v1 +title: DataaccessV1 +pagination_label: DataaccessV1 +sidebar_label: DataaccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessV1', 'v1DataaccessV1'] +slug: /tools/sdk/typescript/certification_summaries/models/dataaccess-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessV1', 'v1DataaccessV1'] +--- + +# DataaccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policies** | **(optional)** **Array<DataaccessPoliciesInnerV1>** | List of classification policies that apply to resources the entitlement \\ groups has access to | [default to undefined] +**categories** | **(optional)** **Array<DataaccessCategoriesInnerV1>** | List of classification categories that apply to resources the entitlement \\ groups has access to | [default to undefined] +**impactScore** | **(optional)** **DataaccessImpactScoreV1** | | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/DataaccessCategoriesInner.md b/sdk-output/certification_summaries/docs/Models/DataaccessCategoriesInner.md new file mode 100644 index 00000000..dc5b4891 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/DataaccessCategoriesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-dataaccess-categories-inner-v1 +title: DataaccessCategoriesInnerV1 +pagination_label: DataaccessCategoriesInnerV1 +sidebar_label: DataaccessCategoriesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessCategoriesInnerV1', 'v1DataaccessCategoriesInnerV1'] +slug: /tools/sdk/typescript/certification_summaries/models/dataaccess-categories-inner-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessCategoriesInnerV1', 'v1DataaccessCategoriesInnerV1'] +--- + +# DataaccessCategoriesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Value of the category | [default to undefined] +**matchCount** | **(optional)** **number** | Number of matched for each category | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/DataaccessImpactScore.md b/sdk-output/certification_summaries/docs/Models/DataaccessImpactScore.md new file mode 100644 index 00000000..8dec8a04 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/DataaccessImpactScore.md @@ -0,0 +1,19 @@ +--- +id: v1-dataaccess-impact-score-v1 +title: DataaccessImpactScoreV1 +pagination_label: DataaccessImpactScoreV1 +sidebar_label: DataaccessImpactScoreV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessImpactScoreV1', 'v1DataaccessImpactScoreV1'] +slug: /tools/sdk/typescript/certification_summaries/models/dataaccess-impact-score-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessImpactScoreV1', 'v1DataaccessImpactScoreV1'] +--- + +# DataaccessImpactScoreV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Impact Score for this data | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/DataaccessPoliciesInner.md b/sdk-output/certification_summaries/docs/Models/DataaccessPoliciesInner.md new file mode 100644 index 00000000..8dd5a633 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/DataaccessPoliciesInner.md @@ -0,0 +1,19 @@ +--- +id: v1-dataaccess-policies-inner-v1 +title: DataaccessPoliciesInnerV1 +pagination_label: DataaccessPoliciesInnerV1 +sidebar_label: DataaccessPoliciesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessPoliciesInnerV1', 'v1DataaccessPoliciesInnerV1'] +slug: /tools/sdk/typescript/certification_summaries/models/dataaccess-policies-inner-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessPoliciesInnerV1', 'v1DataaccessPoliciesInnerV1'] +--- + +# DataaccessPoliciesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Value of the policy | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Dtotype.md b/sdk-output/certification_summaries/docs/Models/Dtotype.md new file mode 100644 index 00000000..21fce1c4 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/certification_summaries/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/certification_summaries/docs/Models/Errormessagedto.md b/sdk-output/certification_summaries/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..ade8c892 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/certification_summaries/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Errorresponsedto.md b/sdk-output/certification_summaries/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cab51776 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/certification_summaries/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1401Response.md b/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1401Response.md new file mode 100644 index 00000000..8750d184 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-identity-decision-summary-v1401-response-v1 +title: GetIdentityDecisionSummaryV1401ResponseV1 +pagination_label: GetIdentityDecisionSummaryV1401ResponseV1 +sidebar_label: GetIdentityDecisionSummaryV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityDecisionSummaryV1401ResponseV1', 'v1GetIdentityDecisionSummaryV1401ResponseV1'] +slug: /tools/sdk/typescript/certification_summaries/models/get-identity-decision-summary-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetIdentityDecisionSummaryV1401ResponseV1', 'v1GetIdentityDecisionSummaryV1401ResponseV1'] +--- + +# GetIdentityDecisionSummaryV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1429Response.md b/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1429Response.md new file mode 100644 index 00000000..e5fad264 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/GetIdentityDecisionSummaryV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-identity-decision-summary-v1429-response-v1 +title: GetIdentityDecisionSummaryV1429ResponseV1 +pagination_label: GetIdentityDecisionSummaryV1429ResponseV1 +sidebar_label: GetIdentityDecisionSummaryV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityDecisionSummaryV1429ResponseV1', 'v1GetIdentityDecisionSummaryV1429ResponseV1'] +slug: /tools/sdk/typescript/certification_summaries/models/get-identity-decision-summary-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetIdentityDecisionSummaryV1429ResponseV1', 'v1GetIdentityDecisionSummaryV1429ResponseV1'] +--- + +# GetIdentityDecisionSummaryV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Identitycertdecisionsummary.md b/sdk-output/certification_summaries/docs/Models/Identitycertdecisionsummary.md new file mode 100644 index 00000000..b63dc3d1 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Identitycertdecisionsummary.md @@ -0,0 +1,34 @@ +--- +id: v1-identitycertdecisionsummary-v1 +title: IdentitycertdecisionsummaryV1 +pagination_label: IdentitycertdecisionsummaryV1 +sidebar_label: IdentitycertdecisionsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycertdecisionsummaryV1', 'v1IdentitycertdecisionsummaryV1'] +slug: /tools/sdk/typescript/certification_summaries/models/identitycertdecisionsummary-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycertdecisionsummaryV1', 'v1IdentitycertdecisionsummaryV1'] +--- + +# IdentitycertdecisionsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementDecisionsMade** | **(optional)** **number** | Number of entitlement decisions that have been made | [default to undefined] +**accessProfileDecisionsMade** | **(optional)** **number** | Number of access profile decisions that have been made | [default to undefined] +**roleDecisionsMade** | **(optional)** **number** | Number of role decisions that have been made | [default to undefined] +**accountDecisionsMade** | **(optional)** **number** | Number of account decisions that have been made | [default to undefined] +**entitlementDecisionsTotal** | **(optional)** **number** | The total number of entitlement decisions on the certification, both complete and incomplete | [default to undefined] +**accessProfileDecisionsTotal** | **(optional)** **number** | The total number of access profile decisions on the certification, both complete and incomplete | [default to undefined] +**roleDecisionsTotal** | **(optional)** **number** | The total number of role decisions on the certification, both complete and incomplete | [default to undefined] +**accountDecisionsTotal** | **(optional)** **number** | The total number of account decisions on the certification, both complete and incomplete | [default to undefined] +**entitlementsApproved** | **(optional)** **number** | The number of entitlement decisions that have been made which were approved | [default to undefined] +**entitlementsRevoked** | **(optional)** **number** | The number of entitlement decisions that have been made which were revoked | [default to undefined] +**accessProfilesApproved** | **(optional)** **number** | The number of access profile decisions that have been made which were approved | [default to undefined] +**accessProfilesRevoked** | **(optional)** **number** | The number of access profile decisions that have been made which were revoked | [default to undefined] +**rolesApproved** | **(optional)** **number** | The number of role decisions that have been made which were approved | [default to undefined] +**rolesRevoked** | **(optional)** **number** | The number of role decisions that have been made which were revoked | [default to undefined] +**accountsApproved** | **(optional)** **number** | The number of account decisions that have been made which were approved | [default to undefined] +**accountsRevoked** | **(optional)** **number** | The number of account decisions that have been made which were revoked | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Identityreferencewithnameandemail.md b/sdk-output/certification_summaries/docs/Models/Identityreferencewithnameandemail.md new file mode 100644 index 00000000..2e4d0176 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Identityreferencewithnameandemail.md @@ -0,0 +1,22 @@ +--- +id: v1-identityreferencewithnameandemail-v1 +title: IdentityreferencewithnameandemailV1 +pagination_label: IdentityreferencewithnameandemailV1 +sidebar_label: IdentityreferencewithnameandemailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +slug: /tools/sdk/typescript/certification_summaries/models/identityreferencewithnameandemail-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +--- + +# IdentityreferencewithnameandemailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type can only be IDENTITY. This is read-only. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s human-readable display name. This is read-only. | [default to undefined] +**email** | **(optional)** **string** | Identity\'s email address. This is read-only. | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Index.md b/sdk-output/certification_summaries/docs/Models/Index.md new file mode 100644 index 00000000..e76d4210 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: certification_summaries-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: certification_summaries-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'certification_summaries', 'models'] +slug: /tools/sdk/typescript/certification_summaries/models +tags: ['SDK', 'Software Development Kit', 'certification_summaries', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/certification_summaries/docs/Models/Localeorigin.md b/sdk-output/certification_summaries/docs/Models/Localeorigin.md new file mode 100644 index 00000000..12b18bd4 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/certification_summaries/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/certification_summaries/docs/Models/README.md b/sdk-output/certification_summaries/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certification_summaries/docs/Models/Reviewableaccessprofile.md b/sdk-output/certification_summaries/docs/Models/Reviewableaccessprofile.md new file mode 100644 index 00000000..724da08a --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Reviewableaccessprofile.md @@ -0,0 +1,28 @@ +--- +id: v1-reviewableaccessprofile-v1 +title: ReviewableaccessprofileV1 +pagination_label: ReviewableaccessprofileV1 +sidebar_label: ReviewableaccessprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableaccessprofileV1', 'v1ReviewableaccessprofileV1'] +slug: /tools/sdk/typescript/certification_summaries/models/reviewableaccessprofile-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableaccessprofileV1', 'v1ReviewableaccessprofileV1'] +--- + +# ReviewableaccessprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the Access Profile | [default to undefined] +**name** | **(optional)** **string** | Name of the Access Profile | [default to undefined] +**description** | **(optional)** **string** | Information about the Access Profile | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to undefined] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to undefined] +**endDate** | **(optional)** **string** | The date at which a user\'s access expires | [default to undefined] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**entitlements** | **(optional)** **Array<ReviewableentitlementV1>** | A list of entitlements associated with this Access Profile | [default to undefined] +**created** | **(optional)** **string** | Date the Access Profile was created. | [default to undefined] +**modified** | **(optional)** **string** | Date the Access Profile was last modified. | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Reviewableentitlement.md b/sdk-output/certification_summaries/docs/Models/Reviewableentitlement.md new file mode 100644 index 00000000..8b50a69c --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Reviewableentitlement.md @@ -0,0 +1,36 @@ +--- +id: v1-reviewableentitlement-v1 +title: ReviewableentitlementV1 +pagination_label: ReviewableentitlementV1 +sidebar_label: ReviewableentitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementV1', 'v1ReviewableentitlementV1'] +slug: /tools/sdk/typescript/certification_summaries/models/reviewableentitlement-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementV1', 'v1ReviewableentitlementV1'] +--- + +# ReviewableentitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id for the entitlement | [default to undefined] +**name** | **(optional)** **string** | The name of the entitlement | [default to undefined] +**description** | **(optional)** **string** | Information about the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to false] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**attributeName** | **(optional)** **string** | The name of the attribute on the source | [default to undefined] +**attributeValue** | **(optional)** **string** | The value of the attribute on the source | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The schema object type on the source used to represent the entitlement and its attributes | [default to undefined] +**sourceName** | **(optional)** **string** | The name of the source for which this entitlement belongs | [default to undefined] +**sourceType** | **(optional)** **string** | The type of the source for which the entitlement belongs | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source for which the entitlement belongs | [default to undefined] +**hasPermissions** | **(optional)** **boolean** | Indicates if the entitlement has permissions | [default to false] +**isPermission** | **(optional)** **boolean** | Indicates if the entitlement is a representation of an account permission | [default to false] +**revocable** | **(optional)** **boolean** | Indicates whether the entitlement can be revoked | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**containsDataAccess** | **(optional)** **boolean** | True if the entitlement has DAS data | [default to false] +**dataAccess** | **(optional)** **DataaccessV1** | | [default to undefined] +**account** | **(optional)** **ReviewableentitlementAccountV1** | | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccount.md b/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccount.md new file mode 100644 index 00000000..7421efc7 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccount.md @@ -0,0 +1,30 @@ +--- +id: v1-reviewableentitlement-account-v1 +title: ReviewableentitlementAccountV1 +pagination_label: ReviewableentitlementAccountV1 +sidebar_label: ReviewableentitlementAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementAccountV1', 'v1ReviewableentitlementAccountV1'] +slug: /tools/sdk/typescript/certification_summaries/models/reviewableentitlement-account-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementAccountV1', 'v1ReviewableentitlementAccountV1'] +--- + +# ReviewableentitlementAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nativeIdentity** | **(optional)** **string** | The native identity for this account | [default to undefined] +**disabled** | **(optional)** **boolean** | Indicates whether this account is currently disabled | [default to false] +**locked** | **(optional)** **boolean** | Indicates whether this account is currently locked | [default to false] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The id associated with the account | [default to undefined] +**name** | **(optional)** **string** | The account name | [default to undefined] +**created** | **(optional)** **string** | When the account was created | [default to undefined] +**modified** | **(optional)** **string** | When the account was last modified | [default to undefined] +**activityInsights** | **(optional)** **ActivityinsightsV1** | | [default to undefined] +**description** | **(optional)** **string** | Information about the account | [default to undefined] +**governanceGroupId** | **(optional)** **string** | The id associated with the machine Account Governance Group | [default to undefined] +**owner** | **(optional)** **ReviewableentitlementAccountOwnerV1** | | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccountOwner.md b/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccountOwner.md new file mode 100644 index 00000000..8109b356 --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/ReviewableentitlementAccountOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-reviewableentitlement-account-owner-v1 +title: ReviewableentitlementAccountOwnerV1 +pagination_label: ReviewableentitlementAccountOwnerV1 +sidebar_label: ReviewableentitlementAccountOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementAccountOwnerV1', 'v1ReviewableentitlementAccountOwnerV1'] +slug: /tools/sdk/typescript/certification_summaries/models/reviewableentitlement-account-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementAccountOwnerV1', 'v1ReviewableentitlementAccountOwnerV1'] +--- + +# ReviewableentitlementAccountOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id associated with the machine account owner | [default to undefined] +**type** | **(optional)** **string** | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [default to undefined] +**displayName** | **(optional)** **string** | The machine account owner\'s display name | [default to undefined] + diff --git a/sdk-output/certification_summaries/docs/Models/Reviewablerole.md b/sdk-output/certification_summaries/docs/Models/Reviewablerole.md new file mode 100644 index 00000000..52c31cce --- /dev/null +++ b/sdk-output/certification_summaries/docs/Models/Reviewablerole.md @@ -0,0 +1,27 @@ +--- +id: v1-reviewablerole-v1 +title: ReviewableroleV1 +pagination_label: ReviewableroleV1 +sidebar_label: ReviewableroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableroleV1', 'v1ReviewableroleV1'] +slug: /tools/sdk/typescript/certification_summaries/models/reviewablerole-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableroleV1', 'v1ReviewableroleV1'] +--- + +# ReviewableroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id for the Role | [default to undefined] +**name** | **(optional)** **string** | The name of the Role | [default to undefined] +**description** | **(optional)** **string** | Information about the Role | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to undefined] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**revocable** | **(optional)** **boolean** | Indicates whether the Role can be revoked or requested | [default to undefined] +**endDate** | **(optional)** **string** | The date when a user\'s access expires. | [default to undefined] +**accessProfiles** | **(optional)** **Array<ReviewableaccessprofileV1>** | The list of Access Profiles associated with this Role | [default to undefined] +**entitlements** | **(optional)** **Array<ReviewableentitlementV1>** | The list of entitlements associated with this Role | [default to undefined] + diff --git a/sdk-output/certifications/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/certifications/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..32f1b8be --- /dev/null +++ b/sdk-output/certifications/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,195 @@ +- path: /certification-tasks/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#get-certification-task-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = '63b32151-26c0-42f4-9299-8898dc1c9daa'; // string | The task ID (default to undefined) + const result = await apiInstance.getCertificationTaskV1(id); + console.log(result); +- path: /certifications/v1/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#get-identity-certification-item-permissions-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const certificationId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The certification ID (default to undefined) + const itemId: string = '2c91808671bcbab40171bd945d961227'; // string | The certification item ID (default to undefined) + const filters: string = 'target eq "SYS.OBJAUTH2"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getIdentityCertificationItemPermissionsV1(certificationId, itemId); + console.log(result); +- path: /certifications/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#get-identity-certification-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The certification id (default to undefined) + const result = await apiInstance.getIdentityCertificationV1(id); + console.log(result); +- path: /certification-tasks/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#get-pending-certification-tasks-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const reviewerIdentity: string = 'Ada.1de82e55078344'; // string | The ID of reviewer identity. *me* indicates the current user. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'type eq "ADMIN_REASSIGN"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) (default to undefined) + const result = await apiInstance.getPendingCertificationTasksV1(); + console.log(result); +- path: /certifications/v1/{id}/reviewers + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#list-certification-reviewers-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The certification ID (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq "Bob"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) (default to undefined) + const result = await apiInstance.listCertificationReviewersV1(id); + console.log(result); +- path: /certifications/v1/{id}/access-review-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#list-identity-access-review-items-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'access.name,-accessProfile.sourceName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) (default to undefined) + const entitlements: string = 'identityEntitlement'; // string | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) (default to undefined) + const accessProfiles: string = 'accessProfile1'; // string | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) (default to undefined) + const roles: string = 'userRole'; // string | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) (default to undefined) + const result = await apiInstance.listIdentityAccessReviewItemsV1(id); + console.log(result); +- path: /certifications/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#list-identity-certifications-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const reviewerIdentity: string = 'me'; // string | Reviewer\'s identity. *me* indicates the current user. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) (default to undefined) + const sorters: string = 'name,due'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) (default to undefined) + const result = await apiInstance.listIdentityCertificationsV1(); + console.log(result); +- path: /certifications/v1/{id}/decide + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#make-identity-decision-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the identity campaign certification on which to make decisions (default to undefined) + const reviewdecisionV1: Array<ReviewdecisionV1> = [{"id":"ef38f94347e94562b5bb8424a56396b5","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source."},{"id":"ef38f94347e94562b5bb8424a56397d8","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source too."}]; // Array | A non-empty array of decisions to be made. + const result = await apiInstance.makeIdentityDecisionV1(id, reviewdecisionV1); + console.log(result); +- path: /certifications/v1/{id}/reassign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#reassign-identity-certifications-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const reviewreassignV1: ReviewreassignV1 = ; // ReviewreassignV1 | + const result = await apiInstance.reassignIdentityCertificationsV1(id, reviewreassignV1); + console.log(result); +- path: /certifications/v1/{id}/sign-off + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#sign-off-identity-certification-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const result = await apiInstance.signOffIdentityCertificationV1(id); + console.log(result); +- path: /certifications/v1/{id}/reassign-async + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/certifications/methods/certifications#submit-reassign-certs-async-v1 + source: | + import { CertificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CertificationsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The identity campaign certification ID (default to undefined) + const reviewreassignV1: ReviewreassignV1 = ; // ReviewreassignV1 | + const result = await apiInstance.submitReassignCertsAsyncV1(id, reviewreassignV1); + console.log(result); diff --git a/sdk-output/certifications/docs/Methods/CertificationsV1Api.md b/sdk-output/certifications/docs/Methods/CertificationsV1Api.md new file mode 100644 index 00000000..61cd8100 --- /dev/null +++ b/sdk-output/certifications/docs/Methods/CertificationsV1Api.md @@ -0,0 +1,536 @@ +--- +id: v1-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Certifications', 'v1Certifications'] +slug: /tools/sdk/typescript/certifications/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'v1Certifications'] +--- + +# CertificationsV1Api + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-certification-task-v1**](#get-certification-task-v1) | **GET** `/certification-tasks/v1/{id}` | Certification task by id +[**get-identity-certification-item-permissions-v1**](#get-identity-certification-item-permissions-v1) | **GET** `/certifications/v1/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**get-identity-certification-v1**](#get-identity-certification-v1) | **GET** `/certifications/v1/{id}` | Identity certification by id +[**get-pending-certification-tasks-v1**](#get-pending-certification-tasks-v1) | **GET** `/certification-tasks/v1` | List of pending certification tasks +[**list-certification-reviewers-v1**](#list-certification-reviewers-v1) | **GET** `/certifications/v1/{id}/reviewers` | List of reviewers for certification +[**list-identity-access-review-items-v1**](#list-identity-access-review-items-v1) | **GET** `/certifications/v1/{id}/access-review-items` | List of access review items +[**list-identity-certifications-v1**](#list-identity-certifications-v1) | **GET** `/certifications/v1` | List identity campaign certifications +[**make-identity-decision-v1**](#make-identity-decision-v1) | **POST** `/certifications/v1/{id}/decide` | Decide on a certification item +[**reassign-identity-certifications-v1**](#reassign-identity-certifications-v1) | **POST** `/certifications/v1/{id}/reassign` | Reassign identities or items +[**sign-off-identity-certification-v1**](#sign-off-identity-certification-v1) | **POST** `/certifications/v1/{id}/sign-off` | Finalize identity certification decisions +[**submit-reassign-certs-async-v1**](#submit-reassign-certs-async-v1) | **POST** `/certifications/v1/{id}/reassign-async` | Reassign certifications asynchronously + + +## get-certification-task-v1 +Certification task by id +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-certification-task-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The task ID | [default to undefined] + +### Return type + +**CertificationtaskV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = 63b32151-26c0-42f4-9299-8898dc1c9daa; // The task ID +const result = await apiInstance.getCertificationTaskV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-certification-item-permissions-v1 +Permissions for entitlement certification item +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-certification-item-permissions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**certificationId** | **string** | The certification ID | [default to undefined] +**itemId** | **string** | The certification item ID | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const certificationId: string = ef38f94347e94562b5bb8424a56397d8; // The certification ID +const itemId: string = 2c91808671bcbab40171bd945d961227; // The certification item ID +const filters: string = target eq "SYS.OBJAUTH2"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getIdentityCertificationItemPermissionsV1(certificationId, itemId); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-certification-v1 +Identity certification by id +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-certification-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The certification id | [default to undefined] + +### Return type + +**IdentitycertificationdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The certification id +const result = await apiInstance.getIdentityCertificationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-pending-certification-tasks-v1 +List of pending certification tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-pending-certification-tasks-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reviewerIdentity** | **string** | The ID of reviewer identity. *me* indicates the current user. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const reviewerIdentity: string = Ada.1de82e55078344; // The ID of reviewer identity. *me* indicates the current user. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = type eq "ADMIN_REASSIGN"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) +const result = await apiInstance.getPendingCertificationTasksV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-certification-reviewers-v1 +List of reviewers for certification +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-certification-reviewers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The certification ID | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The certification ID +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "Bob"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) +const result = await apiInstance.listCertificationReviewersV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-access-review-items-v1 +List of access review items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-access-review-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** | [optional] [default to undefined] +**entitlements** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. | [optional] [default to undefined] +**accessProfiles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. | [optional] [default to undefined] +**roles** | **string** | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +const sorters: string = access.name,-accessProfile.sourceName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) +const entitlements: string = identityEntitlement; // Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) +const accessProfiles: string = accessProfile1; // Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) +const roles: string = userRole; // Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) +const result = await apiInstance.listIdentityAccessReviewItemsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-certifications-v1 +List identity campaign certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-certifications-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reviewerIdentity** | **string** | Reviewer\'s identity. *me* indicates the current user. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const reviewerIdentity: string = me; // Reviewer\'s identity. *me* indicates the current user. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) +const sorters: string = name,due; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) +const result = await apiInstance.listIdentityCertificationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## make-identity-decision-v1 +Decide on a certification item +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/make-identity-decision-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the identity campaign certification on which to make decisions | [default to undefined] +**reviewdecisionV1** | **Array<ReviewdecisionV1>** | A non-empty array of decisions to be made. | + +### Return type + +**IdentitycertificationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the identity campaign certification on which to make decisions +const reviewdecisionV1: Array<ReviewdecisionV1> = [{"id":"ef38f94347e94562b5bb8424a56396b5","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source."},{"id":"ef38f94347e94562b5bb8424a56397d8","decision":"APPROVE","bulk":true,"comments":"This user still needs access to this source too."}]; // A non-empty array of decisions to be made. +const result = await apiInstance.makeIdentityDecisionV1(id, reviewdecisionV1); +console.log(result); +``` + +[[Back to top]](#) + +## reassign-identity-certifications-v1 +Reassign identities or items +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reassign-identity-certifications-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**reviewreassignV1** | **ReviewreassignV1** | | + +### Return type + +**IdentitycertificationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const reviewreassignV1: ReviewreassignV1 = ; // +const result = await apiInstance.reassignIdentityCertificationsV1(id, reviewreassignV1); +console.log(result); +``` + +[[Back to top]](#) + +## sign-off-identity-certification-v1 +Finalize identity certification decisions +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/sign-off-identity-certification-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] + +### Return type + +**IdentitycertificationdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const result = await apiInstance.signOffIdentityCertificationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## submit-reassign-certs-async-v1 +Reassign certifications asynchronously +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-reassign-certs-async-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity campaign certification ID | [default to undefined] +**reviewreassignV1** | **ReviewreassignV1** | | + +### Return type + +**CertificationtaskV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CertificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CertificationsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The identity campaign certification ID +const reviewreassignV1: ReviewreassignV1 = ; // +const result = await apiInstance.submitReassignCertsAsyncV1(id, reviewreassignV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/certifications/docs/Methods/Index.md b/sdk-output/certifications/docs/Methods/Index.md new file mode 100644 index 00000000..22551b35 --- /dev/null +++ b/sdk-output/certifications/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: certifications-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: certifications-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'certifications', 'methods'] +slug: /tools/sdk/typescript/certifications/methods +tags: ['SDK', 'Software Development Kit', 'certifications', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/certifications/docs/Models/Accessreviewitem.md b/sdk-output/certifications/docs/Models/Accessreviewitem.md new file mode 100644 index 00000000..419eba57 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Accessreviewitem.md @@ -0,0 +1,25 @@ +--- +id: v1-accessreviewitem-v1 +title: AccessreviewitemV1 +pagination_label: AccessreviewitemV1 +sidebar_label: AccessreviewitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessreviewitemV1', 'v1AccessreviewitemV1'] +slug: /tools/sdk/typescript/certifications/models/accessreviewitem-v1 +tags: ['SDK', 'Software Development Kit', 'AccessreviewitemV1', 'v1AccessreviewitemV1'] +--- + +# AccessreviewitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessSummary** | **(optional)** **AccesssummaryV1** | | [default to undefined] +**identitySummary** | **(optional)** **CertificationidentitysummaryV1** | | [default to undefined] +**id** | **(optional)** **string** | The review item\'s id | [default to undefined] +**completed** | **(optional)** **boolean** | Whether the review item is complete | [default to undefined] +**newAccess** | **(optional)** **boolean** | Indicates whether the review item is for new access to a source | [default to undefined] +**decision** | **(optional)** **CertificationdecisionV1** | | [default to undefined] +**comments** | **(optional)** **string** | Comments for this review item | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Accesssummary.md b/sdk-output/certifications/docs/Models/Accesssummary.md new file mode 100644 index 00000000..84f5f5c2 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Accesssummary.md @@ -0,0 +1,22 @@ +--- +id: v1-accesssummary-v1 +title: AccesssummaryV1 +pagination_label: AccesssummaryV1 +sidebar_label: AccesssummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesssummaryV1', 'v1AccesssummaryV1'] +slug: /tools/sdk/typescript/certifications/models/accesssummary-v1 +tags: ['SDK', 'Software Development Kit', 'AccesssummaryV1', 'v1AccesssummaryV1'] +--- + +# AccesssummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | **(optional)** **AccesssummaryAccessV1** | | [default to undefined] +**entitlement** | **(optional)** **ReviewableentitlementV1** | | [default to undefined] +**accessProfile** | **(optional)** **ReviewableaccessprofileV1** | | [default to undefined] +**role** | **(optional)** **ReviewableroleV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/AccesssummaryAccess.md b/sdk-output/certifications/docs/Models/AccesssummaryAccess.md new file mode 100644 index 00000000..10952126 --- /dev/null +++ b/sdk-output/certifications/docs/Models/AccesssummaryAccess.md @@ -0,0 +1,21 @@ +--- +id: v1-accesssummary-access-v1 +title: AccesssummaryAccessV1 +pagination_label: AccesssummaryAccessV1 +sidebar_label: AccesssummaryAccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesssummaryAccessV1', 'v1AccesssummaryAccessV1'] +slug: /tools/sdk/typescript/certifications/models/accesssummary-access-v1 +tags: ['SDK', 'Software Development Kit', 'AccesssummaryAccessV1', 'v1AccesssummaryAccessV1'] +--- + +# AccesssummaryAccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The ID of the item being certified | [default to undefined] +**name** | **(optional)** **string** | The name of the item being certified | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Activityinsights.md b/sdk-output/certifications/docs/Models/Activityinsights.md new file mode 100644 index 00000000..3812f777 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Activityinsights.md @@ -0,0 +1,21 @@ +--- +id: v1-activityinsights-v1 +title: ActivityinsightsV1 +pagination_label: ActivityinsightsV1 +sidebar_label: ActivityinsightsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ActivityinsightsV1', 'v1ActivityinsightsV1'] +slug: /tools/sdk/typescript/certifications/models/activityinsights-v1 +tags: ['SDK', 'Software Development Kit', 'ActivityinsightsV1', 'v1ActivityinsightsV1'] +--- + +# ActivityinsightsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountID** | **(optional)** **string** | UUID of the account | [default to undefined] +**usageDays** | **(optional)** **number** | The number of days of activity | [default to undefined] +**usageDaysState** | **(optional)** **string** | Status indicating if the activity is complete or unknown | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Campaignreference.md b/sdk-output/certifications/docs/Models/Campaignreference.md new file mode 100644 index 00000000..2e4fb67d --- /dev/null +++ b/sdk-output/certifications/docs/Models/Campaignreference.md @@ -0,0 +1,25 @@ +--- +id: v1-campaignreference-v1 +title: CampaignreferenceV1 +pagination_label: CampaignreferenceV1 +sidebar_label: CampaignreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +slug: /tools/sdk/typescript/certifications/models/campaignreference-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +--- + +# CampaignreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the campaign. | [default to undefined] +**name** | **string** | The name of the campaign. | [default to undefined] +**type** | **string** | The type of object that is being referenced. | [default to undefined] +**campaignType** | **string** | The type of the campaign. | [default to undefined] +**description** | **string** | The description of the campaign set by the admin who created it. | [default to undefined] +**correlatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**mandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Certificationdecision.md b/sdk-output/certifications/docs/Models/Certificationdecision.md new file mode 100644 index 00000000..0853933d --- /dev/null +++ b/sdk-output/certifications/docs/Models/Certificationdecision.md @@ -0,0 +1,21 @@ +--- +id: v1-certificationdecision-v1 +title: CertificationdecisionV1 +pagination_label: CertificationdecisionV1 +sidebar_label: CertificationdecisionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationdecisionV1', 'v1CertificationdecisionV1'] +slug: /tools/sdk/typescript/certifications/models/certificationdecision-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationdecisionV1', 'v1CertificationdecisionV1'] +--- + +# CertificationdecisionV1 + +## Enum + + +* `Approve` (value: `'APPROVE'`) + +* `Revoke` (value: `'REVOKE'`) + + diff --git a/sdk-output/certifications/docs/Models/Certificationidentitysummary.md b/sdk-output/certifications/docs/Models/Certificationidentitysummary.md new file mode 100644 index 00000000..1325f893 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Certificationidentitysummary.md @@ -0,0 +1,22 @@ +--- +id: v1-certificationidentitysummary-v1 +title: CertificationidentitysummaryV1 +pagination_label: CertificationidentitysummaryV1 +sidebar_label: CertificationidentitysummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationidentitysummaryV1', 'v1CertificationidentitysummaryV1'] +slug: /tools/sdk/typescript/certifications/models/certificationidentitysummary-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationidentitysummaryV1', 'v1CertificationidentitysummaryV1'] +--- + +# CertificationidentitysummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the identity summary | [default to undefined] +**name** | **(optional)** **string** | Name of the linked identity | [default to undefined] +**identityId** | **(optional)** **string** | The ID of the identity being certified | [default to undefined] +**completed** | **(optional)** **boolean** | Indicates whether the review items for the linked identity\'s certification have been completed | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Certificationphase.md b/sdk-output/certifications/docs/Models/Certificationphase.md new file mode 100644 index 00000000..251f67dd --- /dev/null +++ b/sdk-output/certifications/docs/Models/Certificationphase.md @@ -0,0 +1,23 @@ +--- +id: v1-certificationphase-v1 +title: CertificationphaseV1 +pagination_label: CertificationphaseV1 +sidebar_label: CertificationphaseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationphaseV1', 'v1CertificationphaseV1'] +slug: /tools/sdk/typescript/certifications/models/certificationphase-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationphaseV1', 'v1CertificationphaseV1'] +--- + +# CertificationphaseV1 + +## Enum + + +* `Staged` (value: `'STAGED'`) + +* `Active` (value: `'ACTIVE'`) + +* `Signed` (value: `'SIGNED'`) + + diff --git a/sdk-output/certifications/docs/Models/Certificationreference.md b/sdk-output/certifications/docs/Models/Certificationreference.md new file mode 100644 index 00000000..696e381f --- /dev/null +++ b/sdk-output/certifications/docs/Models/Certificationreference.md @@ -0,0 +1,22 @@ +--- +id: v1-certificationreference-v1 +title: CertificationreferenceV1 +pagination_label: CertificationreferenceV1 +sidebar_label: CertificationreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationreferenceV1', 'v1CertificationreferenceV1'] +slug: /tools/sdk/typescript/certifications/models/certificationreference-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationreferenceV1', 'v1CertificationreferenceV1'] +--- + +# CertificationreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the certification. | [default to undefined] +**name** | **(optional)** **string** | The name of the certification. | [default to undefined] +**type** | **(optional)** **string** | | [default to undefined] +**reviewer** | **(optional)** **ReviewerV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Certificationtask.md b/sdk-output/certifications/docs/Models/Certificationtask.md new file mode 100644 index 00000000..4e4de63f --- /dev/null +++ b/sdk-output/certifications/docs/Models/Certificationtask.md @@ -0,0 +1,26 @@ +--- +id: v1-certificationtask-v1 +title: CertificationtaskV1 +pagination_label: CertificationtaskV1 +sidebar_label: CertificationtaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationtaskV1', 'v1CertificationtaskV1'] +slug: /tools/sdk/typescript/certifications/models/certificationtask-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationtaskV1', 'v1CertificationtaskV1'] +--- + +# CertificationtaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the certification task. | [default to undefined] +**type** | **(optional)** **string** | The type of the certification task. More values may be added in the future. | [default to undefined] +**targetType** | **(optional)** **string** | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [default to undefined] +**targetId** | **(optional)** **string** | The ID of the item being operated on by this task. | [default to undefined] +**status** | **(optional)** **string** | The status of the task. | [default to undefined] +**errors** | **(optional)** **Array<ErrormessagedtoV1>** | List of error messages | [default to undefined] +**reassignmentTrailDTOs** | **(optional)** **Array<ReassignmenttraildtoV1>** | Reassignment trails that lead to self certification identity | [default to undefined] +**created** | **(optional)** **string** | The date and time on which this task was created. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Dataaccess.md b/sdk-output/certifications/docs/Models/Dataaccess.md new file mode 100644 index 00000000..c6f27dde --- /dev/null +++ b/sdk-output/certifications/docs/Models/Dataaccess.md @@ -0,0 +1,21 @@ +--- +id: v1-dataaccess-v1 +title: DataaccessV1 +pagination_label: DataaccessV1 +sidebar_label: DataaccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessV1', 'v1DataaccessV1'] +slug: /tools/sdk/typescript/certifications/models/dataaccess-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessV1', 'v1DataaccessV1'] +--- + +# DataaccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policies** | **(optional)** **Array<DataaccessPoliciesInnerV1>** | List of classification policies that apply to resources the entitlement \\ groups has access to | [default to undefined] +**categories** | **(optional)** **Array<DataaccessCategoriesInnerV1>** | List of classification categories that apply to resources the entitlement \\ groups has access to | [default to undefined] +**impactScore** | **(optional)** **DataaccessImpactScoreV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/DataaccessCategoriesInner.md b/sdk-output/certifications/docs/Models/DataaccessCategoriesInner.md new file mode 100644 index 00000000..467ca6df --- /dev/null +++ b/sdk-output/certifications/docs/Models/DataaccessCategoriesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-dataaccess-categories-inner-v1 +title: DataaccessCategoriesInnerV1 +pagination_label: DataaccessCategoriesInnerV1 +sidebar_label: DataaccessCategoriesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessCategoriesInnerV1', 'v1DataaccessCategoriesInnerV1'] +slug: /tools/sdk/typescript/certifications/models/dataaccess-categories-inner-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessCategoriesInnerV1', 'v1DataaccessCategoriesInnerV1'] +--- + +# DataaccessCategoriesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Value of the category | [default to undefined] +**matchCount** | **(optional)** **number** | Number of matched for each category | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/DataaccessImpactScore.md b/sdk-output/certifications/docs/Models/DataaccessImpactScore.md new file mode 100644 index 00000000..55c917e1 --- /dev/null +++ b/sdk-output/certifications/docs/Models/DataaccessImpactScore.md @@ -0,0 +1,19 @@ +--- +id: v1-dataaccess-impact-score-v1 +title: DataaccessImpactScoreV1 +pagination_label: DataaccessImpactScoreV1 +sidebar_label: DataaccessImpactScoreV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessImpactScoreV1', 'v1DataaccessImpactScoreV1'] +slug: /tools/sdk/typescript/certifications/models/dataaccess-impact-score-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessImpactScoreV1', 'v1DataaccessImpactScoreV1'] +--- + +# DataaccessImpactScoreV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Impact Score for this data | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/DataaccessPoliciesInner.md b/sdk-output/certifications/docs/Models/DataaccessPoliciesInner.md new file mode 100644 index 00000000..6bf82e45 --- /dev/null +++ b/sdk-output/certifications/docs/Models/DataaccessPoliciesInner.md @@ -0,0 +1,19 @@ +--- +id: v1-dataaccess-policies-inner-v1 +title: DataaccessPoliciesInnerV1 +pagination_label: DataaccessPoliciesInnerV1 +sidebar_label: DataaccessPoliciesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataaccessPoliciesInnerV1', 'v1DataaccessPoliciesInnerV1'] +slug: /tools/sdk/typescript/certifications/models/dataaccess-policies-inner-v1 +tags: ['SDK', 'Software Development Kit', 'DataaccessPoliciesInnerV1', 'v1DataaccessPoliciesInnerV1'] +--- + +# DataaccessPoliciesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Value of the policy | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Dtotype.md b/sdk-output/certifications/docs/Models/Dtotype.md new file mode 100644 index 00000000..34468c1d --- /dev/null +++ b/sdk-output/certifications/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/certifications/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/certifications/docs/Models/Errormessagedto.md b/sdk-output/certifications/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..aab7fa53 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/certifications/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Errorresponsedto.md b/sdk-output/certifications/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..000129aa --- /dev/null +++ b/sdk-output/certifications/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/certifications/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Identitycertificationdto.md b/sdk-output/certifications/docs/Models/Identitycertificationdto.md new file mode 100644 index 00000000..d6346b4a --- /dev/null +++ b/sdk-output/certifications/docs/Models/Identitycertificationdto.md @@ -0,0 +1,35 @@ +--- +id: v1-identitycertificationdto-v1 +title: IdentitycertificationdtoV1 +pagination_label: IdentitycertificationdtoV1 +sidebar_label: IdentitycertificationdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycertificationdtoV1', 'v1IdentitycertificationdtoV1'] +slug: /tools/sdk/typescript/certifications/models/identitycertificationdto-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycertificationdtoV1', 'v1IdentitycertificationdtoV1'] +--- + +# IdentitycertificationdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | id of the certification | [default to undefined] +**name** | **(optional)** **string** | name of the certification | [default to undefined] +**campaign** | **(optional)** **CampaignreferenceV1** | | [default to undefined] +**completed** | **(optional)** **boolean** | Have all decisions been made? | [default to undefined] +**identitiesCompleted** | **(optional)** **number** | The number of identities for whom all decisions have been made and are complete. | [default to undefined] +**identitiesTotal** | **(optional)** **number** | The total number of identities in the Certification, both complete and incomplete. | [default to undefined] +**created** | **(optional)** **string** | created date | [default to undefined] +**modified** | **(optional)** **string** | modified date | [default to undefined] +**decisionsMade** | **(optional)** **number** | The number of approve/revoke/acknowledge decisions that have been made. | [default to undefined] +**decisionsTotal** | **(optional)** **number** | The total number of approve/revoke/acknowledge decisions. | [default to undefined] +**due** | **(optional)** **string** | The due date of the certification. | [default to undefined] +**signed** | **(optional)** **string** | The date the reviewer signed off on the Certification. | [default to undefined] +**reviewer** | **(optional)** **ReviewerV1** | | [default to undefined] +**reassignment** | **(optional)** **ReassignmentV1** | | [default to undefined] +**hasErrors** | **(optional)** **boolean** | Identifies if the certification has an error | [default to undefined] +**errorMessage** | **(optional)** **string** | Description of the certification error | [default to undefined] +**phase** | **(optional)** **CertificationphaseV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Identityreferencewithnameandemail.md b/sdk-output/certifications/docs/Models/Identityreferencewithnameandemail.md new file mode 100644 index 00000000..83f1fc31 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Identityreferencewithnameandemail.md @@ -0,0 +1,22 @@ +--- +id: v1-identityreferencewithnameandemail-v1 +title: IdentityreferencewithnameandemailV1 +pagination_label: IdentityreferencewithnameandemailV1 +sidebar_label: IdentityreferencewithnameandemailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +slug: /tools/sdk/typescript/certifications/models/identityreferencewithnameandemail-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +--- + +# IdentityreferencewithnameandemailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type can only be IDENTITY. This is read-only. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s human-readable display name. This is read-only. | [default to undefined] +**email** | **(optional)** **string** | Identity\'s email address. This is read-only. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Index.md b/sdk-output/certifications/docs/Models/Index.md new file mode 100644 index 00000000..00c36c87 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: certifications-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: certifications-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'certifications', 'models'] +slug: /tools/sdk/typescript/certifications/models +tags: ['SDK', 'Software Development Kit', 'certifications', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1401Response.md b/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1401Response.md new file mode 100644 index 00000000..c849ac8e --- /dev/null +++ b/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-certifications-v1401-response-v1 +title: ListIdentityCertificationsV1401ResponseV1 +pagination_label: ListIdentityCertificationsV1401ResponseV1 +sidebar_label: ListIdentityCertificationsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityCertificationsV1401ResponseV1', 'v1ListIdentityCertificationsV1401ResponseV1'] +slug: /tools/sdk/typescript/certifications/models/list-identity-certifications-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityCertificationsV1401ResponseV1', 'v1ListIdentityCertificationsV1401ResponseV1'] +--- + +# ListIdentityCertificationsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1429Response.md b/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1429Response.md new file mode 100644 index 00000000..54c597a1 --- /dev/null +++ b/sdk-output/certifications/docs/Models/ListIdentityCertificationsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-certifications-v1429-response-v1 +title: ListIdentityCertificationsV1429ResponseV1 +pagination_label: ListIdentityCertificationsV1429ResponseV1 +sidebar_label: ListIdentityCertificationsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityCertificationsV1429ResponseV1', 'v1ListIdentityCertificationsV1429ResponseV1'] +slug: /tools/sdk/typescript/certifications/models/list-identity-certifications-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityCertificationsV1429ResponseV1', 'v1ListIdentityCertificationsV1429ResponseV1'] +--- + +# ListIdentityCertificationsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Localeorigin.md b/sdk-output/certifications/docs/Models/Localeorigin.md new file mode 100644 index 00000000..377e4d08 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/certifications/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/certifications/docs/Models/Permissiondto.md b/sdk-output/certifications/docs/Models/Permissiondto.md new file mode 100644 index 00000000..b45a750a --- /dev/null +++ b/sdk-output/certifications/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/certifications/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/README.md b/sdk-output/certifications/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/certifications/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/certifications/docs/Models/Reassignment.md b/sdk-output/certifications/docs/Models/Reassignment.md new file mode 100644 index 00000000..810e2177 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reassignment.md @@ -0,0 +1,20 @@ +--- +id: v1-reassignment-v1 +title: ReassignmentV1 +pagination_label: ReassignmentV1 +sidebar_label: ReassignmentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmentV1', 'v1ReassignmentV1'] +slug: /tools/sdk/typescript/certifications/models/reassignment-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmentV1', 'v1ReassignmentV1'] +--- + +# ReassignmentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **(optional)** **CertificationreferenceV1** | | [default to undefined] +**comment** | **(optional)** **string** | The comment entered when the Certification was reassigned | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reassignmenttraildto.md b/sdk-output/certifications/docs/Models/Reassignmenttraildto.md new file mode 100644 index 00000000..34b8234a --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reassignmenttraildto.md @@ -0,0 +1,21 @@ +--- +id: v1-reassignmenttraildto-v1 +title: ReassignmenttraildtoV1 +pagination_label: ReassignmenttraildtoV1 +sidebar_label: ReassignmenttraildtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmenttraildtoV1', 'v1ReassignmenttraildtoV1'] +slug: /tools/sdk/typescript/certifications/models/reassignmenttraildto-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmenttraildtoV1', 'v1ReassignmenttraildtoV1'] +--- + +# ReassignmenttraildtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previousOwner** | **(optional)** **string** | The ID of previous owner identity. | [default to undefined] +**newOwner** | **(optional)** **string** | The ID of new owner identity. | [default to undefined] +**reassignmentType** | **(optional)** **string** | The type of reassignment. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reassignreference.md b/sdk-output/certifications/docs/Models/Reassignreference.md new file mode 100644 index 00000000..164b0840 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reassignreference.md @@ -0,0 +1,20 @@ +--- +id: v1-reassignreference-v1 +title: ReassignreferenceV1 +pagination_label: ReassignreferenceV1 +sidebar_label: ReassignreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignreferenceV1', 'v1ReassignreferenceV1'] +slug: /tools/sdk/typescript/certifications/models/reassignreference-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignreferenceV1', 'v1ReassignreferenceV1'] +--- + +# ReassignreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of item or identity being reassigned. | [default to undefined] +**type** | **string** | The type of item or identity being reassigned. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewableaccessprofile.md b/sdk-output/certifications/docs/Models/Reviewableaccessprofile.md new file mode 100644 index 00000000..3dc39184 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewableaccessprofile.md @@ -0,0 +1,28 @@ +--- +id: v1-reviewableaccessprofile-v1 +title: ReviewableaccessprofileV1 +pagination_label: ReviewableaccessprofileV1 +sidebar_label: ReviewableaccessprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableaccessprofileV1', 'v1ReviewableaccessprofileV1'] +slug: /tools/sdk/typescript/certifications/models/reviewableaccessprofile-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableaccessprofileV1', 'v1ReviewableaccessprofileV1'] +--- + +# ReviewableaccessprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the Access Profile | [default to undefined] +**name** | **(optional)** **string** | Name of the Access Profile | [default to undefined] +**description** | **(optional)** **string** | Information about the Access Profile | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to undefined] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to undefined] +**endDate** | **(optional)** **string** | The date at which a user\'s access expires | [default to undefined] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**entitlements** | **(optional)** **Array<ReviewableentitlementV1>** | A list of entitlements associated with this Access Profile | [default to undefined] +**created** | **(optional)** **string** | Date the Access Profile was created. | [default to undefined] +**modified** | **(optional)** **string** | Date the Access Profile was last modified. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewableentitlement.md b/sdk-output/certifications/docs/Models/Reviewableentitlement.md new file mode 100644 index 00000000..00fef16e --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewableentitlement.md @@ -0,0 +1,36 @@ +--- +id: v1-reviewableentitlement-v1 +title: ReviewableentitlementV1 +pagination_label: ReviewableentitlementV1 +sidebar_label: ReviewableentitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementV1', 'v1ReviewableentitlementV1'] +slug: /tools/sdk/typescript/certifications/models/reviewableentitlement-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementV1', 'v1ReviewableentitlementV1'] +--- + +# ReviewableentitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id for the entitlement | [default to undefined] +**name** | **(optional)** **string** | The name of the entitlement | [default to undefined] +**description** | **(optional)** **string** | Information about the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to false] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**attributeName** | **(optional)** **string** | The name of the attribute on the source | [default to undefined] +**attributeValue** | **(optional)** **string** | The value of the attribute on the source | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The schema object type on the source used to represent the entitlement and its attributes | [default to undefined] +**sourceName** | **(optional)** **string** | The name of the source for which this entitlement belongs | [default to undefined] +**sourceType** | **(optional)** **string** | The type of the source for which the entitlement belongs | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source for which the entitlement belongs | [default to undefined] +**hasPermissions** | **(optional)** **boolean** | Indicates if the entitlement has permissions | [default to false] +**isPermission** | **(optional)** **boolean** | Indicates if the entitlement is a representation of an account permission | [default to false] +**revocable** | **(optional)** **boolean** | Indicates whether the entitlement can be revoked | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**containsDataAccess** | **(optional)** **boolean** | True if the entitlement has DAS data | [default to false] +**dataAccess** | **(optional)** **DataaccessV1** | | [default to undefined] +**account** | **(optional)** **ReviewableentitlementAccountV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/ReviewableentitlementAccount.md b/sdk-output/certifications/docs/Models/ReviewableentitlementAccount.md new file mode 100644 index 00000000..37c53652 --- /dev/null +++ b/sdk-output/certifications/docs/Models/ReviewableentitlementAccount.md @@ -0,0 +1,30 @@ +--- +id: v1-reviewableentitlement-account-v1 +title: ReviewableentitlementAccountV1 +pagination_label: ReviewableentitlementAccountV1 +sidebar_label: ReviewableentitlementAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementAccountV1', 'v1ReviewableentitlementAccountV1'] +slug: /tools/sdk/typescript/certifications/models/reviewableentitlement-account-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementAccountV1', 'v1ReviewableentitlementAccountV1'] +--- + +# ReviewableentitlementAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nativeIdentity** | **(optional)** **string** | The native identity for this account | [default to undefined] +**disabled** | **(optional)** **boolean** | Indicates whether this account is currently disabled | [default to false] +**locked** | **(optional)** **boolean** | Indicates whether this account is currently locked | [default to false] +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | The id associated with the account | [default to undefined] +**name** | **(optional)** **string** | The account name | [default to undefined] +**created** | **(optional)** **string** | When the account was created | [default to undefined] +**modified** | **(optional)** **string** | When the account was last modified | [default to undefined] +**activityInsights** | **(optional)** **ActivityinsightsV1** | | [default to undefined] +**description** | **(optional)** **string** | Information about the account | [default to undefined] +**governanceGroupId** | **(optional)** **string** | The id associated with the machine Account Governance Group | [default to undefined] +**owner** | **(optional)** **ReviewableentitlementAccountOwnerV1** | | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/ReviewableentitlementAccountOwner.md b/sdk-output/certifications/docs/Models/ReviewableentitlementAccountOwner.md new file mode 100644 index 00000000..5ec6383b --- /dev/null +++ b/sdk-output/certifications/docs/Models/ReviewableentitlementAccountOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-reviewableentitlement-account-owner-v1 +title: ReviewableentitlementAccountOwnerV1 +pagination_label: ReviewableentitlementAccountOwnerV1 +sidebar_label: ReviewableentitlementAccountOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableentitlementAccountOwnerV1', 'v1ReviewableentitlementAccountOwnerV1'] +slug: /tools/sdk/typescript/certifications/models/reviewableentitlement-account-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableentitlementAccountOwnerV1', 'v1ReviewableentitlementAccountOwnerV1'] +--- + +# ReviewableentitlementAccountOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id associated with the machine account owner | [default to undefined] +**type** | **(optional)** **string** | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [default to undefined] +**displayName** | **(optional)** **string** | The machine account owner\'s display name | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewablerole.md b/sdk-output/certifications/docs/Models/Reviewablerole.md new file mode 100644 index 00000000..7b2e81ad --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewablerole.md @@ -0,0 +1,27 @@ +--- +id: v1-reviewablerole-v1 +title: ReviewableroleV1 +pagination_label: ReviewableroleV1 +sidebar_label: ReviewableroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewableroleV1', 'v1ReviewableroleV1'] +slug: /tools/sdk/typescript/certifications/models/reviewablerole-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewableroleV1', 'v1ReviewableroleV1'] +--- + +# ReviewableroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id for the Role | [default to undefined] +**name** | **(optional)** **string** | The name of the Role | [default to undefined] +**description** | **(optional)** **string** | Information about the Role | [default to undefined] +**privileged** | **(optional)** **boolean** | Indicates if the entitlement is a privileged entitlement | [default to undefined] +**owner** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**revocable** | **(optional)** **boolean** | Indicates whether the Role can be revoked or requested | [default to undefined] +**endDate** | **(optional)** **string** | The date when a user\'s access expires. | [default to undefined] +**accessProfiles** | **(optional)** **Array<ReviewableaccessprofileV1>** | The list of Access Profiles associated with this Role | [default to undefined] +**entitlements** | **(optional)** **Array<ReviewableentitlementV1>** | The list of entitlements associated with this Role | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewdecision.md b/sdk-output/certifications/docs/Models/Reviewdecision.md new file mode 100644 index 00000000..5d3ed336 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewdecision.md @@ -0,0 +1,24 @@ +--- +id: v1-reviewdecision-v1 +title: ReviewdecisionV1 +pagination_label: ReviewdecisionV1 +sidebar_label: ReviewdecisionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewdecisionV1', 'v1ReviewdecisionV1'] +slug: /tools/sdk/typescript/certifications/models/reviewdecision-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewdecisionV1', 'v1ReviewdecisionV1'] +--- + +# ReviewdecisionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The id of the review decision | [default to undefined] +**decision** | **CertificationdecisionV1** | | [default to undefined] +**proposedEndDate** | **(optional)** **string** | The date at which a user\'s access should be taken away. Should only be set for `REVOKE` decisions. | [default to undefined] +**bulk** | **boolean** | Indicates whether decision should be marked as part of a larger bulk decision | [default to undefined] +**recommendation** | **(optional)** **ReviewrecommendationV1** | | [default to undefined] +**comments** | **(optional)** **string** | Comments recorded when the decision was made | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewer.md b/sdk-output/certifications/docs/Models/Reviewer.md new file mode 100644 index 00000000..21975948 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewer.md @@ -0,0 +1,24 @@ +--- +id: v1-reviewer-v1 +title: ReviewerV1 +pagination_label: ReviewerV1 +sidebar_label: ReviewerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewerV1', 'v1ReviewerV1'] +slug: /tools/sdk/typescript/certifications/models/reviewer-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewerV1', 'v1ReviewerV1'] +--- + +# ReviewerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the reviewer. | [default to undefined] +**name** | **(optional)** **string** | The name of the reviewer. | [default to undefined] +**email** | **(optional)** **string** | The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. | [default to undefined] +**type** | **(optional)** **string** | The type of the reviewing identity. | [default to undefined] +**created** | **(optional)** **string** | The created date of the reviewing identity. | [default to undefined] +**modified** | **(optional)** **string** | The modified date of the reviewing identity. | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewreassign.md b/sdk-output/certifications/docs/Models/Reviewreassign.md new file mode 100644 index 00000000..36e54ad8 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewreassign.md @@ -0,0 +1,21 @@ +--- +id: v1-reviewreassign-v1 +title: ReviewreassignV1 +pagination_label: ReviewreassignV1 +sidebar_label: ReviewreassignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewreassignV1', 'v1ReviewreassignV1'] +slug: /tools/sdk/typescript/certifications/models/reviewreassign-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewreassignV1', 'v1ReviewreassignV1'] +--- + +# ReviewreassignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassign** | **Array<ReassignreferenceV1>** | | [default to undefined] +**reassignTo** | **string** | The ID of the identity to which the certification is reassigned | [default to undefined] +**reason** | **string** | The reason comment for why the reassign was made | [default to undefined] + diff --git a/sdk-output/certifications/docs/Models/Reviewrecommendation.md b/sdk-output/certifications/docs/Models/Reviewrecommendation.md new file mode 100644 index 00000000..faa77587 --- /dev/null +++ b/sdk-output/certifications/docs/Models/Reviewrecommendation.md @@ -0,0 +1,21 @@ +--- +id: v1-reviewrecommendation-v1 +title: ReviewrecommendationV1 +pagination_label: ReviewrecommendationV1 +sidebar_label: ReviewrecommendationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewrecommendationV1', 'v1ReviewrecommendationV1'] +slug: /tools/sdk/typescript/certifications/models/reviewrecommendation-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewrecommendationV1', 'v1ReviewrecommendationV1'] +--- + +# ReviewrecommendationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommendation** | **(optional)** **string** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [default to undefined] +**reasons** | **(optional)** **Array<string>** | A list of reasons for the recommendation. | [default to undefined] +**timestamp** | **(optional)** **string** | The time at which the recommendation was recorded. | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/classify_source/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..633e48e7 --- /dev/null +++ b/sdk-output/classify_source/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,45 @@ +- path: /sources/v1/{sourceId}/classify + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/classify_source/methods/classify-source#delete-classify-machine-account-from-source-v1 + source: | + import { ClassifySourceV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ClassifySourceV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const result = await apiInstance.deleteClassifyMachineAccountFromSourceV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/classify + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/classify_source/methods/classify-source#get-classify-machine-account-from-source-status-v1 + source: | + import { ClassifySourceV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ClassifySourceV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const result = await apiInstance.getClassifyMachineAccountFromSourceStatusV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/classify + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/classify_source/methods/classify-source#send-classify-machine-account-from-source-v1 + source: | + import { ClassifySourceV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ClassifySourceV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const result = await apiInstance.sendClassifyMachineAccountFromSourceV1(sourceId); + console.log(result); diff --git a/sdk-output/classify_source/docs/Methods/ClassifySourceV1Api.md b/sdk-output/classify_source/docs/Methods/ClassifySourceV1Api.md new file mode 100644 index 00000000..cb11fd6b --- /dev/null +++ b/sdk-output/classify_source/docs/Methods/ClassifySourceV1Api.md @@ -0,0 +1,139 @@ +--- +id: v1-classify-source +title: ClassifySource +pagination_label: ClassifySource +sidebar_label: ClassifySource +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClassifySource', 'v1ClassifySource'] +slug: /tools/sdk/typescript/classify_source/methods/classify-source +tags: ['SDK', 'Software Development Kit', 'ClassifySource', 'v1ClassifySource'] +--- + +# ClassifySourceV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-classify-machine-account-from-source-v1**](#delete-classify-machine-account-from-source-v1) | **DELETE** `/sources/v1/{sourceId}/classify` | Cancel classify source\'s accounts process +[**get-classify-machine-account-from-source-status-v1**](#get-classify-machine-account-from-source-status-v1) | **GET** `/sources/v1/{sourceId}/classify` | Source accounts classification status +[**send-classify-machine-account-from-source-v1**](#send-classify-machine-account-from-source-v1) | **POST** `/sources/v1/{sourceId}/classify` | Classify source\'s all accounts + + +## delete-classify-machine-account-from-source-v1 +Cancel classify source\'s accounts process +Use this API to cancel account classification process on a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-classify-machine-account-from-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ClassifySourceV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ClassifySourceV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const result = await apiInstance.deleteClassifyMachineAccountFromSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-classify-machine-account-from-source-status-v1 +Source accounts classification status +Use this API to get the status of Machine Account Classification process for a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-classify-machine-account-from-source-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +**SourceclassificationstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ClassifySourceV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ClassifySourceV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const result = await apiInstance.getClassifyMachineAccountFromSourceStatusV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## send-classify-machine-account-from-source-v1 +Classify source\'s all accounts +Use this API to classify all the accounts from a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-classify-machine-account-from-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +**SendClassifyMachineAccountFromSourceV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ClassifySourceV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ClassifySourceV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const result = await apiInstance.sendClassifyMachineAccountFromSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/classify_source/docs/Methods/Index.md b/sdk-output/classify_source/docs/Methods/Index.md new file mode 100644 index 00000000..1c6d5767 --- /dev/null +++ b/sdk-output/classify_source/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: classify_source-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: classify_source-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'classify_source', 'methods'] +slug: /tools/sdk/typescript/classify_source/methods +tags: ['SDK', 'Software Development Kit', 'classify_source', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/classify_source/docs/Models/Errormessagedto.md b/sdk-output/classify_source/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..a427c334 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/classify_source/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/Errorresponsedto.md b/sdk-output/classify_source/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f4be6217 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/classify_source/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1401Response.md b/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1401Response.md new file mode 100644 index 00000000..aa7eb4b3 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-classify-machine-account-from-source-status-v1401-response-v1 +title: GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 +pagination_label: GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 +sidebar_label: GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetClassifyMachineAccountFromSourceStatusV1401ResponseV1', 'v1GetClassifyMachineAccountFromSourceStatusV1401ResponseV1'] +slug: /tools/sdk/typescript/classify_source/models/get-classify-machine-account-from-source-status-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetClassifyMachineAccountFromSourceStatusV1401ResponseV1', 'v1GetClassifyMachineAccountFromSourceStatusV1401ResponseV1'] +--- + +# GetClassifyMachineAccountFromSourceStatusV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1429Response.md b/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1429Response.md new file mode 100644 index 00000000..36951112 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/GetClassifyMachineAccountFromSourceStatusV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-classify-machine-account-from-source-status-v1429-response-v1 +title: GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 +pagination_label: GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 +sidebar_label: GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetClassifyMachineAccountFromSourceStatusV1429ResponseV1', 'v1GetClassifyMachineAccountFromSourceStatusV1429ResponseV1'] +slug: /tools/sdk/typescript/classify_source/models/get-classify-machine-account-from-source-status-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetClassifyMachineAccountFromSourceStatusV1429ResponseV1', 'v1GetClassifyMachineAccountFromSourceStatusV1429ResponseV1'] +--- + +# GetClassifyMachineAccountFromSourceStatusV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/Index.md b/sdk-output/classify_source/docs/Models/Index.md new file mode 100644 index 00000000..af80d9f4 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: classify_source-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: classify_source-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'classify_source', 'models'] +slug: /tools/sdk/typescript/classify_source/models +tags: ['SDK', 'Software Development Kit', 'classify_source', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/classify_source/docs/Models/Localeorigin.md b/sdk-output/classify_source/docs/Models/Localeorigin.md new file mode 100644 index 00000000..13e5748a --- /dev/null +++ b/sdk-output/classify_source/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/classify_source/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/classify_source/docs/Models/README.md b/sdk-output/classify_source/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/classify_source/docs/Models/SendClassifyMachineAccountFromSourceV1200Response.md b/sdk-output/classify_source/docs/Models/SendClassifyMachineAccountFromSourceV1200Response.md new file mode 100644 index 00000000..feb599c9 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/SendClassifyMachineAccountFromSourceV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-classify-machine-account-from-source-v1200-response-v1 +title: SendClassifyMachineAccountFromSourceV1200ResponseV1 +pagination_label: SendClassifyMachineAccountFromSourceV1200ResponseV1 +sidebar_label: SendClassifyMachineAccountFromSourceV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendClassifyMachineAccountFromSourceV1200ResponseV1', 'v1SendClassifyMachineAccountFromSourceV1200ResponseV1'] +slug: /tools/sdk/typescript/classify_source/models/send-classify-machine-account-from-source-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccountFromSourceV1200ResponseV1', 'v1SendClassifyMachineAccountFromSourceV1200ResponseV1'] +--- + +# SendClassifyMachineAccountFromSourceV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Accounts_submitted_for_processing** | **(optional)** **number** | Returns the number of all the accounts from source submitted for processing. | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/Sourceclassificationstatus.md b/sdk-output/classify_source/docs/Models/Sourceclassificationstatus.md new file mode 100644 index 00000000..f3c3b585 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/Sourceclassificationstatus.md @@ -0,0 +1,22 @@ +--- +id: v1-sourceclassificationstatus-v1 +title: SourceclassificationstatusV1 +pagination_label: SourceclassificationstatusV1 +sidebar_label: SourceclassificationstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceclassificationstatusV1', 'v1SourceclassificationstatusV1'] +slug: /tools/sdk/typescript/classify_source/models/sourceclassificationstatus-v1 +tags: ['SDK', 'Software Development Kit', 'SourceclassificationstatusV1', 'v1SourceclassificationstatusV1'] +--- + +# SourceclassificationstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **(optional)** **string** | Status of Classification Process | [default to undefined] +**started** | **(optional)** **string** | Time when the process was started | [default to undefined] +**updated** | **(optional)** **string** | Time when the process status was last updated | [default to undefined] +**counts** | **(optional)** **SourceclassificationstatusAllOfCountsV1** | | [default to undefined] + diff --git a/sdk-output/classify_source/docs/Models/SourceclassificationstatusAllOfCounts.md b/sdk-output/classify_source/docs/Models/SourceclassificationstatusAllOfCounts.md new file mode 100644 index 00000000..5ea692e8 --- /dev/null +++ b/sdk-output/classify_source/docs/Models/SourceclassificationstatusAllOfCounts.md @@ -0,0 +1,21 @@ +--- +id: v1-sourceclassificationstatus-all-of-counts-v1 +title: SourceclassificationstatusAllOfCountsV1 +pagination_label: SourceclassificationstatusAllOfCountsV1 +sidebar_label: SourceclassificationstatusAllOfCountsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceclassificationstatusAllOfCountsV1', 'v1SourceclassificationstatusAllOfCountsV1'] +slug: /tools/sdk/typescript/classify_source/models/sourceclassificationstatus-all-of-counts-v1 +tags: ['SDK', 'Software Development Kit', 'SourceclassificationstatusAllOfCountsV1', 'v1SourceclassificationstatusAllOfCountsV1'] +--- + +# SourceclassificationstatusAllOfCountsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EXPECTED** | **number** | total number of source accounts | [default to undefined] +**RECEIVED** | **number** | number of accounts that have been sent for processing (should be the same as expected when all accounts are collected) | [default to undefined] +**COMPLETED** | **number** | number of accounts that have been classified | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/configuration_hub/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..cbc70b66 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,304 @@ +- path: /configuration-hub/v1/deploys + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#create-deploy-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const deployrequestV1: DeployrequestV1 = {"draftId":"c9a38d8c-5edf-4182-9d39-f6581d3ebd05"}; // DeployrequestV1 | The deploy request body. + const result = await apiInstance.createDeployV1(deployrequestV1); + console.log(result); +- path: /configuration-hub/v1/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#create-object-mapping-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const sourceOrg: string = 'source-org'; // string | The name of the source org. (default to undefined) + const objectmappingrequestV1: ObjectmappingrequestV1 = {"objectType":"GOVERNANCE_GROUP","jsonPath":"$.description","sourceValue":"Sample Governance Group","targetValue":"Sample Governance Group - Updated","enabled":true}; // ObjectmappingrequestV1 | The object mapping request body. + const result = await apiInstance.createObjectMappingV1(sourceOrg, objectmappingrequestV1); + console.log(result); +- path: /configuration-hub/v1/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#create-object-mappings-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const sourceOrg: string = 'source-org'; // string | The name of the source org. (default to undefined) + const objectmappingbulkcreaterequestV1: ObjectmappingbulkcreaterequestV1 = {"newObjectsMappings":[{"objectType":"SOURCE","jsonPath":"$.name","sourceValue":"Original SOURCE Name","targetValue":"New SOURCE Name","enabled":true},{"objectType":"IDENTITY","jsonPath":"$.name","sourceValue":"Original IDENTITY Name","targetValue":"New IDENTITY Name ","enabled":true}]}; // ObjectmappingbulkcreaterequestV1 | The bulk create object mapping request body. + const result = await apiInstance.createObjectMappingsV1(sourceOrg, objectmappingbulkcreaterequestV1); + console.log(result); +- path: /configuration-hub/v1/scheduled-actions + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#create-scheduled-action-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const scheduledactionpayloadV1: ScheduledactionpayloadV1 = {"jobType":"BACKUP","startTime":"2024-08-16T14:16:58.389Z","cronString":"0 0 * * * *","timeZoneId":"America/Chicago","content":{"name":"Daily Backup","backupOptions":{"includeTypes":["SOURCE","IDENTITY"],"objectOptions":{"SOURCE":{"includedNames":["Source1","Source2"]}}}}}; // ScheduledactionpayloadV1 | The scheduled action creation request body. + const result = await apiInstance.createScheduledActionV1(scheduledactionpayloadV1); + console.log(result); +- path: /configuration-hub/v1/backups/uploads + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#create-uploaded-configuration-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const data: File = BINARY_DATA_HERE; // File | JSON file containing the objects to be imported. (default to undefined) + const name: string = 'name_example'; // string | Name that will be assigned to the uploaded configuration file. (default to undefined) + const result = await apiInstance.createUploadedConfigurationV1(data, name); + console.log(result); +- path: /configuration-hub/v1/backups/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#delete-backup-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '07659d7d-2cce-47c0-9e49-185787ee565a'; // string | The id of the backup to delete. (default to undefined) + const result = await apiInstance.deleteBackupV1(id); + console.log(result); +- path: /configuration-hub/v1/drafts/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#delete-draft-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '07659d7d-2cce-47c0-9e49-185787ee565a'; // string | The id of the draft to delete. (default to undefined) + const result = await apiInstance.deleteDraftV1(id); + console.log(result); +- path: /configuration-hub/v1/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#delete-object-mapping-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const sourceOrg: string = 'source-org'; // string | The name of the source org. (default to undefined) + const objectMappingId: string = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4'; // string | The id of the object mapping to be deleted. (default to undefined) + const result = await apiInstance.deleteObjectMappingV1(sourceOrg, objectMappingId); + console.log(result); +- path: /configuration-hub/v1/scheduled-actions/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#delete-scheduled-action-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | The ID of the scheduled action. (default to undefined) + const result = await apiInstance.deleteScheduledActionV1(id); + console.log(result); +- path: /configuration-hub/v1/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#delete-uploaded-configuration-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b'; // string | The id of the uploaded configuration. (default to undefined) + const result = await apiInstance.deleteUploadedConfigurationV1(id); + console.log(result); +- path: /configuration-hub/v1/deploys/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#get-deploy-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b'; // string | The id of the deploy. (default to undefined) + const result = await apiInstance.getDeployV1(id); + console.log(result); +- path: /configuration-hub/v1/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#get-object-mappings-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const sourceOrg: string = 'source-org'; // string | The name of the source org. (default to undefined) + const result = await apiInstance.getObjectMappingsV1(sourceOrg); + console.log(result); +- path: /configuration-hub/v1/backups/uploads/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#get-uploaded-configuration-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b'; // string | The id of the uploaded configuration. (default to undefined) + const result = await apiInstance.getUploadedConfigurationV1(id); + console.log(result); +- path: /configuration-hub/v1/backups + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#list-backups-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const filters: string = 'status eq "COMPLETE"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) (default to undefined) + const result = await apiInstance.listBackupsV1(); + console.log(result); +- path: /configuration-hub/v1/deploys + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#list-deploys-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const result = await apiInstance.listDeploysV1(); + console.log(result); +- path: /configuration-hub/v1/drafts + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#list-drafts-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const filters: string = 'status eq "COMPLETE"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) (default to undefined) + const result = await apiInstance.listDraftsV1(); + console.log(result); +- path: /configuration-hub/v1/scheduled-actions + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#list-scheduled-actions-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const result = await apiInstance.listScheduledActionsV1(); + console.log(result); +- path: /configuration-hub/v1/backups/uploads + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#list-uploaded-configurations-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const filters: string = 'status eq "COMPLETE"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) (default to undefined) + const result = await apiInstance.listUploadedConfigurationsV1(); + console.log(result); +- path: /configuration-hub/v1/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#update-object-mappings-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const sourceOrg: string = 'source-org'; // string | The name of the source org. (default to undefined) + const objectmappingbulkpatchrequestV1: ObjectmappingbulkpatchrequestV1 = {"patches":{"603b1a61-d03d-4ed1-864f-a508fbd1995d":[{"op":"replace","path":"/enabled","value":true}],"00bece34-f50d-4227-8878-76f620b5a971":[{"op":"replace","path":"/targetValue","value":"New Target Value"}]}}; // ObjectmappingbulkpatchrequestV1 | The object mapping request body. + const result = await apiInstance.updateObjectMappingsV1(sourceOrg, objectmappingbulkpatchrequestV1); + console.log(result); +- path: /configuration-hub/v1/scheduled-actions/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/configuration_hub/methods/configuration-hub#update-scheduled-action-v1 + source: | + import { ConfigurationHubV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConfigurationHubV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | The ID of the scheduled action. (default to undefined) + const jsonpatchV1: JsonpatchV1 = [{"op":"replace","path":"/content/name","value":"Updated Backup Name"},{"op":"replace","path":"/cronString","value":"0 0 9 * * ?"}]; // JsonpatchV1 | The JSON Patch document containing the changes to apply to the scheduled action. + const result = await apiInstance.updateScheduledActionV1(id, jsonpatchV1); + console.log(result); diff --git a/sdk-output/configuration_hub/docs/Methods/ConfigurationHubV1Api.md b/sdk-output/configuration_hub/docs/Methods/ConfigurationHubV1Api.md new file mode 100644 index 00000000..70bb8f9f --- /dev/null +++ b/sdk-output/configuration_hub/docs/Methods/ConfigurationHubV1Api.md @@ -0,0 +1,845 @@ +--- +id: v1-configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigurationHub', 'v1ConfigurationHub'] +slug: /tools/sdk/typescript/configuration_hub/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'v1ConfigurationHub'] +--- + +# ConfigurationHubV1Api + Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. + +Common usages for Configuration Hub includes: + +- Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. +- Manage object mapping - Create rules to map and substitute attributes when migrating configurations. +- Manage backups for configuration settings +- Manage configuration drafts +- Upload configurations and manage object mappings between tenants. + +Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-deploy-v1**](#create-deploy-v1) | **POST** `/configuration-hub/v1/deploys` | Create a deploy +[**create-object-mapping-v1**](#create-object-mapping-v1) | **POST** `/configuration-hub/v1/object-mappings/{sourceOrg}` | Creates an object mapping +[**create-object-mappings-v1**](#create-object-mappings-v1) | **POST** `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**create-scheduled-action-v1**](#create-scheduled-action-v1) | **POST** `/configuration-hub/v1/scheduled-actions` | Create scheduled action +[**create-uploaded-configuration-v1**](#create-uploaded-configuration-v1) | **POST** `/configuration-hub/v1/backups/uploads` | Upload a configuration +[**delete-backup-v1**](#delete-backup-v1) | **DELETE** `/configuration-hub/v1/backups/{id}` | Delete a backup +[**delete-draft-v1**](#delete-draft-v1) | **DELETE** `/configuration-hub/v1/drafts/{id}` | Delete a draft +[**delete-object-mapping-v1**](#delete-object-mapping-v1) | **DELETE** `/configuration-hub/v1/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**delete-scheduled-action-v1**](#delete-scheduled-action-v1) | **DELETE** `/configuration-hub/v1/scheduled-actions/{id}` | Delete scheduled action +[**delete-uploaded-configuration-v1**](#delete-uploaded-configuration-v1) | **DELETE** `/configuration-hub/v1/backups/uploads/{id}` | Delete an uploaded configuration +[**get-deploy-v1**](#get-deploy-v1) | **GET** `/configuration-hub/v1/deploys/{id}` | Get a deploy +[**get-object-mappings-v1**](#get-object-mappings-v1) | **GET** `/configuration-hub/v1/object-mappings/{sourceOrg}` | Gets list of object mappings +[**get-uploaded-configuration-v1**](#get-uploaded-configuration-v1) | **GET** `/configuration-hub/v1/backups/uploads/{id}` | Get an uploaded configuration +[**list-backups-v1**](#list-backups-v1) | **GET** `/configuration-hub/v1/backups` | List backups +[**list-deploys-v1**](#list-deploys-v1) | **GET** `/configuration-hub/v1/deploys` | List deploys +[**list-drafts-v1**](#list-drafts-v1) | **GET** `/configuration-hub/v1/drafts` | List drafts +[**list-scheduled-actions-v1**](#list-scheduled-actions-v1) | **GET** `/configuration-hub/v1/scheduled-actions` | List scheduled actions +[**list-uploaded-configurations-v1**](#list-uploaded-configurations-v1) | **GET** `/configuration-hub/v1/backups/uploads` | List uploaded configurations +[**update-object-mappings-v1**](#update-object-mappings-v1) | **POST** `/configuration-hub/v1/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings +[**update-scheduled-action-v1**](#update-scheduled-action-v1) | **PATCH** `/configuration-hub/v1/scheduled-actions/{id}` | Update scheduled action + + +## create-deploy-v1 +Create a deploy +This API performs a deploy based on an existing daft. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-deploy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**deployrequestV1** | **DeployrequestV1** | The deploy request body. | + +### Return type + +**DeployresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const deployrequestV1: DeployrequestV1 = {"draftId":"c9a38d8c-5edf-4182-9d39-f6581d3ebd05"}; // The deploy request body. +const result = await apiInstance.createDeployV1(deployrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-object-mapping-v1 +Creates an object mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-object-mapping-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceOrg** | **string** | The name of the source org. | [default to undefined] +**objectmappingrequestV1** | **ObjectmappingrequestV1** | The object mapping request body. | + +### Return type + +**ObjectmappingresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const sourceOrg: string = source-org; // The name of the source org. +const objectmappingrequestV1: ObjectmappingrequestV1 = {"objectType":"GOVERNANCE_GROUP","jsonPath":"$.description","sourceValue":"Sample Governance Group","targetValue":"Sample Governance Group - Updated","enabled":true}; // The object mapping request body. +const result = await apiInstance.createObjectMappingV1(sourceOrg, objectmappingrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-object-mappings-v1 +Bulk creates object mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-object-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceOrg** | **string** | The name of the source org. | [default to undefined] +**objectmappingbulkcreaterequestV1** | **ObjectmappingbulkcreaterequestV1** | The bulk create object mapping request body. | + +### Return type + +**ObjectmappingbulkcreateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const sourceOrg: string = source-org; // The name of the source org. +const objectmappingbulkcreaterequestV1: ObjectmappingbulkcreaterequestV1 = {"newObjectsMappings":[{"objectType":"SOURCE","jsonPath":"$.name","sourceValue":"Original SOURCE Name","targetValue":"New SOURCE Name","enabled":true},{"objectType":"IDENTITY","jsonPath":"$.name","sourceValue":"Original IDENTITY Name","targetValue":"New IDENTITY Name ","enabled":true}]}; // The bulk create object mapping request body. +const result = await apiInstance.createObjectMappingsV1(sourceOrg, objectmappingbulkcreaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-scheduled-action-v1 +Create scheduled action +This API creates a new scheduled action for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-scheduled-action-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scheduledactionpayloadV1** | **ScheduledactionpayloadV1** | The scheduled action creation request body. | + +### Return type + +**ScheduledactionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const scheduledactionpayloadV1: ScheduledactionpayloadV1 = {"jobType":"BACKUP","startTime":"2024-08-16T14:16:58.389Z","cronString":"0 0 * * * *","timeZoneId":"America/Chicago","content":{"name":"Daily Backup","backupOptions":{"includeTypes":["SOURCE","IDENTITY"],"objectOptions":{"SOURCE":{"includedNames":["Source1","Source2"]}}}}}; // The scheduled action creation request body. +const result = await apiInstance.createScheduledActionV1(scheduledactionpayloadV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-uploaded-configuration-v1 +Upload a configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects) for more information about supported objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-uploaded-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**data** | **File** | JSON file containing the objects to be imported. | [default to undefined] +**name** | **string** | Name that will be assigned to the uploaded configuration file. | [default to undefined] + +### Return type + +**BackupresponseV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const data: File = BINARY_DATA_HERE; // JSON file containing the objects to be imported. +const name: string = name_example; // Name that will be assigned to the uploaded configuration file. +const result = await apiInstance.createUploadedConfigurationV1(data, name); +console.log(result); +``` + +[[Back to top]](#) + +## delete-backup-v1 +Delete a backup +This API deletes an existing backup for the current tenant. + +On success, this endpoint will return an empty response. + +The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-backup-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the backup to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 07659d7d-2cce-47c0-9e49-185787ee565a; // The id of the backup to delete. +const result = await apiInstance.deleteBackupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-draft-v1 +Delete a draft +This API deletes an existing draft for the current tenant. + +On success, this endpoint will return an empty response. + +The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-draft-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the draft to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 07659d7d-2cce-47c0-9e49-185787ee565a; // The id of the draft to delete. +const result = await apiInstance.deleteDraftV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-object-mapping-v1 +Deletes an object mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-object-mapping-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceOrg** | **string** | The name of the source org. | [default to undefined] +**objectMappingId** | **string** | The id of the object mapping to be deleted. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const sourceOrg: string = source-org; // The name of the source org. +const objectMappingId: string = 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4; // The id of the object mapping to be deleted. +const result = await apiInstance.deleteObjectMappingV1(sourceOrg, objectMappingId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-scheduled-action-v1 +Delete scheduled action +This API deletes an existing scheduled action. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-scheduled-action-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the scheduled action. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // The ID of the scheduled action. +const result = await apiInstance.deleteScheduledActionV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-uploaded-configuration-v1 +Delete an uploaded configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-uploaded-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the uploaded configuration. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b; // The id of the uploaded configuration. +const result = await apiInstance.deleteUploadedConfigurationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-deploy-v1 +Get a deploy +This API gets an existing deploy for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-deploy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the deploy. | [default to undefined] + +### Return type + +**DeployresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b; // The id of the deploy. +const result = await apiInstance.getDeployV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-object-mappings-v1 +Gets list of object mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-object-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceOrg** | **string** | The name of the source org. | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const sourceOrg: string = source-org; // The name of the source org. +const result = await apiInstance.getObjectMappingsV1(sourceOrg); +console.log(result); +``` + +[[Back to top]](#) + +## get-uploaded-configuration-v1 +Get an uploaded configuration +This API gets an existing uploaded configuration for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-uploaded-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the uploaded configuration. | [default to undefined] + +### Return type + +**BackupresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b; // The id of the uploaded configuration. +const result = await apiInstance.getUploadedConfigurationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-backups-v1 +List backups +This API gets a list of existing backups for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-backups-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const filters: string = status eq "COMPLETE"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) +const result = await apiInstance.listBackupsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-deploys-v1 +List deploys +This API gets a list of deploys for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-deploys-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**ListDeploysV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const result = await apiInstance.listDeploysV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-drafts-v1 +List drafts +This API gets a list of existing drafts for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-drafts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const filters: string = status eq "COMPLETE"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) +const result = await apiInstance.listDraftsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-scheduled-actions-v1 +List scheduled actions +This API gets a list of existing scheduled actions for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-scheduled-actions-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const result = await apiInstance.listScheduledActionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-uploaded-configurations-v1 +List uploaded configurations +This API gets a list of existing uploaded configurations for the current tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-uploaded-configurations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const filters: string = status eq "COMPLETE"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) +const result = await apiInstance.listUploadedConfigurationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-object-mappings-v1 +Bulk updates object mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-object-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceOrg** | **string** | The name of the source org. | [default to undefined] +**objectmappingbulkpatchrequestV1** | **ObjectmappingbulkpatchrequestV1** | The object mapping request body. | + +### Return type + +**ObjectmappingbulkpatchresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const sourceOrg: string = source-org; // The name of the source org. +const objectmappingbulkpatchrequestV1: ObjectmappingbulkpatchrequestV1 = {"patches":{"603b1a61-d03d-4ed1-864f-a508fbd1995d":[{"op":"replace","path":"/enabled","value":true}],"00bece34-f50d-4227-8878-76f620b5a971":[{"op":"replace","path":"/targetValue","value":"New Target Value"}]}}; // The object mapping request body. +const result = await apiInstance.updateObjectMappingsV1(sourceOrg, objectmappingbulkpatchrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-scheduled-action-v1 +Update scheduled action +This API updates an existing scheduled action using JSON Patch format. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-scheduled-action-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the scheduled action. | [default to undefined] +**jsonpatchV1** | **JsonpatchV1** | The JSON Patch document containing the changes to apply to the scheduled action. | + +### Return type + +**ScheduledactionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ConfigurationHubV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConfigurationHubV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // The ID of the scheduled action. +const jsonpatchV1: JsonpatchV1 = [{"op":"replace","path":"/content/name","value":"Updated Backup Name"},{"op":"replace","path":"/cronString","value":"0 0 9 * * ?"}]; // The JSON Patch document containing the changes to apply to the scheduled action. +const result = await apiInstance.updateScheduledActionV1(id, jsonpatchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/configuration_hub/docs/Methods/Index.md b/sdk-output/configuration_hub/docs/Methods/Index.md new file mode 100644 index 00000000..cb3c0eca --- /dev/null +++ b/sdk-output/configuration_hub/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: configuration_hub-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: configuration_hub-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'configuration_hub', 'methods'] +slug: /tools/sdk/typescript/configuration_hub/methods +tags: ['SDK', 'Software Development Kit', 'configuration_hub', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/configuration_hub/docs/Models/Approvalcomment.md b/sdk-output/configuration_hub/docs/Models/Approvalcomment.md new file mode 100644 index 00000000..fc0e2e75 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Approvalcomment.md @@ -0,0 +1,23 @@ +--- +id: v1-approvalcomment-v1 +title: ApprovalcommentV1 +pagination_label: ApprovalcommentV1 +sidebar_label: ApprovalcommentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalcommentV1', 'v1ApprovalcommentV1'] +slug: /tools/sdk/typescript/configuration_hub/models/approvalcomment-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalcommentV1', 'v1ApprovalcommentV1'] +--- + +# ApprovalcommentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **string** | Comment provided either by the approval requester or the approver. | [default to undefined] +**timestamp** | **string** | The time when this comment was provided. | [default to undefined] +**user** | **string** | Name of the user that provided this comment. | [default to undefined] +**id** | **string** | Id of the user that provided this comment. | [default to undefined] +**changedToStatus** | **string** | Status transition of the draft. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ArrayInner.md b/sdk-output/configuration_hub/docs/Models/ArrayInner.md new file mode 100644 index 00000000..c995d058 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/configuration_hub/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/configuration_hub/docs/Models/Backupoptions.md b/sdk-output/configuration_hub/docs/Models/Backupoptions.md new file mode 100644 index 00000000..c5100251 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Backupoptions.md @@ -0,0 +1,20 @@ +--- +id: v1-backupoptions-v1 +title: BackupoptionsV1 +pagination_label: BackupoptionsV1 +sidebar_label: BackupoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BackupoptionsV1', 'v1BackupoptionsV1'] +slug: /tools/sdk/typescript/configuration_hub/models/backupoptions-v1 +tags: ['SDK', 'Software Development Kit', 'BackupoptionsV1', 'v1BackupoptionsV1'] +--- + +# BackupoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includeTypes** | **(optional)** **Array<string>** | Object type names to be included in a Configuration Hub backup command. | [default to undefined] +**objectOptions** | **(optional)** | Additional options targeting specific objects related to each item in the includeTypes field. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Backupresponse.md b/sdk-output/configuration_hub/docs/Models/Backupresponse.md new file mode 100644 index 00000000..91f9d275 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Backupresponse.md @@ -0,0 +1,35 @@ +--- +id: v1-backupresponse-v1 +title: BackupresponseV1 +pagination_label: BackupresponseV1 +sidebar_label: BackupresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BackupresponseV1', 'v1BackupresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/backupresponse-v1 +tags: ['SDK', 'Software Development Kit', 'BackupresponseV1', 'v1BackupresponseV1'] +--- + +# BackupresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **(optional)** **string** | Unique id assigned to this backup. | [default to undefined] +**status** | **(optional)** **string** | Status of the backup. | [default to undefined] +**type** | **(optional)** **string** | Type of the job, will always be BACKUP for this type of job. | [default to undefined] +**tenant** | **(optional)** **string** | The name of the tenant performing the upload | [default to undefined] +**requesterName** | **(optional)** **string** | The name of the requester. | [default to undefined] +**fileExists** | **(optional)** **boolean** | Whether or not a file was created and stored for this backup. | [default to true] +**created** | **(optional)** **string** | The time the job was started. | [default to undefined] +**modified** | **(optional)** **string** | The time of the last update to the job. | [default to undefined] +**completed** | **(optional)** **string** | The time the job was completed. | [default to undefined] +**name** | **(optional)** **string** | The name assigned to the upload file in the request body. | [default to undefined] +**userCanDelete** | **(optional)** **boolean** | Whether this backup can be deleted by a regular user. | [default to true] +**isPartial** | **(optional)** **boolean** | Whether this backup contains all supported object types or only some of them. | [default to false] +**backupType** | **(optional)** **string** | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [default to undefined] +**_options** | **(optional)** **BackupoptionsV1** | | [default to undefined] +**hydrationStatus** | **(optional)** **string** | Whether the object details of this backup are ready. | [default to undefined] +**totalObjectCount** | **(optional)** **number** | Number of objects contained in this backup. | [default to undefined] +**cloudStorageStatus** | **(optional)** **string** | Whether this backup has been transferred to a customer storage location. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/CreateUploadedConfigurationV1Request.md b/sdk-output/configuration_hub/docs/Models/CreateUploadedConfigurationV1Request.md new file mode 100644 index 00000000..91519a63 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/CreateUploadedConfigurationV1Request.md @@ -0,0 +1,20 @@ +--- +id: v1-create-uploaded-configuration-v1-request-v1 +title: CreateUploadedConfigurationV1RequestV1 +pagination_label: CreateUploadedConfigurationV1RequestV1 +sidebar_label: CreateUploadedConfigurationV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateUploadedConfigurationV1RequestV1', 'v1CreateUploadedConfigurationV1RequestV1'] +slug: /tools/sdk/typescript/configuration_hub/models/create-uploaded-configuration-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationV1RequestV1', 'v1CreateUploadedConfigurationV1RequestV1'] +--- + +# CreateUploadedConfigurationV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **File** | JSON file containing the objects to be imported. | [default to undefined] +**name** | **string** | Name that will be assigned to the uploaded configuration file. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Deployrequest.md b/sdk-output/configuration_hub/docs/Models/Deployrequest.md new file mode 100644 index 00000000..7440ada9 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Deployrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-deployrequest-v1 +title: DeployrequestV1 +pagination_label: DeployrequestV1 +sidebar_label: DeployrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeployrequestV1', 'v1DeployrequestV1'] +slug: /tools/sdk/typescript/configuration_hub/models/deployrequest-v1 +tags: ['SDK', 'Software Development Kit', 'DeployrequestV1', 'v1DeployrequestV1'] +--- + +# DeployrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**draftId** | **string** | The id of the draft to be used by this deploy. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Deployresponse.md b/sdk-output/configuration_hub/docs/Models/Deployresponse.md new file mode 100644 index 00000000..d8dbdc8e --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Deployresponse.md @@ -0,0 +1,30 @@ +--- +id: v1-deployresponse-v1 +title: DeployresponseV1 +pagination_label: DeployresponseV1 +sidebar_label: DeployresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeployresponseV1', 'v1DeployresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/deployresponse-v1 +tags: ['SDK', 'Software Development Kit', 'DeployresponseV1', 'v1DeployresponseV1'] +--- + +# DeployresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **(optional)** **string** | Unique id assigned to this job. | [default to undefined] +**status** | **(optional)** **string** | Status of the job. | [default to undefined] +**type** | **(optional)** **string** | Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. | [default to undefined] +**message** | **(optional)** **string** | Message providing information about the outcome of the deploy process. | [default to undefined] +**requesterName** | **(optional)** **string** | The name of the user that initiated the deploy process. | [default to undefined] +**fileExists** | **(optional)** **boolean** | Whether or not a results file was created and stored for this deploy. | [default to true] +**created** | **(optional)** **string** | The time the job was started. | [default to undefined] +**modified** | **(optional)** **string** | The time of the last update to the job. | [default to undefined] +**completed** | **(optional)** **string** | The time the job was completed. | [default to undefined] +**draftId** | **(optional)** **string** | The id of the draft that was used for this deploy. | [default to undefined] +**draftName** | **(optional)** **string** | The name of the draft that was used for this deploy. | [default to undefined] +**cloudStorageStatus** | **(optional)** **string** | Whether this deploy results file has been transferred to a customer storage location. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Draftresponse.md b/sdk-output/configuration_hub/docs/Models/Draftresponse.md new file mode 100644 index 00000000..a7c5ff3f --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Draftresponse.md @@ -0,0 +1,34 @@ +--- +id: v1-draftresponse-v1 +title: DraftresponseV1 +pagination_label: DraftresponseV1 +sidebar_label: DraftresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DraftresponseV1', 'v1DraftresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/draftresponse-v1 +tags: ['SDK', 'Software Development Kit', 'DraftresponseV1', 'v1DraftresponseV1'] +--- + +# DraftresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **(optional)** **string** | Unique id assigned to this job. | [default to undefined] +**status** | **(optional)** **string** | Status of the job. | [default to undefined] +**type** | **(optional)** **string** | Type of the job, will always be CREATE_DRAFT for this type of job. | [default to undefined] +**message** | **(optional)** **string** | Message providing information about the outcome of the draft process. | [default to undefined] +**requesterName** | **(optional)** **string** | The name of user that that initiated the draft process. | [default to undefined] +**fileExists** | **(optional)** **boolean** | Whether or not a file was generated for this draft. | [default to true] +**created** | **(optional)** **string** | The time the job was started. | [default to undefined] +**modified** | **(optional)** **string** | The time of the last update to the job. | [default to undefined] +**completed** | **(optional)** **string** | The time the job was completed. | [default to undefined] +**name** | **(optional)** **string** | Name of the draft. | [default to undefined] +**sourceTenant** | **(optional)** **string** | Tenant owner of the backup from which the draft was generated. | [default to undefined] +**sourceBackupId** | **(optional)** **string** | Id of the backup from which the draft was generated. | [default to undefined] +**sourceBackupName** | **(optional)** **string** | Name of the backup from which the draft was generated. | [default to undefined] +**mode** | **(optional)** **string** | Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. | [default to undefined] +**approvalStatus** | **(optional)** **string** | Approval status of the draft used to determine whether or not the draft can be deployed. | [default to undefined] +**approvalComment** | **(optional)** **Array<ApprovalcommentV1>** | List of comments that have been exchanged between an approval requester and an approver. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Errormessagedto.md b/sdk-output/configuration_hub/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..65bc4587 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/configuration_hub/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Errorresponsedto.md b/sdk-output/configuration_hub/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..1d774f1a --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/configuration_hub/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1401Response.md b/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1401Response.md new file mode 100644 index 00000000..b192fb3e --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-object-mappings-v1401-response-v1 +title: GetObjectMappingsV1401ResponseV1 +pagination_label: GetObjectMappingsV1401ResponseV1 +sidebar_label: GetObjectMappingsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetObjectMappingsV1401ResponseV1', 'v1GetObjectMappingsV1401ResponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/get-object-mappings-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetObjectMappingsV1401ResponseV1', 'v1GetObjectMappingsV1401ResponseV1'] +--- + +# GetObjectMappingsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1429Response.md b/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1429Response.md new file mode 100644 index 00000000..916b21d8 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/GetObjectMappingsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-object-mappings-v1429-response-v1 +title: GetObjectMappingsV1429ResponseV1 +pagination_label: GetObjectMappingsV1429ResponseV1 +sidebar_label: GetObjectMappingsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetObjectMappingsV1429ResponseV1', 'v1GetObjectMappingsV1429ResponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/get-object-mappings-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetObjectMappingsV1429ResponseV1', 'v1GetObjectMappingsV1429ResponseV1'] +--- + +# GetObjectMappingsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Index.md b/sdk-output/configuration_hub/docs/Models/Index.md new file mode 100644 index 00000000..9a9ce9ce --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: configuration_hub-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: configuration_hub-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'configuration_hub', 'models'] +slug: /tools/sdk/typescript/configuration_hub/models +tags: ['SDK', 'Software Development Kit', 'configuration_hub', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/configuration_hub/docs/Models/Jsonpatch.md b/sdk-output/configuration_hub/docs/Models/Jsonpatch.md new file mode 100644 index 00000000..1e8079fe --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Jsonpatch.md @@ -0,0 +1,19 @@ +--- +id: v1-jsonpatch-v1 +title: JsonpatchV1 +pagination_label: JsonpatchV1 +sidebar_label: JsonpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchV1', 'v1JsonpatchV1'] +slug: /tools/sdk/typescript/configuration_hub/models/jsonpatch-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchV1', 'v1JsonpatchV1'] +--- + +# JsonpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | **(optional)** **Array<JsonpatchoperationV1>** | Operations to be applied | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Jsonpatchoperation.md b/sdk-output/configuration_hub/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..03f32958 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/configuration_hub/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/JsonpatchoperationValue.md b/sdk-output/configuration_hub/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..51721043 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/configuration_hub/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/configuration_hub/docs/Models/ListDeploysV1200Response.md b/sdk-output/configuration_hub/docs/Models/ListDeploysV1200Response.md new file mode 100644 index 00000000..7bd8c84c --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ListDeploysV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-deploys-v1200-response-v1 +title: ListDeploysV1200ResponseV1 +pagination_label: ListDeploysV1200ResponseV1 +sidebar_label: ListDeploysV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListDeploysV1200ResponseV1', 'v1ListDeploysV1200ResponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/list-deploys-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListDeploysV1200ResponseV1', 'v1ListDeploysV1200ResponseV1'] +--- + +# ListDeploysV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **(optional)** **Array<DeployresponseV1>** | list of deployments | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Localeorigin.md b/sdk-output/configuration_hub/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d3f28e31 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/configuration_hub/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/configuration_hub/docs/Models/Objectexportimportnames.md b/sdk-output/configuration_hub/docs/Models/Objectexportimportnames.md new file mode 100644 index 00000000..28f19f7e --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectexportimportnames.md @@ -0,0 +1,19 @@ +--- +id: v1-objectexportimportnames-v1 +title: ObjectexportimportnamesV1 +pagination_label: ObjectexportimportnamesV1 +sidebar_label: ObjectexportimportnamesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectexportimportnamesV1', 'v1ObjectexportimportnamesV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectexportimportnames-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectexportimportnamesV1', 'v1ObjectexportimportnamesV1'] +--- + +# ObjectexportimportnamesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includedNames** | **(optional)** **Array<string>** | Object names to be included in a backup. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreaterequest.md b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreaterequest.md new file mode 100644 index 00000000..4fd3921c --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreaterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-objectmappingbulkcreaterequest-v1 +title: ObjectmappingbulkcreaterequestV1 +pagination_label: ObjectmappingbulkcreaterequestV1 +sidebar_label: ObjectmappingbulkcreaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingbulkcreaterequestV1', 'v1ObjectmappingbulkcreaterequestV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingbulkcreaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingbulkcreaterequestV1', 'v1ObjectmappingbulkcreaterequestV1'] +--- + +# ObjectmappingbulkcreaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**newObjectsMappings** | **Array<ObjectmappingrequestV1>** | | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreateresponse.md b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreateresponse.md new file mode 100644 index 00000000..c631a760 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkcreateresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-objectmappingbulkcreateresponse-v1 +title: ObjectmappingbulkcreateresponseV1 +pagination_label: ObjectmappingbulkcreateresponseV1 +sidebar_label: ObjectmappingbulkcreateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingbulkcreateresponseV1', 'v1ObjectmappingbulkcreateresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingbulkcreateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingbulkcreateresponseV1', 'v1ObjectmappingbulkcreateresponseV1'] +--- + +# ObjectmappingbulkcreateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**addedObjects** | **(optional)** **Array<ObjectmappingresponseV1>** | | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchrequest.md b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchrequest.md new file mode 100644 index 00000000..930b570f --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-objectmappingbulkpatchrequest-v1 +title: ObjectmappingbulkpatchrequestV1 +pagination_label: ObjectmappingbulkpatchrequestV1 +sidebar_label: ObjectmappingbulkpatchrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingbulkpatchrequestV1', 'v1ObjectmappingbulkpatchrequestV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingbulkpatchrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingbulkpatchrequestV1', 'v1ObjectmappingbulkpatchrequestV1'] +--- + +# ObjectmappingbulkpatchrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patches** | | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchresponse.md b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchresponse.md new file mode 100644 index 00000000..472f51aa --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingbulkpatchresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-objectmappingbulkpatchresponse-v1 +title: ObjectmappingbulkpatchresponseV1 +pagination_label: ObjectmappingbulkpatchresponseV1 +sidebar_label: ObjectmappingbulkpatchresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingbulkpatchresponseV1', 'v1ObjectmappingbulkpatchresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingbulkpatchresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingbulkpatchresponseV1', 'v1ObjectmappingbulkpatchresponseV1'] +--- + +# ObjectmappingbulkpatchresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**patchedObjects** | **(optional)** **Array<ObjectmappingresponseV1>** | | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingrequest.md b/sdk-output/configuration_hub/docs/Models/Objectmappingrequest.md new file mode 100644 index 00000000..d77e2131 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingrequest.md @@ -0,0 +1,23 @@ +--- +id: v1-objectmappingrequest-v1 +title: ObjectmappingrequestV1 +pagination_label: ObjectmappingrequestV1 +sidebar_label: ObjectmappingrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingrequestV1', 'v1ObjectmappingrequestV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingrequestV1', 'v1ObjectmappingrequestV1'] +--- + +# ObjectmappingrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectType** | **string** | Type of the object the mapping value applies to, must be one from enum | [default to undefined] +**jsonPath** | **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | [default to undefined] +**sourceValue** | **string** | Original value at the jsonPath location within the object | [default to undefined] +**targetValue** | **string** | Value to be assigned at the jsonPath location within the object | [default to undefined] +**enabled** | **(optional)** **boolean** | Whether or not this object mapping is enabled | [default to false] + diff --git a/sdk-output/configuration_hub/docs/Models/Objectmappingresponse.md b/sdk-output/configuration_hub/docs/Models/Objectmappingresponse.md new file mode 100644 index 00000000..22de657b --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Objectmappingresponse.md @@ -0,0 +1,26 @@ +--- +id: v1-objectmappingresponse-v1 +title: ObjectmappingresponseV1 +pagination_label: ObjectmappingresponseV1 +sidebar_label: ObjectmappingresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectmappingresponseV1', 'v1ObjectmappingresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/objectmappingresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectmappingresponseV1', 'v1ObjectmappingresponseV1'] +--- + +# ObjectmappingresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectMappingId** | **(optional)** **string** | Id of the object mapping | [default to undefined] +**objectType** | **(optional)** **string** | Type of the object the mapping value applies to | [default to undefined] +**jsonPath** | **(optional)** **string** | JSONPath expression denoting the path within the object where the mapping value should be applied | [default to undefined] +**sourceValue** | **(optional)** **string** | Original value at the jsonPath location within the object | [default to undefined] +**targetValue** | **(optional)** **string** | Value to be assigned at the jsonPath location within the object | [default to undefined] +**enabled** | **(optional)** **boolean** | Whether or not this object mapping is enabled | [default to false] +**created** | **(optional)** **string** | Object mapping creation timestamp | [default to undefined] +**modified** | **(optional)** **string** | Object mapping latest update timestamp | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/README.md b/sdk-output/configuration_hub/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/configuration_hub/docs/Models/Scheduledactionpayload.md b/sdk-output/configuration_hub/docs/Models/Scheduledactionpayload.md new file mode 100644 index 00000000..fd0a73d5 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Scheduledactionpayload.md @@ -0,0 +1,23 @@ +--- +id: v1-scheduledactionpayload-v1 +title: ScheduledactionpayloadV1 +pagination_label: ScheduledactionpayloadV1 +sidebar_label: ScheduledactionpayloadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionpayloadV1', 'v1ScheduledactionpayloadV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionpayload-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionpayloadV1', 'v1ScheduledactionpayloadV1'] +--- + +# ScheduledactionpayloadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobType** | **string** | Type of the scheduled job. | [default to undefined] +**startTime** | **(optional)** **string** | The time when this scheduled action should start. Optional. | [default to undefined] +**cronString** | **(optional)** **string** | Cron expression defining the schedule for this action. Optional for repeated events. | [default to undefined] +**timeZoneId** | **(optional)** **string** | Time zone ID for interpreting the cron expression. Optional, will default to current time zone. | [default to undefined] +**content** | **ScheduledactionpayloadContentV1** | | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContent.md b/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContent.md new file mode 100644 index 00000000..10be49c8 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContent.md @@ -0,0 +1,23 @@ +--- +id: v1-scheduledactionpayload-content-v1 +title: ScheduledactionpayloadContentV1 +pagination_label: ScheduledactionpayloadContentV1 +sidebar_label: ScheduledactionpayloadContentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionpayloadContentV1', 'v1ScheduledactionpayloadContentV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionpayload-content-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionpayloadContentV1', 'v1ScheduledactionpayloadContentV1'] +--- + +# ScheduledactionpayloadContentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of the scheduled action (maximum 50 characters). | [default to undefined] +**backupOptions** | **(optional)** **ScheduledactionpayloadContentBackupOptionsV1** | | [default to undefined] +**sourceBackupId** | **(optional)** **string** | ID of the source backup. Required for CREATE_DRAFT jobs. | [default to undefined] +**sourceTenant** | **(optional)** **string** | Source tenant identifier. Required for CREATE_DRAFT jobs. | [default to undefined] +**draftId** | **(optional)** **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContentBackupOptions.md b/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContentBackupOptions.md new file mode 100644 index 00000000..c94ea310 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ScheduledactionpayloadContentBackupOptions.md @@ -0,0 +1,20 @@ +--- +id: v1-scheduledactionpayload-content-backup-options-v1 +title: ScheduledactionpayloadContentBackupOptionsV1 +pagination_label: ScheduledactionpayloadContentBackupOptionsV1 +sidebar_label: ScheduledactionpayloadContentBackupOptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionpayloadContentBackupOptionsV1', 'v1ScheduledactionpayloadContentBackupOptionsV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionpayload-content-backup-options-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionpayloadContentBackupOptionsV1', 'v1ScheduledactionpayloadContentBackupOptionsV1'] +--- + +# ScheduledactionpayloadContentBackupOptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includeTypes** | **(optional)** **Array<string>** | Object types that are to be included in the backup. | [default to undefined] +**objectOptions** | **(optional)** | Map of objectType string to the options to be passed to the target service for that objectType. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/Scheduledactionresponse.md b/sdk-output/configuration_hub/docs/Models/Scheduledactionresponse.md new file mode 100644 index 00000000..bfefb35b --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/Scheduledactionresponse.md @@ -0,0 +1,25 @@ +--- +id: v1-scheduledactionresponse-v1 +title: ScheduledactionresponseV1 +pagination_label: ScheduledactionresponseV1 +sidebar_label: ScheduledactionresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionresponseV1', 'v1ScheduledactionresponseV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionresponseV1', 'v1ScheduledactionresponseV1'] +--- + +# ScheduledactionresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for this scheduled action. | [default to undefined] +**created** | **(optional)** **string** | The time when this scheduled action was created. | [default to undefined] +**jobType** | **(optional)** **string** | Type of the scheduled job. | [default to undefined] +**content** | **(optional)** **ScheduledactionresponseContentV1** | | [default to undefined] +**startTime** | **(optional)** **string** | The time when this scheduled action should start. | [default to undefined] +**cronString** | **(optional)** **string** | Cron expression defining the schedule for this action. | [default to undefined] +**timeZoneId** | **(optional)** **string** | Time zone ID for interpreting the cron expression. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContent.md b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContent.md new file mode 100644 index 00000000..76dc4fa3 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContent.md @@ -0,0 +1,23 @@ +--- +id: v1-scheduledactionresponse-content-v1 +title: ScheduledactionresponseContentV1 +pagination_label: ScheduledactionresponseContentV1 +sidebar_label: ScheduledactionresponseContentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionresponseContentV1', 'v1ScheduledactionresponseContentV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionresponse-content-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionresponseContentV1', 'v1ScheduledactionresponseContentV1'] +--- + +# ScheduledactionresponseContentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the scheduled action (maximum 50 characters). | [default to undefined] +**backupOptions** | **(optional)** **ScheduledactionresponseContentBackupOptionsV1** | | [default to undefined] +**sourceBackupId** | **(optional)** **string** | ID of the source backup. Required for CREATE_DRAFT jobs only. | [default to undefined] +**sourceTenant** | **(optional)** **string** | Source tenant identifier. Required for CREATE_DRAFT jobs only. | [default to undefined] +**draftId** | **(optional)** **string** | ID of the draft to be deployed. Required for CONFIG_DEPLOY_DRAFT jobs only. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptions.md b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptions.md new file mode 100644 index 00000000..572c479d --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptions.md @@ -0,0 +1,20 @@ +--- +id: v1-scheduledactionresponse-content-backup-options-v1 +title: ScheduledactionresponseContentBackupOptionsV1 +pagination_label: ScheduledactionresponseContentBackupOptionsV1 +sidebar_label: ScheduledactionresponseContentBackupOptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionresponseContentBackupOptionsV1', 'v1ScheduledactionresponseContentBackupOptionsV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionresponse-content-backup-options-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionresponseContentBackupOptionsV1', 'v1ScheduledactionresponseContentBackupOptionsV1'] +--- + +# ScheduledactionresponseContentBackupOptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includeTypes** | **(optional)** **Array<string>** | Object types that are to be included in the backup. | [default to undefined] +**objectOptions** | **(optional)** | Map of objectType string to the options to be passed to the target service for that objectType. | [default to undefined] + diff --git a/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptionsObjectOptionsValue.md b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptionsObjectOptionsValue.md new file mode 100644 index 00000000..f30314b5 --- /dev/null +++ b/sdk-output/configuration_hub/docs/Models/ScheduledactionresponseContentBackupOptionsObjectOptionsValue.md @@ -0,0 +1,19 @@ +--- +id: v1-scheduledactionresponse-content-backup-options-object-options-value-v1 +title: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 +pagination_label: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 +sidebar_label: ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1', 'v1ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1'] +slug: /tools/sdk/typescript/configuration_hub/models/scheduledactionresponse-content-backup-options-object-options-value-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1', 'v1ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1'] +--- + +# ScheduledactionresponseContentBackupOptionsObjectOptionsValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includedNames** | **(optional)** **Array<string>** | Set of names to be included. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/connector_customizers/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a89589c3 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,92 @@ +- path: /connector-customizers/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#create-connector-customizer-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const connectorcustomizercreaterequestV1: ConnectorcustomizercreaterequestV1 = ; // ConnectorcustomizercreaterequestV1 | Connector customizer to create. + const result = await apiInstance.createConnectorCustomizerV1(connectorcustomizercreaterequestV1); + console.log(result); +- path: /connector-customizers/v1/{id}/versions + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#create-connector-customizer-version-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const id: string = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a'; // string | The id of the connector customizer. (default to undefined) + const result = await apiInstance.createConnectorCustomizerVersionV1(id); + console.log(result); +- path: /connector-customizers/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#delete-connector-customizer-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const id: string = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a'; // string | ID of the connector customizer to delete. (default to undefined) + const result = await apiInstance.deleteConnectorCustomizerV1(id); + console.log(result); +- path: /connector-customizers/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#get-connector-customizer-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const id: string = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a'; // string | ID of the connector customizer to get. (default to undefined) + const result = await apiInstance.getConnectorCustomizerV1(id); + console.log(result); +- path: /connector-customizers/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#list-connector-customizers-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.listConnectorCustomizersV1(); + console.log(result); +- path: /connector-customizers/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_customizers/methods/connector-customizers#put-connector-customizer-v1 + source: | + import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorCustomizersV1Api(configuration); + const id: string = 'b07dc46a-1498-4de8-bfbb-259a68e70c8a'; // string | ID of the connector customizer to update. (default to undefined) + const connectorcustomizerupdaterequestV1: ConnectorcustomizerupdaterequestV1 = ; // ConnectorcustomizerupdaterequestV1 | Connector rule with updated data. (optional) + const result = await apiInstance.putConnectorCustomizerV1(id); + console.log(result); diff --git a/sdk-output/connector_customizers/docs/Methods/ConnectorCustomizersV1Api.md b/sdk-output/connector_customizers/docs/Methods/ConnectorCustomizersV1Api.md new file mode 100644 index 00000000..8232627b --- /dev/null +++ b/sdk-output/connector_customizers/docs/Methods/ConnectorCustomizersV1Api.md @@ -0,0 +1,260 @@ +--- +id: v1-connector-customizers +title: ConnectorCustomizers +pagination_label: ConnectorCustomizers +sidebar_label: ConnectorCustomizers +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorCustomizers', 'v1ConnectorCustomizers'] +slug: /tools/sdk/typescript/connector_customizers/methods/connector-customizers +tags: ['SDK', 'Software Development Kit', 'ConnectorCustomizers', 'v1ConnectorCustomizers'] +--- + +# ConnectorCustomizersV1Api + Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors. + +Use these APIs to implement connector customizers functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-customizer-v1**](#create-connector-customizer-v1) | **POST** `/connector-customizers/v1` | Create connector customizer +[**create-connector-customizer-version-v1**](#create-connector-customizer-version-v1) | **POST** `/connector-customizers/v1/{id}/versions` | Creates a connector customizer version +[**delete-connector-customizer-v1**](#delete-connector-customizer-v1) | **DELETE** `/connector-customizers/v1/{id}` | Delete connector customizer +[**get-connector-customizer-v1**](#get-connector-customizer-v1) | **GET** `/connector-customizers/v1/{id}` | Get connector customizer +[**list-connector-customizers-v1**](#list-connector-customizers-v1) | **GET** `/connector-customizers/v1` | List all connector customizers +[**put-connector-customizer-v1**](#put-connector-customizer-v1) | **PUT** `/connector-customizers/v1/{id}` | Update connector customizer + + +## create-connector-customizer-v1 +Create connector customizer +Create a connector customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-connector-customizer-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**connectorcustomizercreaterequestV1** | **ConnectorcustomizercreaterequestV1** | Connector customizer to create. | + +### Return type + +**ConnectorcustomizercreateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const connectorcustomizercreaterequestV1: ConnectorcustomizercreaterequestV1 = ; // Connector customizer to create. +const result = await apiInstance.createConnectorCustomizerV1(connectorcustomizercreaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-connector-customizer-version-v1 +Creates a connector customizer version +Creates a new version for the customizer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-connector-customizer-version-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the connector customizer. | [default to undefined] + +### Return type + +**ConnectorcustomizerversioncreateresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const id: string = b07dc46a-1498-4de8-bfbb-259a68e70c8a; // The id of the connector customizer. +const result = await apiInstance.createConnectorCustomizerVersionV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-connector-customizer-v1 +Delete connector customizer +Delete the connector customizer for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-connector-customizer-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector customizer to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const id: string = b07dc46a-1498-4de8-bfbb-259a68e70c8a; // ID of the connector customizer to delete. +const result = await apiInstance.deleteConnectorCustomizerV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-customizer-v1 +Get connector customizer +Gets connector customizer by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-customizer-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector customizer to get. | [default to undefined] + +### Return type + +**ConnectorcustomizersresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const id: string = b07dc46a-1498-4de8-bfbb-259a68e70c8a; // ID of the connector customizer to get. +const result = await apiInstance.getConnectorCustomizerV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-connector-customizers-v1 +List all connector customizers +List all connector customizers. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-connector-customizers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listConnectorCustomizersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-customizer-v1 +Update connector customizer +Update an existing connector customizer with the one provided in the request body. These fields are immutable: `id`, `name`, `type`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-customizer-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector customizer to update. | [default to undefined] +**connectorcustomizerupdaterequestV1** | **ConnectorcustomizerupdaterequestV1** | Connector rule with updated data. | [optional] + +### Return type + +**ConnectorcustomizerupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorCustomizersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorCustomizersV1Api(configuration); +const id: string = b07dc46a-1498-4de8-bfbb-259a68e70c8a; // ID of the connector customizer to update. +const connectorcustomizerupdaterequestV1: ConnectorcustomizerupdaterequestV1 = ; // Connector rule with updated data. (optional) +const result = await apiInstance.putConnectorCustomizerV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/connector_customizers/docs/Methods/Index.md b/sdk-output/connector_customizers/docs/Methods/Index.md new file mode 100644 index 00000000..1cfc2ab1 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: connector_customizers-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: connector_customizers-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'connector_customizers', 'methods'] +slug: /tools/sdk/typescript/connector_customizers/methods +tags: ['SDK', 'Software Development Kit', 'connector_customizers', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreaterequest.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreaterequest.md new file mode 100644 index 00000000..71008563 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreaterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-connectorcustomizercreaterequest-v1 +title: ConnectorcustomizercreaterequestV1 +pagination_label: ConnectorcustomizercreaterequestV1 +sidebar_label: ConnectorcustomizercreaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizercreaterequestV1', 'v1ConnectorcustomizercreaterequestV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizercreaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizercreaterequestV1', 'v1ConnectorcustomizercreaterequestV1'] +--- + +# ConnectorcustomizercreaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Connector customizer name. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreateresponse.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreateresponse.md new file mode 100644 index 00000000..dee9a8e4 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizercreateresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-connectorcustomizercreateresponse-v1 +title: ConnectorcustomizercreateresponseV1 +pagination_label: ConnectorcustomizercreateresponseV1 +sidebar_label: ConnectorcustomizercreateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizercreateresponseV1', 'v1ConnectorcustomizercreateresponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizercreateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizercreateresponseV1', 'v1ConnectorcustomizercreateresponseV1'] +--- + +# ConnectorcustomizercreateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the ID of connector customizer. | [default to undefined] +**name** | **(optional)** **string** | name of the connector customizer. | [default to undefined] +**tenantID** | **(optional)** **string** | Connector customizer tenant id. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the connector customizer was created. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizersresponse.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizersresponse.md new file mode 100644 index 00000000..ceb8cd40 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizersresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-connectorcustomizersresponse-v1 +title: ConnectorcustomizersresponseV1 +pagination_label: ConnectorcustomizersresponseV1 +sidebar_label: ConnectorcustomizersresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizersresponseV1', 'v1ConnectorcustomizersresponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizersresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizersresponseV1', 'v1ConnectorcustomizersresponseV1'] +--- + +# ConnectorcustomizersresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Connector customizer ID. | [readonly] [default to undefined] +**name** | **(optional)** **string** | Connector customizer name. | [default to undefined] +**imageVersion** | **(optional)** **number** | Connector customizer image version. | [default to undefined] +**imageID** | **(optional)** **string** | Connector customizer image id. | [default to undefined] +**tenantID** | **(optional)** **string** | Connector customizer tenant id. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the connector customizer was created | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdaterequest.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdaterequest.md new file mode 100644 index 00000000..420d4f87 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdaterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-connectorcustomizerupdaterequest-v1 +title: ConnectorcustomizerupdaterequestV1 +pagination_label: ConnectorcustomizerupdaterequestV1 +sidebar_label: ConnectorcustomizerupdaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizerupdaterequestV1', 'v1ConnectorcustomizerupdaterequestV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizerupdaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizerupdaterequestV1', 'v1ConnectorcustomizerupdaterequestV1'] +--- + +# ConnectorcustomizerupdaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Connector customizer name. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdateresponse.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdateresponse.md new file mode 100644 index 00000000..67a4ffb2 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerupdateresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-connectorcustomizerupdateresponse-v1 +title: ConnectorcustomizerupdateresponseV1 +pagination_label: ConnectorcustomizerupdateresponseV1 +sidebar_label: ConnectorcustomizerupdateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizerupdateresponseV1', 'v1ConnectorcustomizerupdateresponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizerupdateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizerupdateresponseV1', 'v1ConnectorcustomizerupdateresponseV1'] +--- + +# ConnectorcustomizerupdateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the ID of connector customizer. | [default to undefined] +**name** | **(optional)** **string** | name of the connector customizer. | [default to undefined] +**tenantID** | **(optional)** **string** | Connector customizer tenant id. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the connector customizer was created. | [default to undefined] +**imageVersion** | **(optional)** **number** | Connector customizer image version. | [default to undefined] +**imageID** | **(optional)** **string** | Connector customizer image id. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Connectorcustomizerversioncreateresponse.md b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerversioncreateresponse.md new file mode 100644 index 00000000..f33b3f9c --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Connectorcustomizerversioncreateresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-connectorcustomizerversioncreateresponse-v1 +title: ConnectorcustomizerversioncreateresponseV1 +pagination_label: ConnectorcustomizerversioncreateresponseV1 +sidebar_label: ConnectorcustomizerversioncreateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorcustomizerversioncreateresponseV1', 'v1ConnectorcustomizerversioncreateresponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/connectorcustomizerversioncreateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorcustomizerversioncreateresponseV1', 'v1ConnectorcustomizerversioncreateresponseV1'] +--- + +# ConnectorcustomizerversioncreateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customizerID** | **(optional)** **string** | ID of connector customizer. | [default to undefined] +**imageID** | **(optional)** **string** | ImageID of the connector customizer. | [default to undefined] +**version** | **(optional)** **number** | Image version of the connector customizer. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the connector customizer version was created. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Errormessagedto.md b/sdk-output/connector_customizers/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..3d294deb --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/connector_customizers/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Errorresponsedto.md b/sdk-output/connector_customizers/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..ff410436 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/connector_customizers/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Index.md b/sdk-output/connector_customizers/docs/Models/Index.md new file mode 100644 index 00000000..06f43e0f --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: connector_customizers-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: connector_customizers-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'connector_customizers', 'models'] +slug: /tools/sdk/typescript/connector_customizers/models +tags: ['SDK', 'Software Development Kit', 'connector_customizers', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1401Response.md b/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1401Response.md new file mode 100644 index 00000000..fba7de31 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-connector-customizers-v1401-response-v1 +title: ListConnectorCustomizersV1401ResponseV1 +pagination_label: ListConnectorCustomizersV1401ResponseV1 +sidebar_label: ListConnectorCustomizersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListConnectorCustomizersV1401ResponseV1', 'v1ListConnectorCustomizersV1401ResponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/list-connector-customizers-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListConnectorCustomizersV1401ResponseV1', 'v1ListConnectorCustomizersV1401ResponseV1'] +--- + +# ListConnectorCustomizersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1429Response.md b/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1429Response.md new file mode 100644 index 00000000..68590137 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/ListConnectorCustomizersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-connector-customizers-v1429-response-v1 +title: ListConnectorCustomizersV1429ResponseV1 +pagination_label: ListConnectorCustomizersV1429ResponseV1 +sidebar_label: ListConnectorCustomizersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListConnectorCustomizersV1429ResponseV1', 'v1ListConnectorCustomizersV1429ResponseV1'] +slug: /tools/sdk/typescript/connector_customizers/models/list-connector-customizers-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListConnectorCustomizersV1429ResponseV1', 'v1ListConnectorCustomizersV1429ResponseV1'] +--- + +# ListConnectorCustomizersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connector_customizers/docs/Models/Localeorigin.md b/sdk-output/connector_customizers/docs/Models/Localeorigin.md new file mode 100644 index 00000000..b432eb83 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/connector_customizers/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/connector_customizers/docs/Models/README.md b/sdk-output/connector_customizers/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connector_customizers/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connector_rule_management/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/connector_rule_management/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e8415f49 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,93 @@ +- path: /connector-rules/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#create-connector-rule-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const connectorrulecreaterequestV1: ConnectorrulecreaterequestV1 = ; // ConnectorrulecreaterequestV1 | Connector rule to create. + const result = await apiInstance.createConnectorRuleV1(connectorrulecreaterequestV1); + console.log(result); +- path: /connector-rules/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#delete-connector-rule-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | ID of the connector rule to delete. (default to undefined) + const result = await apiInstance.deleteConnectorRuleV1(id); + console.log(result); +- path: /connector-rules/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#get-connector-rule-list-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getConnectorRuleListV1(); + console.log(result); +- path: /connector-rules/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#get-connector-rule-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | ID of the connector rule to get. (default to undefined) + const result = await apiInstance.getConnectorRuleV1(id); + console.log(result); +- path: /connector-rules/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#put-connector-rule-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | ID of the connector rule to update. (default to undefined) + const connectorruleupdaterequestV1: ConnectorruleupdaterequestV1 = ; // ConnectorruleupdaterequestV1 | Connector rule with updated data. (optional) + const result = await apiInstance.putConnectorRuleV1(id); + console.log(result); +- path: /connector-rules/v1/validate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connector_rule_management/methods/connector-rule-management#test-connector-rule-v1 + source: | + import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorRuleManagementV1Api(configuration); + const sourcecodeV1: SourcecodeV1 = ; // SourcecodeV1 | Code to validate. + const result = await apiInstance.testConnectorRuleV1(sourcecodeV1); + console.log(result); diff --git a/sdk-output/connector_rule_management/docs/Methods/ConnectorRuleManagementV1Api.md b/sdk-output/connector_rule_management/docs/Methods/ConnectorRuleManagementV1Api.md new file mode 100644 index 00000000..77f45c8e --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Methods/ConnectorRuleManagementV1Api.md @@ -0,0 +1,266 @@ +--- +id: v1-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorRuleManagement', 'v1ConnectorRuleManagement'] +slug: /tools/sdk/typescript/connector_rule_management/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'v1ConnectorRuleManagement'] +--- + +# ConnectorRuleManagementV1Api + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. + +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-connector-rule-v1**](#create-connector-rule-v1) | **POST** `/connector-rules/v1` | Create connector rule +[**delete-connector-rule-v1**](#delete-connector-rule-v1) | **DELETE** `/connector-rules/v1/{id}` | Delete connector rule +[**get-connector-rule-list-v1**](#get-connector-rule-list-v1) | **GET** `/connector-rules/v1` | List connector rules +[**get-connector-rule-v1**](#get-connector-rule-v1) | **GET** `/connector-rules/v1/{id}` | Get connector rule +[**put-connector-rule-v1**](#put-connector-rule-v1) | **PUT** `/connector-rules/v1/{id}` | Update connector rule +[**test-connector-rule-v1**](#test-connector-rule-v1) | **POST** `/connector-rules/v1/validate` | Validate connector rule + + +## create-connector-rule-v1 +Create connector rule +Create a connector rule from the available types. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-connector-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**connectorrulecreaterequestV1** | **ConnectorrulecreaterequestV1** | Connector rule to create. | + +### Return type + +**ConnectorruleresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const connectorrulecreaterequestV1: ConnectorrulecreaterequestV1 = ; // Connector rule to create. +const result = await apiInstance.createConnectorRuleV1(connectorrulecreaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-connector-rule-v1 +Delete connector rule +Delete the connector rule for the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-connector-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector rule to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to delete. +const result = await apiInstance.deleteConnectorRuleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-rule-list-v1 +List connector rules +List existing connector rules. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-rule-list-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getConnectorRuleListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-rule-v1 +Get connector rule +Get a connector rule by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector rule to get. | [default to undefined] + +### Return type + +**ConnectorruleresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to get. +const result = await apiInstance.getConnectorRuleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-rule-v1 +Update connector rule +Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the connector rule to update. | [default to undefined] +**connectorruleupdaterequestV1** | **ConnectorruleupdaterequestV1** | Connector rule with updated data. | [optional] + +### Return type + +**ConnectorruleresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // ID of the connector rule to update. +const connectorruleupdaterequestV1: ConnectorruleupdaterequestV1 = ; // Connector rule with updated data. (optional) +const result = await apiInstance.putConnectorRuleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## test-connector-rule-v1 +Validate connector rule +Detect issues within the connector rule's code to fix and list them. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-connector-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourcecodeV1** | **SourcecodeV1** | Code to validate. | + +### Return type + +**ConnectorrulevalidationresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorRuleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorRuleManagementV1Api(configuration); +const sourcecodeV1: SourcecodeV1 = ; // Code to validate. +const result = await apiInstance.testConnectorRuleV1(sourcecodeV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/connector_rule_management/docs/Methods/Index.md b/sdk-output/connector_rule_management/docs/Methods/Index.md new file mode 100644 index 00000000..cb7bce79 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: connector_rule_management-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: connector_rule_management-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'connector_rule_management', 'methods'] +slug: /tools/sdk/typescript/connector_rule_management/methods +tags: ['SDK', 'Software Development Kit', 'connector_rule_management', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/connector_rule_management/docs/Models/Argument.md b/sdk-output/connector_rule_management/docs/Models/Argument.md new file mode 100644 index 00000000..51bc7656 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Argument.md @@ -0,0 +1,21 @@ +--- +id: v1-argument-v1 +title: ArgumentV1 +pagination_label: ArgumentV1 +sidebar_label: ArgumentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArgumentV1', 'v1ArgumentV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/argument-v1 +tags: ['SDK', 'Software Development Kit', 'ArgumentV1', 'v1ArgumentV1'] +--- + +# ArgumentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | the name of the argument | [default to undefined] +**description** | **(optional)** **string** | the description of the argument | [default to undefined] +**type** | **(optional)** **string** | the programmatic type of the argument | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Connectorrulecreaterequest.md b/sdk-output/connector_rule_management/docs/Models/Connectorrulecreaterequest.md new file mode 100644 index 00000000..e7e55275 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Connectorrulecreaterequest.md @@ -0,0 +1,24 @@ +--- +id: v1-connectorrulecreaterequest-v1 +title: ConnectorrulecreaterequestV1 +pagination_label: ConnectorrulecreaterequestV1 +sidebar_label: ConnectorrulecreaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorrulecreaterequestV1', 'v1ConnectorrulecreaterequestV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorrulecreaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorrulecreaterequestV1', 'v1ConnectorrulecreaterequestV1'] +--- + +# ConnectorrulecreaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | the name of the rule | [default to undefined] +**description** | **(optional)** **string** | a description of the rule\'s purpose | [default to undefined] +**type** | **string** | the type of rule | [default to undefined] +**signature** | **(optional)** **ConnectorrulecreaterequestSignatureV1** | | [default to undefined] +**sourceCode** | **SourcecodeV1** | | [default to undefined] +**attributes** | **(optional)** **object** | a map of string to objects | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/ConnectorrulecreaterequestSignature.md b/sdk-output/connector_rule_management/docs/Models/ConnectorrulecreaterequestSignature.md new file mode 100644 index 00000000..52e70d9b --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/ConnectorrulecreaterequestSignature.md @@ -0,0 +1,20 @@ +--- +id: v1-connectorrulecreaterequest-signature-v1 +title: ConnectorrulecreaterequestSignatureV1 +pagination_label: ConnectorrulecreaterequestSignatureV1 +sidebar_label: ConnectorrulecreaterequestSignatureV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorrulecreaterequestSignatureV1', 'v1ConnectorrulecreaterequestSignatureV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorrulecreaterequest-signature-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorrulecreaterequestSignatureV1', 'v1ConnectorrulecreaterequestSignatureV1'] +--- + +# ConnectorrulecreaterequestSignatureV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **Array<ArgumentV1>** | | [default to undefined] +**output** | **(optional)** **ArgumentV1** | | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Connectorruleresponse.md b/sdk-output/connector_rule_management/docs/Models/Connectorruleresponse.md new file mode 100644 index 00000000..6e7f214d --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Connectorruleresponse.md @@ -0,0 +1,27 @@ +--- +id: v1-connectorruleresponse-v1 +title: ConnectorruleresponseV1 +pagination_label: ConnectorruleresponseV1 +sidebar_label: ConnectorruleresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorruleresponseV1', 'v1ConnectorruleresponseV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorruleresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorruleresponseV1', 'v1ConnectorruleresponseV1'] +--- + +# ConnectorruleresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | the name of the rule | [default to undefined] +**description** | **(optional)** **string** | a description of the rule\'s purpose | [default to undefined] +**type** | **string** | the type of rule | [default to undefined] +**signature** | **(optional)** **ConnectorrulecreaterequestSignatureV1** | | [default to undefined] +**sourceCode** | **SourcecodeV1** | | [default to undefined] +**attributes** | **(optional)** **object** | a map of string to objects | [default to undefined] +**id** | **string** | the ID of the rule | [default to undefined] +**created** | **string** | an ISO 8601 UTC timestamp when this rule was created | [default to undefined] +**modified** | **(optional)** **string** | an ISO 8601 UTC timestamp when this rule was last modified | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Connectorruleupdaterequest.md b/sdk-output/connector_rule_management/docs/Models/Connectorruleupdaterequest.md new file mode 100644 index 00000000..245abac3 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Connectorruleupdaterequest.md @@ -0,0 +1,25 @@ +--- +id: v1-connectorruleupdaterequest-v1 +title: ConnectorruleupdaterequestV1 +pagination_label: ConnectorruleupdaterequestV1 +sidebar_label: ConnectorruleupdaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorruleupdaterequestV1', 'v1ConnectorruleupdaterequestV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorruleupdaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorruleupdaterequestV1', 'v1ConnectorruleupdaterequestV1'] +--- + +# ConnectorruleupdaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | the name of the rule | [default to undefined] +**description** | **(optional)** **string** | a description of the rule\'s purpose | [default to undefined] +**type** | **string** | the type of rule | [default to undefined] +**signature** | **(optional)** **ConnectorrulecreaterequestSignatureV1** | | [default to undefined] +**sourceCode** | **SourcecodeV1** | | [default to undefined] +**attributes** | **(optional)** **object** | a map of string to objects | [default to undefined] +**id** | **string** | the ID of the rule to update | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Connectorrulevalidationresponse.md b/sdk-output/connector_rule_management/docs/Models/Connectorrulevalidationresponse.md new file mode 100644 index 00000000..56aa3720 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Connectorrulevalidationresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-connectorrulevalidationresponse-v1 +title: ConnectorrulevalidationresponseV1 +pagination_label: ConnectorrulevalidationresponseV1 +sidebar_label: ConnectorrulevalidationresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorrulevalidationresponseV1', 'v1ConnectorrulevalidationresponseV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorrulevalidationresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorrulevalidationresponseV1', 'v1ConnectorrulevalidationresponseV1'] +--- + +# ConnectorrulevalidationresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **string** | | [default to undefined] +**details** | **Array<ConnectorrulevalidationresponseDetailsInnerV1>** | | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/ConnectorrulevalidationresponseDetailsInner.md b/sdk-output/connector_rule_management/docs/Models/ConnectorrulevalidationresponseDetailsInner.md new file mode 100644 index 00000000..42baf107 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/ConnectorrulevalidationresponseDetailsInner.md @@ -0,0 +1,21 @@ +--- +id: v1-connectorrulevalidationresponse-details-inner-v1 +title: ConnectorrulevalidationresponseDetailsInnerV1 +pagination_label: ConnectorrulevalidationresponseDetailsInnerV1 +sidebar_label: ConnectorrulevalidationresponseDetailsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectorrulevalidationresponseDetailsInnerV1', 'v1ConnectorrulevalidationresponseDetailsInnerV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/connectorrulevalidationresponse-details-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectorrulevalidationresponseDetailsInnerV1', 'v1ConnectorrulevalidationresponseDetailsInnerV1'] +--- + +# ConnectorrulevalidationresponseDetailsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**line** | **number** | The line number where the issue occurred | [default to undefined] +**column** | **number** | the column number where the issue occurred | [default to undefined] +**messsage** | **(optional)** **string** | a description of the issue in the code | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Errormessagedto.md b/sdk-output/connector_rule_management/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..ed5c3fd1 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Errorresponsedto.md b/sdk-output/connector_rule_management/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fbe402f0 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1401Response.md b/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1401Response.md new file mode 100644 index 00000000..a2f7d67e --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-connector-rule-list-v1401-response-v1 +title: GetConnectorRuleListV1401ResponseV1 +pagination_label: GetConnectorRuleListV1401ResponseV1 +sidebar_label: GetConnectorRuleListV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetConnectorRuleListV1401ResponseV1', 'v1GetConnectorRuleListV1401ResponseV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/get-connector-rule-list-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetConnectorRuleListV1401ResponseV1', 'v1GetConnectorRuleListV1401ResponseV1'] +--- + +# GetConnectorRuleListV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1429Response.md b/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1429Response.md new file mode 100644 index 00000000..05de49ba --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/GetConnectorRuleListV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-connector-rule-list-v1429-response-v1 +title: GetConnectorRuleListV1429ResponseV1 +pagination_label: GetConnectorRuleListV1429ResponseV1 +sidebar_label: GetConnectorRuleListV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetConnectorRuleListV1429ResponseV1', 'v1GetConnectorRuleListV1429ResponseV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/get-connector-rule-list-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetConnectorRuleListV1429ResponseV1', 'v1GetConnectorRuleListV1429ResponseV1'] +--- + +# GetConnectorRuleListV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connector_rule_management/docs/Models/Index.md b/sdk-output/connector_rule_management/docs/Models/Index.md new file mode 100644 index 00000000..5693e4f5 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: connector_rule_management-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: connector_rule_management-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'connector_rule_management', 'models'] +slug: /tools/sdk/typescript/connector_rule_management/models +tags: ['SDK', 'Software Development Kit', 'connector_rule_management', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/connector_rule_management/docs/Models/Localeorigin.md b/sdk-output/connector_rule_management/docs/Models/Localeorigin.md new file mode 100644 index 00000000..0cb3a66e --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/connector_rule_management/docs/Models/README.md b/sdk-output/connector_rule_management/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connector_rule_management/docs/Models/Sourcecode.md b/sdk-output/connector_rule_management/docs/Models/Sourcecode.md new file mode 100644 index 00000000..e31481ec --- /dev/null +++ b/sdk-output/connector_rule_management/docs/Models/Sourcecode.md @@ -0,0 +1,20 @@ +--- +id: v1-sourcecode-v1 +title: SourcecodeV1 +pagination_label: SourcecodeV1 +sidebar_label: SourcecodeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcecodeV1', 'v1SourcecodeV1'] +slug: /tools/sdk/typescript/connector_rule_management/models/sourcecode-v1 +tags: ['SDK', 'Software Development Kit', 'SourcecodeV1', 'v1SourcecodeV1'] +--- + +# SourcecodeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | the version of the code | [default to undefined] +**script** | **string** | The code | [default to undefined] + diff --git a/sdk-output/connectors/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/connectors/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..376ae66c --- /dev/null +++ b/sdk-output/connectors/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,206 @@ +- path: /connectors/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#create-custom-connector-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const v3createconnectordtoV1: V3createconnectordtoV1 = ; // V3createconnectordtoV1 | + const result = await apiInstance.createCustomConnectorV1(v3createconnectordtoV1); + console.log(result); +- path: /connectors/v1/{scriptName} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#delete-custom-connector-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const result = await apiInstance.deleteCustomConnectorV1(scriptName); + console.log(result); +- path: /connectors/v1/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-correlation-config-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. (default to undefined) + const result = await apiInstance.getConnectorCorrelationConfigV1(scriptName); + console.log(result); +- path: /connectors/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-list-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const filters: string = 'directConnect eq "true"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const locale: string = 'de'; // 'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl' | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) (default to undefined) + const result = await apiInstance.getConnectorListV1(); + console.log(result); +- path: /connectors/v1/{scriptName}/source-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-source-config-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const result = await apiInstance.getConnectorSourceConfigV1(scriptName); + console.log(result); +- path: /connectors/v1/{scriptName}/source-template + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-source-template-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const result = await apiInstance.getConnectorSourceTemplateV1(scriptName); + console.log(result); +- path: /connectors/v1/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-translations-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. (default to undefined) + const locale: string = 'de'; // 'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl' | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (default to undefined) + const result = await apiInstance.getConnectorTranslationsV1(scriptName, locale); + console.log(result); +- path: /connectors/v1/{scriptName} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#get-connector-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const locale: string = 'de'; // 'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl' | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) (default to undefined) + const result = await apiInstance.getConnectorV1(scriptName); + console.log(result); +- path: /connectors/v1/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#put-connector-correlation-config-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. (default to undefined) + const file: File = BINARY_DATA_HERE; // File | connector correlation config xml file (default to undefined) + const result = await apiInstance.putConnectorCorrelationConfigV1(scriptName, file); + console.log(result); +- path: /connectors/v1/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#put-connector-source-config-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const file: File = BINARY_DATA_HERE; // File | connector source config xml file (default to undefined) + const result = await apiInstance.putConnectorSourceConfigV1(scriptName, file); + console.log(result); +- path: /connectors/v1/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#put-connector-source-template-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const file: File = BINARY_DATA_HERE; // File | connector source template xml file (default to undefined) + const result = await apiInstance.putConnectorSourceTemplateV1(scriptName, file); + console.log(result); +- path: /connectors/v1/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#put-connector-translations-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. (default to undefined) + const locale: string = 'de'; // 'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl' | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (default to undefined) + const result = await apiInstance.putConnectorTranslationsV1(scriptName, locale); + console.log(result); +- path: /connectors/v1/{scriptName} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/connectors/methods/connectors#update-connector-v1 + source: | + import { ConnectorsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ConnectorsV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | A list of connector detail update operations + const result = await apiInstance.updateConnectorV1(scriptName, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/connectors/docs/Methods/ConnectorsV1Api.md b/sdk-output/connectors/docs/Methods/ConnectorsV1Api.md new file mode 100644 index 00000000..79744786 --- /dev/null +++ b/sdk-output/connectors/docs/Methods/ConnectorsV1Api.md @@ -0,0 +1,574 @@ +--- +id: v1-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Connectors', 'v1Connectors'] +slug: /tools/sdk/typescript/connectors/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'v1Connectors'] +--- + +# ConnectorsV1Api + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/index.html) for more information about using connectors in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-connector-v1**](#create-custom-connector-v1) | **POST** `/connectors/v1` | Create custom connector +[**delete-custom-connector-v1**](#delete-custom-connector-v1) | **DELETE** `/connectors/v1/{scriptName}` | Delete connector by script name +[**get-connector-correlation-config-v1**](#get-connector-correlation-config-v1) | **GET** `/connectors/v1/{scriptName}/correlation-config` | Get connector correlation configuration +[**get-connector-list-v1**](#get-connector-list-v1) | **GET** `/connectors/v1` | Get connector list +[**get-connector-source-config-v1**](#get-connector-source-config-v1) | **GET** `/connectors/v1/{scriptName}/source-config` | Get connector source configuration +[**get-connector-source-template-v1**](#get-connector-source-template-v1) | **GET** `/connectors/v1/{scriptName}/source-template` | Get connector source template +[**get-connector-translations-v1**](#get-connector-translations-v1) | **GET** `/connectors/v1/{scriptName}/translations/{locale}` | Get connector translations +[**get-connector-v1**](#get-connector-v1) | **GET** `/connectors/v1/{scriptName}` | Get connector by script name +[**put-connector-correlation-config-v1**](#put-connector-correlation-config-v1) | **PUT** `/connectors/v1/{scriptName}/correlation-config` | Update connector correlation configuration +[**put-connector-source-config-v1**](#put-connector-source-config-v1) | **PUT** `/connectors/v1/{scriptName}/source-config` | Update connector source configuration +[**put-connector-source-template-v1**](#put-connector-source-template-v1) | **PUT** `/connectors/v1/{scriptName}/source-template` | Update connector source template +[**put-connector-translations-v1**](#put-connector-translations-v1) | **PUT** `/connectors/v1/{scriptName}/translations/{locale}` | Update connector translations +[**update-connector-v1**](#update-connector-v1) | **PATCH** `/connectors/v1/{scriptName}` | Update connector by script name + + +## create-custom-connector-v1 +Create custom connector +Create custom connector. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-custom-connector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**v3createconnectordtoV1** | **V3createconnectordtoV1** | | + +### Return type + +**V3connectordtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const v3createconnectordtoV1: V3createconnectordtoV1 = ; // +const result = await apiInstance.createCustomConnectorV1(v3createconnectordtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-custom-connector-v1 +Delete connector by script name +Delete a custom connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-custom-connector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const result = await apiInstance.deleteCustomConnectorV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-correlation-config-v1 +Get connector correlation configuration +Fetches a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-correlation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | [default to undefined] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +const result = await apiInstance.getConnectorCorrelationConfigV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-list-v1 +Get connector list +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-list-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**locale** | **'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const filters: string = directConnect eq "true"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const locale: string = de; // The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) +const result = await apiInstance.getConnectorListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-source-config-v1 +Get connector source configuration +Fetches a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-source-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const result = await apiInstance.getConnectorSourceConfigV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-source-template-v1 +Get connector source template +Fetches a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-source-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const result = await apiInstance.getConnectorSourceTemplateV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-translations-v1 +Get connector translations +Fetches a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-translations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | [default to undefined] +**locale** | **'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | [default to undefined] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +const locale: string = de; // The locale to apply to the config. If no viable locale is given, it will default to \"en\" +const result = await apiInstance.getConnectorTranslationsV1(scriptName, locale); +console.log(result); +``` + +[[Back to top]](#) + +## get-connector-v1 +Get connector by script name +Fetches a connector that using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-connector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] +**locale** | **'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | [optional] [default to undefined] + +### Return type + +**ConnectordetailV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const locale: string = de; // The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) +const result = await apiInstance.getConnectorV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-correlation-config-v1 +Update connector correlation configuration +Update a connector's correlation config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-correlation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | [default to undefined] +**file** | **File** | connector correlation config xml file | [default to undefined] + +### Return type + +**UpdatedetailV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +const file: File = BINARY_DATA_HERE; // connector correlation config xml file +const result = await apiInstance.putConnectorCorrelationConfigV1(scriptName, file); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-source-config-v1 +Update connector source configuration +Update a connector's source config using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-source-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] +**file** | **File** | connector source config xml file | [default to undefined] + +### Return type + +**UpdatedetailV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const file: File = BINARY_DATA_HERE; // connector source config xml file +const result = await apiInstance.putConnectorSourceConfigV1(scriptName, file); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-source-template-v1 +Update connector source template +Update a connector's source template using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-source-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] +**file** | **File** | connector source template xml file | [default to undefined] + +### Return type + +**UpdatedetailV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const file: File = BINARY_DATA_HERE; // connector source template xml file +const result = await apiInstance.putConnectorSourceTemplateV1(scriptName, file); +console.log(result); +``` + +[[Back to top]](#) + +## put-connector-translations-v1 +Update connector translations +Update a connector's translations using its script name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-connector-translations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. | [default to undefined] +**locale** | **'de' | 'no' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | [default to undefined] + +### Return type + +**UpdatedetailV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +const locale: string = de; // The locale to apply to the config. If no viable locale is given, it will default to \"en\" +const result = await apiInstance.putConnectorTranslationsV1(scriptName, locale); +console.log(result); +``` + +[[Back to top]](#) + +## update-connector-v1 +Update connector by script name +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-connector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of connector detail update operations | + +### Return type + +**ConnectordetailV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ConnectorsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ConnectorsV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // A list of connector detail update operations +const result = await apiInstance.updateConnectorV1(scriptName, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/connectors/docs/Methods/Index.md b/sdk-output/connectors/docs/Methods/Index.md new file mode 100644 index 00000000..ab158aaf --- /dev/null +++ b/sdk-output/connectors/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: connectors-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: connectors-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'connectors', 'methods'] +slug: /tools/sdk/typescript/connectors/methods +tags: ['SDK', 'Software Development Kit', 'connectors', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/connectors/docs/Models/ArrayInner.md b/sdk-output/connectors/docs/Models/ArrayInner.md new file mode 100644 index 00000000..d07df29a --- /dev/null +++ b/sdk-output/connectors/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/connectors/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/connectors/docs/Models/Connectordetail.md b/sdk-output/connectors/docs/Models/Connectordetail.md new file mode 100644 index 00000000..0b0ab561 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Connectordetail.md @@ -0,0 +1,34 @@ +--- +id: v1-connectordetail-v1 +title: ConnectordetailV1 +pagination_label: ConnectordetailV1 +sidebar_label: ConnectordetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectordetailV1', 'v1ConnectordetailV1'] +slug: /tools/sdk/typescript/connectors/models/connectordetail-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectordetailV1', 'v1ConnectordetailV1'] +--- + +# ConnectordetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The connector name | [default to undefined] +**type** | **(optional)** **string** | The connector type | [default to undefined] +**className** | **(optional)** **string** | The connector class name | [default to undefined] +**scriptName** | **(optional)** **string** | The connector script name | [default to undefined] +**applicationXml** | **(optional)** **string** | The connector application xml | [default to undefined] +**correlationConfigXml** | **(optional)** **string** | The connector correlation config xml | [default to undefined] +**sourceConfigXml** | **(optional)** **string** | The connector source config xml | [default to undefined] +**sourceConfig** | **(optional)** **string** | The connector source config | [default to undefined] +**sourceConfigFrom** | **(optional)** **string** | The connector source config origin | [default to undefined] +**s3Location** | **(optional)** **string** | storage path key for this connector | [default to undefined] +**uploadedFiles** | **(optional)** **Array<string>** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [default to undefined] +**fileUpload** | **(optional)** **boolean** | true if the source is file upload | [default to false] +**directConnect** | **(optional)** **boolean** | true if the source is a direct connect source | [default to false] +**translationProperties** | **(optional)** | A map containing translation attributes by loacale key | [default to undefined] +**connectorMetadata** | **(optional)** | A map containing metadata pertinent to the UI to be used | [default to undefined] +**status** | **(optional)** **string** | The connector status | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/Errormessagedto.md b/sdk-output/connectors/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..79391557 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/connectors/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/Errorresponsedto.md b/sdk-output/connectors/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..3594e32d --- /dev/null +++ b/sdk-output/connectors/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/connectors/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/GetConnectorV1401Response.md b/sdk-output/connectors/docs/Models/GetConnectorV1401Response.md new file mode 100644 index 00000000..b5a3a98e --- /dev/null +++ b/sdk-output/connectors/docs/Models/GetConnectorV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-connector-v1401-response-v1 +title: GetConnectorV1401ResponseV1 +pagination_label: GetConnectorV1401ResponseV1 +sidebar_label: GetConnectorV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetConnectorV1401ResponseV1', 'v1GetConnectorV1401ResponseV1'] +slug: /tools/sdk/typescript/connectors/models/get-connector-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetConnectorV1401ResponseV1', 'v1GetConnectorV1401ResponseV1'] +--- + +# GetConnectorV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/GetConnectorV1429Response.md b/sdk-output/connectors/docs/Models/GetConnectorV1429Response.md new file mode 100644 index 00000000..0b1e75fa --- /dev/null +++ b/sdk-output/connectors/docs/Models/GetConnectorV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-connector-v1429-response-v1 +title: GetConnectorV1429ResponseV1 +pagination_label: GetConnectorV1429ResponseV1 +sidebar_label: GetConnectorV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetConnectorV1429ResponseV1', 'v1GetConnectorV1429ResponseV1'] +slug: /tools/sdk/typescript/connectors/models/get-connector-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetConnectorV1429ResponseV1', 'v1GetConnectorV1429ResponseV1'] +--- + +# GetConnectorV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/Index.md b/sdk-output/connectors/docs/Models/Index.md new file mode 100644 index 00000000..e71d44e2 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: connectors-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: connectors-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'connectors', 'models'] +slug: /tools/sdk/typescript/connectors/models +tags: ['SDK', 'Software Development Kit', 'connectors', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/connectors/docs/Models/Jsonpatchoperation.md b/sdk-output/connectors/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..12604194 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/connectors/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/JsonpatchoperationValue.md b/sdk-output/connectors/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..6a657e66 --- /dev/null +++ b/sdk-output/connectors/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/connectors/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/connectors/docs/Models/Localeorigin.md b/sdk-output/connectors/docs/Models/Localeorigin.md new file mode 100644 index 00000000..5e6aa307 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/connectors/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/connectors/docs/Models/PutConnectorCorrelationConfigV1Request.md b/sdk-output/connectors/docs/Models/PutConnectorCorrelationConfigV1Request.md new file mode 100644 index 00000000..d94e50ee --- /dev/null +++ b/sdk-output/connectors/docs/Models/PutConnectorCorrelationConfigV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-put-connector-correlation-config-v1-request-v1 +title: PutConnectorCorrelationConfigV1RequestV1 +pagination_label: PutConnectorCorrelationConfigV1RequestV1 +sidebar_label: PutConnectorCorrelationConfigV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutConnectorCorrelationConfigV1RequestV1', 'v1PutConnectorCorrelationConfigV1RequestV1'] +slug: /tools/sdk/typescript/connectors/models/put-connector-correlation-config-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'PutConnectorCorrelationConfigV1RequestV1', 'v1PutConnectorCorrelationConfigV1RequestV1'] +--- + +# PutConnectorCorrelationConfigV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **File** | connector correlation config xml file | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/PutConnectorSourceConfigV1Request.md b/sdk-output/connectors/docs/Models/PutConnectorSourceConfigV1Request.md new file mode 100644 index 00000000..b1fbcd3d --- /dev/null +++ b/sdk-output/connectors/docs/Models/PutConnectorSourceConfigV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-put-connector-source-config-v1-request-v1 +title: PutConnectorSourceConfigV1RequestV1 +pagination_label: PutConnectorSourceConfigV1RequestV1 +sidebar_label: PutConnectorSourceConfigV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutConnectorSourceConfigV1RequestV1', 'v1PutConnectorSourceConfigV1RequestV1'] +slug: /tools/sdk/typescript/connectors/models/put-connector-source-config-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigV1RequestV1', 'v1PutConnectorSourceConfigV1RequestV1'] +--- + +# PutConnectorSourceConfigV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **File** | connector source config xml file | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/PutConnectorSourceTemplateV1Request.md b/sdk-output/connectors/docs/Models/PutConnectorSourceTemplateV1Request.md new file mode 100644 index 00000000..2c3e5039 --- /dev/null +++ b/sdk-output/connectors/docs/Models/PutConnectorSourceTemplateV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-put-connector-source-template-v1-request-v1 +title: PutConnectorSourceTemplateV1RequestV1 +pagination_label: PutConnectorSourceTemplateV1RequestV1 +sidebar_label: PutConnectorSourceTemplateV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutConnectorSourceTemplateV1RequestV1', 'v1PutConnectorSourceTemplateV1RequestV1'] +slug: /tools/sdk/typescript/connectors/models/put-connector-source-template-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateV1RequestV1', 'v1PutConnectorSourceTemplateV1RequestV1'] +--- + +# PutConnectorSourceTemplateV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **File** | connector source template xml file | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/README.md b/sdk-output/connectors/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/connectors/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/connectors/docs/Models/Updatedetail.md b/sdk-output/connectors/docs/Models/Updatedetail.md new file mode 100644 index 00000000..cb789090 --- /dev/null +++ b/sdk-output/connectors/docs/Models/Updatedetail.md @@ -0,0 +1,22 @@ +--- +id: v1-updatedetail-v1 +title: UpdatedetailV1 +pagination_label: UpdatedetailV1 +sidebar_label: UpdatedetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdatedetailV1', 'v1UpdatedetailV1'] +slug: /tools/sdk/typescript/connectors/models/updatedetail-v1 +tags: ['SDK', 'Software Development Kit', 'UpdatedetailV1', 'v1UpdatedetailV1'] +--- + +# UpdatedetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **string** | The detailed message for an update. Typically the relevent error message when status is error. | [default to undefined] +**scriptName** | **(optional)** **string** | The connector script name | [default to undefined] +**updatedFiles** | **(optional)** **Array<string>** | The list of updated files supported by the connector | [default to undefined] +**status** | **(optional)** **string** | The connector update status | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/V3connectordto.md b/sdk-output/connectors/docs/Models/V3connectordto.md new file mode 100644 index 00000000..7ce47f1b --- /dev/null +++ b/sdk-output/connectors/docs/Models/V3connectordto.md @@ -0,0 +1,26 @@ +--- +id: v1-v3connectordto-v1 +title: V3connectordtoV1 +pagination_label: V3connectordtoV1 +sidebar_label: V3connectordtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'V3connectordtoV1', 'v1V3connectordtoV1'] +slug: /tools/sdk/typescript/connectors/models/v3connectordto-v1 +tags: ['SDK', 'Software Development Kit', 'V3connectordtoV1', 'v1V3connectordtoV1'] +--- + +# V3connectordtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The connector name | [default to undefined] +**type** | **(optional)** **string** | The connector type | [default to undefined] +**scriptName** | **(optional)** **string** | The connector script name | [default to undefined] +**className** | **(optional)** **string** | The connector class name. | [default to undefined] +**features** | **(optional)** **Array<string>** | The list of features supported by the connector | [default to undefined] +**directConnect** | **(optional)** **boolean** | true if the source is a direct connect source | [default to false] +**connectorMetadata** | **(optional)** | A map containing metadata pertinent to the connector | [default to undefined] +**status** | **(optional)** **string** | The connector status | [default to undefined] + diff --git a/sdk-output/connectors/docs/Models/V3createconnectordto.md b/sdk-output/connectors/docs/Models/V3createconnectordto.md new file mode 100644 index 00000000..984df8f8 --- /dev/null +++ b/sdk-output/connectors/docs/Models/V3createconnectordto.md @@ -0,0 +1,23 @@ +--- +id: v1-v3createconnectordto-v1 +title: V3createconnectordtoV1 +pagination_label: V3createconnectordtoV1 +sidebar_label: V3createconnectordtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'V3createconnectordtoV1', 'v1V3createconnectordtoV1'] +slug: /tools/sdk/typescript/connectors/models/v3createconnectordto-v1 +tags: ['SDK', 'Software Development Kit', 'V3createconnectordtoV1', 'v1V3createconnectordtoV1'] +--- + +# V3createconnectordtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | [default to undefined] +**type** | **(optional)** **string** | The connector type. If not specified will be defaulted to \'custom \'+name | [default to undefined] +**className** | **string** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [default to undefined] +**directConnect** | **(optional)** **boolean** | true if the source is a direct connect source | [default to true] +**status** | **(optional)** **string** | The connector status | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/custom_forms/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..70bc6027 --- /dev/null +++ b/sdk-output/custom_forms/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,290 @@ +- path: /form-definitions/v1/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#create-form-definition-dynamic-schema-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const body: FormdefinitiondynamicschemarequestV1 = {"id":"sp:forms","attributes":{"formDefinitionId":"00000000-0000-0000-0000-000000000000"},"description":"AnotherDescription","type":"action","versionNumber":1}; // FormdefinitiondynamicschemarequestV1 | Body is the request payload to create a form definition dynamic schema (optional) + const result = await apiInstance.createFormDefinitionDynamicSchemaV1(); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#create-form-definition-file-request-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | FormDefinitionID String specifying FormDefinitionID (default to undefined) + const file: File = BINARY_DATA_HERE; // File | File specifying the multipart (default to undefined) + const result = await apiInstance.createFormDefinitionFileRequestV1(formDefinitionID, file); + console.log(result); +- path: /form-definitions/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#create-form-definition-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const body: CreateformdefinitionrequestV1 = {"name":"my form","description":"my form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"},"formElements":[{"id":"000000000000","elementType":"SECTION","config":{"alignment":"LEFT","description":"elementType must be 'SECTION' for the root formElements, child formElements must be within the 'config' attribute","label":"Section","labelStyle":"h2","showLabel":true,"formElements":[{"id":"0000000000000","key":"textField","elementType":"TEXT","config":{"default":"","description":"","helpText":"form element type text","label":"Text Field","placeholder":"","required":false},"validations":[]}]}}]}; // CreateformdefinitionrequestV1 | Body is the request payload to create form definition request (optional) + const result = await apiInstance.createFormDefinitionV1(); + console.log(result); +- path: /form-instances/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#create-form-instance-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const body: CreateforminstancerequestV1 = {"expire":"2023-06-20T15:57:55.332882Z","formDefinitionId":"00000000-0000-0000-0000-000000000000","recipients":[{"type":"IDENTITY","id":"an-identity-id"}],"createdBy":{"type":"WORKFLOW_EXECUTION","id":"a-workflow-execution-id"}}; // CreateforminstancerequestV1 | Body is the request payload to create a form instance (optional) + const result = await apiInstance.createFormInstanceV1(); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#delete-form-definition-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | Form definition ID (default to undefined) + const result = await apiInstance.deleteFormDefinitionV1(formDefinitionID); + console.log(result); +- path: /form-definitions/v1/export + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#export-form-definitions-by-tenant-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const offset: number = 0; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const filters: string = 'name sw "my form"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') + const result = await apiInstance.exportFormDefinitionsByTenantV1(); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#get-file-from-s3-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | FormDefinitionID Form definition ID (default to undefined) + const fileID: string = '00000031N0J7R2B57M8YG73J7M.png'; // string | FileID String specifying the hashed name of the uploaded file we are retrieving. (default to undefined) + const result = await apiInstance.getFileFromS3V1(formDefinitionID, fileID); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#get-form-definition-by-key-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | Form definition ID (default to undefined) + const result = await apiInstance.getFormDefinitionByKeyV1(formDefinitionID); + console.log(result); +- path: /form-instances/v1/{formInstanceID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#get-form-instance-by-key-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formInstanceID: string = '00000000-0000-0000-0000-000000000000'; // string | Form instance ID (default to undefined) + const result = await apiInstance.getFormInstanceByKeyV1(formInstanceID); + console.log(result); +- path: /form-instances/v1/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#get-form-instance-file-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formInstanceID: string = '00000000-0000-0000-0000-000000000000'; // string | FormInstanceID Form instance ID (default to undefined) + const fileID: string = '00000031N0J7R2B57M8YG73J7M.png'; // string | FileID String specifying the hashed name of the uploaded file we are retrieving. (default to undefined) + const result = await apiInstance.getFormInstanceFileV1(formInstanceID, fileID); + console.log(result); +- path: /form-definitions/v1/import + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#import-form-definitions-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const body: Array<ImportFormDefinitionsV1RequestInnerV1> = [{"version":1,"self":{"name":"All fields not required","id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","type":"FORM_DEFINITION"},"object":{"id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","name":"All fields not required","description":"description","owner":{"type":"IDENTITY","id":"3447d8ec2602455ab6f1e8408a0f0150"},"usedBy":[{"type":"WORKFLOW","id":"5008594c-dacc-4295-8fee-41df60477304"},{"type":"WORKFLOW","id":"97e75a75-c179-4fbc-a2da-b5fa4aaa8743"}],"formInput":[{"type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic"}],"formElements":[{"id":"3069272797630701","elementType":"SECTION","config":{"label":"First Section","formElements":[{"id":"3069272797630700","elementType":"TEXT","key":"firstName","config":{"label":"First Name"}},{"id":"3498415402897539","elementType":"TEXT","key":"lastName","config":{"label":"Last Name"}}]}}],"formConditions":[{"ruleOperator":"AND","rules":[{"sourceType":"INPUT","source":"Department","operator":"EQ","valueType":"STRING","value":"Sales"}],"effects":[{"effectType":"HIDE","config":{"element":"2614088730489570"}}]}],"created":"2022-10-04T19:27:04.456Z","modified":"2022-11-16T20:45:02.172Z"}}]; // Array | Body is the request payload to import form definitions (optional) + const result = await apiInstance.importFormDefinitionsV1(); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#patch-form-definition-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | Form definition ID (default to undefined) + const body: Array<{ [key: string]: object; }> = [{"op":"replace","path":"/description","value":"test-description"}]; // Array<{ [key: string]: object; }> | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + const result = await apiInstance.patchFormDefinitionV1(formDefinitionID); + console.log(result); +- path: /form-instances/v1/{formInstanceID} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#patch-form-instance-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formInstanceID: string = '00000000-0000-0000-0000-000000000000'; // string | Form instance ID (default to undefined) + const body: Array<{ [key: string]: object; }> = [{"op":"replace","path":"/state","value":"SUBMITTED"},{"op":"replace","path":"/formData","value":{"a-key-1":"a-value-1","a-key-2":true,"a-key-3":1}}]; // Array<{ [key: string]: object; }> | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + const result = await apiInstance.patchFormInstanceV1(formInstanceID); + console.log(result); +- path: /form-definitions/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#search-form-definitions-by-tenant-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const offset: number = 250; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const filters: string = 'name sw "my form"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to 'name') + const result = await apiInstance.searchFormDefinitionsByTenantV1(); + console.log(result); +- path: /form-instances/v1/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#search-form-element-data-by-element-idv1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formInstanceID: string = '00000000-0000-0000-0000-000000000000'; // string | Form instance ID (default to undefined) + const formElementID: string = '1'; // string | Form element ID (default to undefined) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const filters: string = 'value eq "ID01"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) (default to undefined) + const query: string = 'support'; // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) (default to undefined) + const result = await apiInstance.searchFormElementDataByElementIDV1(formInstanceID, formElementID); + console.log(result); +- path: /form-instances/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#search-form-instances-by-tenant-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const offset: number = 0; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 100; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const filters: string = 'formDefinitionId eq "351c1daa-56f6-4bbf-b32c-49844c0b716e"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **formDefinitionId**: *eq* (optional) (default to undefined) + const result = await apiInstance.searchFormInstancesByTenantV1(); + console.log(result); +- path: /form-definitions/v1/predefined-select-options + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#search-pre-defined-select-options-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const result = await apiInstance.searchPreDefinedSelectOptionsV1(); + console.log(result); +- path: /form-definitions/v1/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_forms/methods/custom-forms#show-preview-data-source-v1 + source: | + import { CustomFormsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomFormsV1Api(configuration); + const formDefinitionID: string = '00000000-0000-0000-0000-000000000000'; // string | Form definition ID (default to undefined) + const limit: number = 10; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + const filters: string = 'value eq "ID01"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) (default to undefined) + const query: string = 'ac'; // string | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) (default to undefined) + const formelementpreviewrequestV1: FormelementpreviewrequestV1 = ; // FormelementpreviewrequestV1 | Body is the request payload to create a form definition dynamic schema (optional) + const result = await apiInstance.showPreviewDataSourceV1(formDefinitionID); + console.log(result); diff --git a/sdk-output/custom_forms/docs/Methods/CustomFormsV1Api.md b/sdk-output/custom_forms/docs/Methods/CustomFormsV1Api.md new file mode 100644 index 00000000..821c92f2 --- /dev/null +++ b/sdk-output/custom_forms/docs/Methods/CustomFormsV1Api.md @@ -0,0 +1,772 @@ +--- +id: v1-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CustomForms', 'v1CustomForms'] +slug: /tools/sdk/typescript/custom_forms/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'v1CustomForms'] +--- + +# CustomFormsV1Api + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-form-definition-dynamic-schema-v1**](#create-form-definition-dynamic-schema-v1) | **POST** `/form-definitions/v1/forms-action-dynamic-schema` | Generate json schema dynamically. +[**create-form-definition-file-request-v1**](#create-form-definition-file-request-v1) | **POST** `/form-definitions/v1/{formDefinitionID}/upload` | Upload new form definition file. +[**create-form-definition-v1**](#create-form-definition-v1) | **POST** `/form-definitions/v1` | Creates a form definition. +[**create-form-instance-v1**](#create-form-instance-v1) | **POST** `/form-instances/v1` | Creates a form instance. +[**delete-form-definition-v1**](#delete-form-definition-v1) | **DELETE** `/form-definitions/v1/{formDefinitionID}` | Deletes a form definition. +[**export-form-definitions-by-tenant-v1**](#export-form-definitions-by-tenant-v1) | **GET** `/form-definitions/v1/export` | List form definitions by tenant. +[**get-file-from-s3-v1**](#get-file-from-s3-v1) | **GET** `/form-definitions/v1/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. +[**get-form-definition-by-key-v1**](#get-form-definition-by-key-v1) | **GET** `/form-definitions/v1/{formDefinitionID}` | Return a form definition. +[**get-form-instance-by-key-v1**](#get-form-instance-by-key-v1) | **GET** `/form-instances/v1/{formInstanceID}` | Returns a form instance. +[**get-form-instance-file-v1**](#get-form-instance-file-v1) | **GET** `/form-instances/v1/{formInstanceID}/file/{fileID}` | Download instance file by fileid. +[**import-form-definitions-v1**](#import-form-definitions-v1) | **POST** `/form-definitions/v1/import` | Import form definitions from export. +[**patch-form-definition-v1**](#patch-form-definition-v1) | **PATCH** `/form-definitions/v1/{formDefinitionID}` | Patch a form definition. +[**patch-form-instance-v1**](#patch-form-instance-v1) | **PATCH** `/form-instances/v1/{formInstanceID}` | Patch a form instance. +[**search-form-definitions-by-tenant-v1**](#search-form-definitions-by-tenant-v1) | **GET** `/form-definitions/v1` | Export form definitions by tenant. +[**search-form-element-data-by-element-idv1**](#search-form-element-data-by-element-idv1) | **GET** `/form-instances/v1/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**search-form-instances-by-tenant-v1**](#search-form-instances-by-tenant-v1) | **GET** `/form-instances/v1` | List form instances by tenant. +[**search-pre-defined-select-options-v1**](#search-pre-defined-select-options-v1) | **GET** `/form-definitions/v1/predefined-select-options` | List predefined select options. +[**show-preview-data-source-v1**](#show-preview-data-source-v1) | **POST** `/form-definitions/v1/{formDefinitionID}/data-source` | Preview form definition data source. + + +## create-form-definition-dynamic-schema-v1 +Generate json schema dynamically. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-form-definition-dynamic-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**body** | **FormdefinitiondynamicschemarequestV1** | Body is the request payload to create a form definition dynamic schema | [optional] + +### Return type + +**FormdefinitiondynamicschemaresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const body: FormdefinitiondynamicschemarequestV1 = {"id":"sp:forms","attributes":{"formDefinitionId":"00000000-0000-0000-0000-000000000000"},"description":"AnotherDescription","type":"action","versionNumber":1}; // Body is the request payload to create a form definition dynamic schema (optional) +const result = await apiInstance.createFormDefinitionDynamicSchemaV1(); +console.log(result); +``` + +[[Back to top]](#) + +## create-form-definition-file-request-v1 +Upload new form definition file. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-form-definition-file-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | FormDefinitionID String specifying FormDefinitionID | [default to undefined] +**file** | **File** | File specifying the multipart | [default to undefined] + +### Return type + +**FormdefinitionfileuploadresponseV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // FormDefinitionID String specifying FormDefinitionID +const file: File = BINARY_DATA_HERE; // File specifying the multipart +const result = await apiInstance.createFormDefinitionFileRequestV1(formDefinitionID, file); +console.log(result); +``` + +[[Back to top]](#) + +## create-form-definition-v1 +Creates a form definition. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-form-definition-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**body** | **CreateformdefinitionrequestV1** | Body is the request payload to create form definition request | [optional] + +### Return type + +**FormdefinitionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const body: CreateformdefinitionrequestV1 = {"name":"my form","description":"my form description","owner":{"type":"IDENTITY","id":"00000000-0000-0000-0000-000000000000"},"formElements":[{"id":"000000000000","elementType":"SECTION","config":{"alignment":"LEFT","description":"elementType must be 'SECTION' for the root formElements, child formElements must be within the 'config' attribute","label":"Section","labelStyle":"h2","showLabel":true,"formElements":[{"id":"0000000000000","key":"textField","elementType":"TEXT","config":{"default":"","description":"","helpText":"form element type text","label":"Text Field","placeholder":"","required":false},"validations":[]}]}}]}; // Body is the request payload to create form definition request (optional) +const result = await apiInstance.createFormDefinitionV1(); +console.log(result); +``` + +[[Back to top]](#) + +## create-form-instance-v1 +Creates a form instance. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-form-instance-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**body** | **CreateforminstancerequestV1** | Body is the request payload to create a form instance | [optional] + +### Return type + +**ForminstanceresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const body: CreateforminstancerequestV1 = {"expire":"2023-06-20T15:57:55.332882Z","formDefinitionId":"00000000-0000-0000-0000-000000000000","recipients":[{"type":"IDENTITY","id":"an-identity-id"}],"createdBy":{"type":"WORKFLOW_EXECUTION","id":"a-workflow-execution-id"}}; // Body is the request payload to create a form instance (optional) +const result = await apiInstance.createFormInstanceV1(); +console.log(result); +``` + +[[Back to top]](#) + +## delete-form-definition-v1 +Deletes a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-form-definition-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | Form definition ID | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // Form definition ID +const result = await apiInstance.deleteFormDefinitionV1(formDefinitionID); +console.log(result); +``` + +[[Back to top]](#) + +## export-form-definitions-by-tenant-v1 +List form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-form-definitions-by-tenant-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** | [optional] [default to 'name'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const filters: string = name sw "my form"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) +const result = await apiInstance.exportFormDefinitionsByTenantV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-file-from-s3-v1 +Download definition file by fileid. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-file-from-s3-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | FormDefinitionID Form definition ID | [default to undefined] +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | [default to undefined] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // FormDefinitionID Form definition ID +const fileID: string = 00000031N0J7R2B57M8YG73J7M.png; // FileID String specifying the hashed name of the uploaded file we are retrieving. +const result = await apiInstance.getFileFromS3V1(formDefinitionID, fileID); +console.log(result); +``` + +[[Back to top]](#) + +## get-form-definition-by-key-v1 +Return a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-form-definition-by-key-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | Form definition ID | [default to undefined] + +### Return type + +**FormdefinitionresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // Form definition ID +const result = await apiInstance.getFormDefinitionByKeyV1(formDefinitionID); +console.log(result); +``` + +[[Back to top]](#) + +## get-form-instance-by-key-v1 +Returns a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-form-instance-by-key-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formInstanceID** | **string** | Form instance ID | [default to undefined] + +### Return type + +**ForminstanceresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formInstanceID: string = 00000000-0000-0000-0000-000000000000; // Form instance ID +const result = await apiInstance.getFormInstanceByKeyV1(formInstanceID); +console.log(result); +``` + +[[Back to top]](#) + +## get-form-instance-file-v1 +Download instance file by fileid. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-form-instance-file-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formInstanceID** | **string** | FormInstanceID Form instance ID | [default to undefined] +**fileID** | **string** | FileID String specifying the hashed name of the uploaded file we are retrieving. | [default to undefined] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formInstanceID: string = 00000000-0000-0000-0000-000000000000; // FormInstanceID Form instance ID +const fileID: string = 00000031N0J7R2B57M8YG73J7M.png; // FileID String specifying the hashed name of the uploaded file we are retrieving. +const result = await apiInstance.getFormInstanceFileV1(formInstanceID, fileID); +console.log(result); +``` + +[[Back to top]](#) + +## import-form-definitions-v1 +Import form definitions from export. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-form-definitions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**body** | **Array<ImportFormDefinitionsV1RequestInnerV1>** | Body is the request payload to import form definitions | [optional] + +### Return type + +**ImportFormDefinitionsV1202ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const body: Array<ImportFormDefinitionsV1RequestInnerV1> = [{"version":1,"self":{"name":"All fields not required","id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","type":"FORM_DEFINITION"},"object":{"id":"05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa","name":"All fields not required","description":"description","owner":{"type":"IDENTITY","id":"3447d8ec2602455ab6f1e8408a0f0150"},"usedBy":[{"type":"WORKFLOW","id":"5008594c-dacc-4295-8fee-41df60477304"},{"type":"WORKFLOW","id":"97e75a75-c179-4fbc-a2da-b5fa4aaa8743"}],"formInput":[{"type":"STRING","label":"input1","description":"A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic"}],"formElements":[{"id":"3069272797630701","elementType":"SECTION","config":{"label":"First Section","formElements":[{"id":"3069272797630700","elementType":"TEXT","key":"firstName","config":{"label":"First Name"}},{"id":"3498415402897539","elementType":"TEXT","key":"lastName","config":{"label":"Last Name"}}]}}],"formConditions":[{"ruleOperator":"AND","rules":[{"sourceType":"INPUT","source":"Department","operator":"EQ","valueType":"STRING","value":"Sales"}],"effects":[{"effectType":"HIDE","config":{"element":"2614088730489570"}}]}],"created":"2022-10-04T19:27:04.456Z","modified":"2022-11-16T20:45:02.172Z"}}]; // Body is the request payload to import form definitions (optional) +const result = await apiInstance.importFormDefinitionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-form-definition-v1 +Patch a form definition. +Parameter `{formDefinitionID}` should match a form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-form-definition-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | Form definition ID | [default to undefined] +**body** | **Array<{ [key: string]: object; }>** | Body is the request payload to patch a form definition, check: https://jsonpatch.com | [optional] + +### Return type + +**FormdefinitionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // Form definition ID +const body: Array<{ [key: string]: object; }> = [{"op":"replace","path":"/description","value":"test-description"}]; // Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) +const result = await apiInstance.patchFormDefinitionV1(formDefinitionID); +console.log(result); +``` + +[[Back to top]](#) + +## patch-form-instance-v1 +Patch a form instance. +Parameter `{formInstanceID}` should match a form instance ID. + +Only the assigned recipient (`recipients[].id` when `type` is `IDENTITY`) may call this. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-form-instance-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formInstanceID** | **string** | Form instance ID | [default to undefined] +**body** | **Array<{ [key: string]: object; }>** | Body is the request payload to patch a form instance, check: https://jsonpatch.com | [optional] + +### Return type + +**ForminstanceresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formInstanceID: string = 00000000-0000-0000-0000-000000000000; // Form instance ID +const body: Array<{ [key: string]: object; }> = [{"op":"replace","path":"/state","value":"SUBMITTED"},{"op":"replace","path":"/formData","value":{"a-key-1":"a-value-1","a-key-2":true,"a-key-3":1}}]; // Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) +const result = await apiInstance.patchFormInstanceV1(formInstanceID); +console.log(result); +``` + +[[Back to top]](#) + +## search-form-definitions-by-tenant-v1 +Export form definitions by tenant. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-form-definitions-by-tenant-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** | [optional] [default to 'name'] + +### Return type + +**ListformdefinitionsbytenantresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const offset: number = 250; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const filters: string = name sw "my form"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) +const result = await apiInstance.searchFormDefinitionsByTenantV1(); +console.log(result); +``` + +[[Back to top]](#) + +## search-form-element-data-by-element-idv1 +Retrieves dynamic data by element. +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-form-element-data-by-element-idv1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formInstanceID** | **string** | Form instance ID | [default to undefined] +**formElementID** | **string** | Form element ID | [default to undefined] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | [optional] [default to undefined] +**query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | [optional] [default to undefined] + +### Return type + +**ListformelementdatabyelementidresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formInstanceID: string = 00000000-0000-0000-0000-000000000000; // Form instance ID +const formElementID: string = 1; // Form element ID +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const filters: string = value eq "ID01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) +const query: string = support; // String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) +const result = await apiInstance.searchFormElementDataByElementIDV1(formInstanceID, formElementID); +console.log(result); +``` + +[[Back to top]](#) + +## search-form-instances-by-tenant-v1 +List form instances by tenant. +Returns a list of form instances for the tenant. Optionally filter by form definition ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-form-instances-by-tenant-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **formDefinitionId**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 100; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const filters: string = formDefinitionId eq "351c1daa-56f6-4bbf-b32c-49844c0b716e"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **formDefinitionId**: *eq* (optional) +const result = await apiInstance.searchFormInstancesByTenantV1(); +console.log(result); +``` + +[[Back to top]](#) + +## search-pre-defined-select-options-v1 +List predefined select options. +No parameters required. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-pre-defined-select-options-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**ListpredefinedselectoptionsresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const result = await apiInstance.searchPreDefinedSelectOptionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## show-preview-data-source-v1 +Preview form definition data source. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/show-preview-data-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**formDefinitionID** | **string** | Form definition ID | [default to undefined] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 10] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` | [optional] [default to undefined] +**query** | **string** | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. | [optional] [default to undefined] +**formelementpreviewrequestV1** | **FormelementpreviewrequestV1** | Body is the request payload to create a form definition dynamic schema | [optional] + +### Return type + +**PreviewdatasourceresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomFormsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomFormsV1Api(configuration); +const formDefinitionID: string = 00000000-0000-0000-0000-000000000000; // Form definition ID +const limit: number = 10; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const filters: string = value eq "ID01"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional) +const query: string = ac; // String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) +const formelementpreviewrequestV1: FormelementpreviewrequestV1 = ; // Body is the request payload to create a form definition dynamic schema (optional) +const result = await apiInstance.showPreviewDataSourceV1(formDefinitionID); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/custom_forms/docs/Methods/Index.md b/sdk-output/custom_forms/docs/Methods/Index.md new file mode 100644 index 00000000..915acd52 --- /dev/null +++ b/sdk-output/custom_forms/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: custom_forms-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: custom_forms-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_forms', 'methods'] +slug: /tools/sdk/typescript/custom_forms/methods +tags: ['SDK', 'Software Development Kit', 'custom_forms', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/custom_forms/docs/Models/Conditioneffect.md b/sdk-output/custom_forms/docs/Models/Conditioneffect.md new file mode 100644 index 00000000..77b538c2 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Conditioneffect.md @@ -0,0 +1,20 @@ +--- +id: v1-conditioneffect-v1 +title: ConditioneffectV1 +pagination_label: ConditioneffectV1 +sidebar_label: ConditioneffectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConditioneffectV1', 'v1ConditioneffectV1'] +slug: /tools/sdk/typescript/custom_forms/models/conditioneffect-v1 +tags: ['SDK', 'Software Development Kit', 'ConditioneffectV1', 'v1ConditioneffectV1'] +--- + +# ConditioneffectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effectType** | **(optional)** **string** | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [default to undefined] +**config** | **(optional)** **ConditioneffectConfigV1** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ConditioneffectConfig.md b/sdk-output/custom_forms/docs/Models/ConditioneffectConfig.md new file mode 100644 index 00000000..8edb16bd --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ConditioneffectConfig.md @@ -0,0 +1,20 @@ +--- +id: v1-conditioneffect-config-v1 +title: ConditioneffectConfigV1 +pagination_label: ConditioneffectConfigV1 +sidebar_label: ConditioneffectConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConditioneffectConfigV1', 'v1ConditioneffectConfigV1'] +slug: /tools/sdk/typescript/custom_forms/models/conditioneffect-config-v1 +tags: ['SDK', 'Software Development Kit', 'ConditioneffectConfigV1', 'v1ConditioneffectConfigV1'] +--- + +# ConditioneffectConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**defaultValueLabel** | **(optional)** **string** | Effect type\'s label. | [default to undefined] +**element** | **(optional)** **string** | Element\'s identifier. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Conditionrule.md b/sdk-output/custom_forms/docs/Models/Conditionrule.md new file mode 100644 index 00000000..7af1b613 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Conditionrule.md @@ -0,0 +1,23 @@ +--- +id: v1-conditionrule-v1 +title: ConditionruleV1 +pagination_label: ConditionruleV1 +sidebar_label: ConditionruleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConditionruleV1', 'v1ConditionruleV1'] +slug: /tools/sdk/typescript/custom_forms/models/conditionrule-v1 +tags: ['SDK', 'Software Development Kit', 'ConditionruleV1', 'v1ConditionruleV1'] +--- + +# ConditionruleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceType** | **(optional)** **string** | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [default to undefined] +**source** | **(optional)** **string** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [default to undefined] +**operator** | **(optional)** **string** | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [default to undefined] +**valueType** | **(optional)** **string** | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [default to undefined] +**value** | **(optional)** **string** | Based on the ValueType. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/CreateFormDefinitionFileRequestV1Request.md b/sdk-output/custom_forms/docs/Models/CreateFormDefinitionFileRequestV1Request.md new file mode 100644 index 00000000..7bce6980 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/CreateFormDefinitionFileRequestV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-create-form-definition-file-request-v1-request-v1 +title: CreateFormDefinitionFileRequestV1RequestV1 +pagination_label: CreateFormDefinitionFileRequestV1RequestV1 +sidebar_label: CreateFormDefinitionFileRequestV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateFormDefinitionFileRequestV1RequestV1', 'v1CreateFormDefinitionFileRequestV1RequestV1'] +slug: /tools/sdk/typescript/custom_forms/models/create-form-definition-file-request-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestV1RequestV1', 'v1CreateFormDefinitionFileRequestV1RequestV1'] +--- + +# CreateFormDefinitionFileRequestV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **File** | File specifying the multipart | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Createformdefinitionrequest.md b/sdk-output/custom_forms/docs/Models/Createformdefinitionrequest.md new file mode 100644 index 00000000..aeb7908e --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Createformdefinitionrequest.md @@ -0,0 +1,25 @@ +--- +id: v1-createformdefinitionrequest-v1 +title: CreateformdefinitionrequestV1 +pagination_label: CreateformdefinitionrequestV1 +sidebar_label: CreateformdefinitionrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateformdefinitionrequestV1', 'v1CreateformdefinitionrequestV1'] +slug: /tools/sdk/typescript/custom_forms/models/createformdefinitionrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateformdefinitionrequestV1', 'v1CreateformdefinitionrequestV1'] +--- + +# CreateformdefinitionrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **(optional)** **string** | Description is the form definition description | [default to undefined] +**formConditions** | **(optional)** **Array<FormconditionV1>** | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [default to undefined] +**formElements** | **(optional)** **Array<FormelementV1>** | FormElements is a list of nested form elements | [default to undefined] +**formInput** | **(optional)** **Array<FormdefinitioninputV1>** | FormInput is a list of form inputs that are required when creating a form-instance object | [default to undefined] +**name** | **string** | Name is the form definition name | [default to undefined] +**owner** | **FormownerV1** | | [default to undefined] +**usedBy** | **(optional)** **Array<FormusedbyV1>** | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Createforminstancerequest.md b/sdk-output/custom_forms/docs/Models/Createforminstancerequest.md new file mode 100644 index 00000000..9c04f404 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Createforminstancerequest.md @@ -0,0 +1,26 @@ +--- +id: v1-createforminstancerequest-v1 +title: CreateforminstancerequestV1 +pagination_label: CreateforminstancerequestV1 +sidebar_label: CreateforminstancerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateforminstancerequestV1', 'v1CreateforminstancerequestV1'] +slug: /tools/sdk/typescript/custom_forms/models/createforminstancerequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateforminstancerequestV1', 'v1CreateforminstancerequestV1'] +--- + +# CreateforminstancerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdBy** | **ForminstancecreatedbyV1** | | [default to undefined] +**expire** | **string** | Expire is required | [default to undefined] +**formDefinitionId** | **string** | FormDefinitionID is the id of the form definition that created this form | [default to undefined] +**formInput** | **(optional)** | FormInput is an object of form input labels to value | [default to undefined] +**recipients** | **Array<ForminstancerecipientV1>** | Recipients is required | [default to undefined] +**standAloneForm** | **(optional)** **boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [default to false] +**state** | **(optional)** **string** | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [default to undefined] +**ttl** | **(optional)** **number** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Error.md b/sdk-output/custom_forms/docs/Models/Error.md new file mode 100644 index 00000000..40b20044 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Error.md @@ -0,0 +1,21 @@ +--- +id: v1-error-v1 +title: ErrorV1 +pagination_label: ErrorV1 +sidebar_label: ErrorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorV1', 'v1ErrorV1'] +slug: /tools/sdk/typescript/custom_forms/models/error-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorV1', 'v1ErrorV1'] +--- + +# ErrorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | DetailCode is the text of the status code returned | [default to undefined] +**messages** | **(optional)** **Array<ErrormessageV1>** | | [default to undefined] +**trackingId** | **(optional)** **string** | TrackingID is the request tracking unique identifier | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Errormessage.md b/sdk-output/custom_forms/docs/Models/Errormessage.md new file mode 100644 index 00000000..5d86e835 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Errormessage.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessage-v1 +title: ErrormessageV1 +pagination_label: ErrormessageV1 +sidebar_label: ErrormessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessageV1', 'v1ErrormessageV1'] +slug: /tools/sdk/typescript/custom_forms/models/errormessage-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessageV1', 'v1ErrormessageV1'] +--- + +# ErrormessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | Locale is the current Locale | [default to undefined] +**localeOrigin** | **(optional)** **string** | LocaleOrigin holds possible values of how the locale was selected | [default to undefined] +**text** | **(optional)** **string** | Text is the actual text of the error message | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInner.md b/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInner.md new file mode 100644 index 00000000..a04f30da --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInner.md @@ -0,0 +1,21 @@ +--- +id: v1-export-form-definitions-by-tenant-v1200-response-inner-v1 +title: ExportFormDefinitionsByTenantV1200ResponseInnerV1 +pagination_label: ExportFormDefinitionsByTenantV1200ResponseInnerV1 +sidebar_label: ExportFormDefinitionsByTenantV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportFormDefinitionsByTenantV1200ResponseInnerV1', 'v1ExportFormDefinitionsByTenantV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/custom_forms/models/export-form-definitions-by-tenant-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenantV1200ResponseInnerV1', 'v1ExportFormDefinitionsByTenantV1200ResponseInnerV1'] +--- + +# ExportFormDefinitionsByTenantV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | **(optional)** **FormdefinitionresponseV1** | | [default to undefined] +**self** | **(optional)** **ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1** | | [default to undefined] +**version** | **(optional)** **number** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInnerSelf.md b/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInnerSelf.md new file mode 100644 index 00000000..31b4e445 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ExportFormDefinitionsByTenantV1200ResponseInnerSelf.md @@ -0,0 +1,19 @@ +--- +id: v1-export-form-definitions-by-tenant-v1200-response-inner-self-v1 +title: ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 +pagination_label: ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 +sidebar_label: ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1', 'v1ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1'] +slug: /tools/sdk/typescript/custom_forms/models/export-form-definitions-by-tenant-v1200-response-inner-self-v1 +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1', 'v1ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1'] +--- + +# ExportFormDefinitionsByTenantV1200ResponseInnerSelfV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | **(optional)** **FormdefinitionselfimportexportdtoV1** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formcondition.md b/sdk-output/custom_forms/docs/Models/Formcondition.md new file mode 100644 index 00000000..1b130f35 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formcondition.md @@ -0,0 +1,21 @@ +--- +id: v1-formcondition-v1 +title: FormconditionV1 +pagination_label: FormconditionV1 +sidebar_label: FormconditionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormconditionV1', 'v1FormconditionV1'] +slug: /tools/sdk/typescript/custom_forms/models/formcondition-v1 +tags: ['SDK', 'Software Development Kit', 'FormconditionV1', 'v1FormconditionV1'] +--- + +# FormconditionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ruleOperator** | **(optional)** **string** | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [default to undefined] +**rules** | **(optional)** **Array<ConditionruleV1>** | List of rules. | [default to undefined] +**effects** | **(optional)** **Array<ConditioneffectV1>** | List of effects. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemarequest.md b/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemarequest.md new file mode 100644 index 00000000..779b1710 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemarequest.md @@ -0,0 +1,23 @@ +--- +id: v1-formdefinitiondynamicschemarequest-v1 +title: FormdefinitiondynamicschemarequestV1 +pagination_label: FormdefinitiondynamicschemarequestV1 +sidebar_label: FormdefinitiondynamicschemarequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitiondynamicschemarequestV1', 'v1FormdefinitiondynamicschemarequestV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitiondynamicschemarequest-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitiondynamicschemarequestV1', 'v1FormdefinitiondynamicschemarequestV1'] +--- + +# FormdefinitiondynamicschemarequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **FormdefinitiondynamicschemarequestAttributesV1** | | [default to undefined] +**description** | **(optional)** **string** | Description is the form definition dynamic schema description text | [default to undefined] +**id** | **(optional)** **string** | ID is a unique identifier | [default to undefined] +**type** | **(optional)** **string** | Type is the form definition dynamic schema type | [default to undefined] +**versionNumber** | **(optional)** **number** | VersionNumber is the form definition dynamic schema version number | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/FormdefinitiondynamicschemarequestAttributes.md b/sdk-output/custom_forms/docs/Models/FormdefinitiondynamicschemarequestAttributes.md new file mode 100644 index 00000000..aa03b37b --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/FormdefinitiondynamicschemarequestAttributes.md @@ -0,0 +1,19 @@ +--- +id: v1-formdefinitiondynamicschemarequest-attributes-v1 +title: FormdefinitiondynamicschemarequestAttributesV1 +pagination_label: FormdefinitiondynamicschemarequestAttributesV1 +sidebar_label: FormdefinitiondynamicschemarequestAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitiondynamicschemarequestAttributesV1', 'v1FormdefinitiondynamicschemarequestAttributesV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitiondynamicschemarequest-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitiondynamicschemarequestAttributesV1', 'v1FormdefinitiondynamicschemarequestAttributesV1'] +--- + +# FormdefinitiondynamicschemarequestAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**formDefinitionId** | **(optional)** **string** | FormDefinitionID is a unique guid identifying this form definition | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemaresponse.md b/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemaresponse.md new file mode 100644 index 00000000..7d80b870 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitiondynamicschemaresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-formdefinitiondynamicschemaresponse-v1 +title: FormdefinitiondynamicschemaresponseV1 +pagination_label: FormdefinitiondynamicschemaresponseV1 +sidebar_label: FormdefinitiondynamicschemaresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitiondynamicschemaresponseV1', 'v1FormdefinitiondynamicschemaresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitiondynamicschemaresponse-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitiondynamicschemaresponseV1', 'v1FormdefinitiondynamicschemaresponseV1'] +--- + +# FormdefinitiondynamicschemaresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**outputSchema** | **(optional)** | OutputSchema holds a JSON schema generated dynamically | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitionfileuploadresponse.md b/sdk-output/custom_forms/docs/Models/Formdefinitionfileuploadresponse.md new file mode 100644 index 00000000..0ed357c1 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitionfileuploadresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-formdefinitionfileuploadresponse-v1 +title: FormdefinitionfileuploadresponseV1 +pagination_label: FormdefinitionfileuploadresponseV1 +sidebar_label: FormdefinitionfileuploadresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitionfileuploadresponseV1', 'v1FormdefinitionfileuploadresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitionfileuploadresponse-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitionfileuploadresponseV1', 'v1FormdefinitionfileuploadresponseV1'] +--- + +# FormdefinitionfileuploadresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **(optional)** **string** | Created is the date the file was uploaded | [default to undefined] +**fileId** | **(optional)** **string** | fileId is a unique ULID that serves as an identifier for the form definition file | [default to undefined] +**formDefinitionId** | **(optional)** **string** | FormDefinitionID is a unique guid identifying this form definition | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitioninput.md b/sdk-output/custom_forms/docs/Models/Formdefinitioninput.md new file mode 100644 index 00000000..09eb7e91 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitioninput.md @@ -0,0 +1,22 @@ +--- +id: v1-formdefinitioninput-v1 +title: FormdefinitioninputV1 +pagination_label: FormdefinitioninputV1 +sidebar_label: FormdefinitioninputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitioninputV1', 'v1FormdefinitioninputV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitioninput-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitioninputV1', 'v1FormdefinitioninputV1'] +--- + +# FormdefinitioninputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the form input. | [default to undefined] +**type** | **(optional)** **string** | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [default to undefined] +**label** | **(optional)** **string** | Name for the form input. | [default to undefined] +**description** | **(optional)** **string** | Form input\'s description. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitionresponse.md b/sdk-output/custom_forms/docs/Models/Formdefinitionresponse.md new file mode 100644 index 00000000..628d5d91 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitionresponse.md @@ -0,0 +1,28 @@ +--- +id: v1-formdefinitionresponse-v1 +title: FormdefinitionresponseV1 +pagination_label: FormdefinitionresponseV1 +sidebar_label: FormdefinitionresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitionresponseV1', 'v1FormdefinitionresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitionresponse-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitionresponseV1', 'v1FormdefinitionresponseV1'] +--- + +# FormdefinitionresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique guid identifying the form definition. | [default to undefined] +**name** | **(optional)** **string** | Name of the form definition. | [default to undefined] +**description** | **(optional)** **string** | Form definition\'s description. | [default to undefined] +**owner** | **(optional)** **FormownerV1** | | [default to undefined] +**usedBy** | **(optional)** **Array<FormusedbyV1>** | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [default to undefined] +**formInput** | **(optional)** **Array<FormdefinitioninputV1>** | List of form inputs required to create a form-instance object. | [default to undefined] +**formElements** | **(optional)** **Array<FormelementV1>** | List of nested form elements. | [default to undefined] +**formConditions** | **(optional)** **Array<FormconditionV1>** | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [default to undefined] +**created** | **(optional)** **string** | Created is the date the form definition was created | [default to undefined] +**modified** | **(optional)** **string** | Modified is the last date the form definition was modified | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formdefinitionselfimportexportdto.md b/sdk-output/custom_forms/docs/Models/Formdefinitionselfimportexportdto.md new file mode 100644 index 00000000..c623936e --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formdefinitionselfimportexportdto.md @@ -0,0 +1,21 @@ +--- +id: v1-formdefinitionselfimportexportdto-v1 +title: FormdefinitionselfimportexportdtoV1 +pagination_label: FormdefinitionselfimportexportdtoV1 +sidebar_label: FormdefinitionselfimportexportdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdefinitionselfimportexportdtoV1', 'v1FormdefinitionselfimportexportdtoV1'] +slug: /tools/sdk/typescript/custom_forms/models/formdefinitionselfimportexportdto-v1 +tags: ['SDK', 'Software Development Kit', 'FormdefinitionselfimportexportdtoV1', 'v1FormdefinitionselfimportexportdtoV1'] +--- + +# FormdefinitionselfimportexportdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Imported/exported object\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Imported/exported object\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Imported/exported object\'s display name. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelement.md b/sdk-output/custom_forms/docs/Models/Formelement.md new file mode 100644 index 00000000..4b901437 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelement.md @@ -0,0 +1,23 @@ +--- +id: v1-formelement-v1 +title: FormelementV1 +pagination_label: FormelementV1 +sidebar_label: FormelementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementV1', 'v1FormelementV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelement-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementV1', 'v1FormelementV1'] +--- + +# FormelementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Form element identifier. | [default to undefined] +**elementType** | **(optional)** **string** | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [default to undefined] +**config** | **(optional)** | Config object. | [default to undefined] +**key** | **(optional)** **string** | Technical key. | [default to undefined] +**validations** | **(optional)** **Array<FormelementvalidationssetV1>** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelementdatasourceconfigoptions.md b/sdk-output/custom_forms/docs/Models/Formelementdatasourceconfigoptions.md new file mode 100644 index 00000000..3325b8a0 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelementdatasourceconfigoptions.md @@ -0,0 +1,21 @@ +--- +id: v1-formelementdatasourceconfigoptions-v1 +title: FormelementdatasourceconfigoptionsV1 +pagination_label: FormelementdatasourceconfigoptionsV1 +sidebar_label: FormelementdatasourceconfigoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementdatasourceconfigoptionsV1', 'v1FormelementdatasourceconfigoptionsV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelementdatasourceconfigoptions-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementdatasourceconfigoptionsV1', 'v1FormelementdatasourceconfigoptionsV1'] +--- + +# FormelementdatasourceconfigoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **(optional)** **string** | Label is the main label to display to the user when selecting this option | [default to undefined] +**subLabel** | **(optional)** **string** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [default to undefined] +**value** | **(optional)** **string** | Value is the value to save as an entry when the user selects this option | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasource.md b/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasource.md new file mode 100644 index 00000000..b8e18771 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasource.md @@ -0,0 +1,20 @@ +--- +id: v1-formelementdynamicdatasource-v1 +title: FormelementdynamicdatasourceV1 +pagination_label: FormelementdynamicdatasourceV1 +sidebar_label: FormelementdynamicdatasourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementdynamicdatasourceV1', 'v1FormelementdynamicdatasourceV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelementdynamicdatasource-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementdynamicdatasourceV1', 'v1FormelementdynamicdatasourceV1'] +--- + +# FormelementdynamicdatasourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**config** | **(optional)** **FormelementdynamicdatasourceconfigV1** | | [default to undefined] +**dataSourceType** | **(optional)** **string** | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasourceconfig.md b/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasourceconfig.md new file mode 100644 index 00000000..a8a7e40d --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelementdynamicdatasourceconfig.md @@ -0,0 +1,22 @@ +--- +id: v1-formelementdynamicdatasourceconfig-v1 +title: FormelementdynamicdatasourceconfigV1 +pagination_label: FormelementdynamicdatasourceconfigV1 +sidebar_label: FormelementdynamicdatasourceconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementdynamicdatasourceconfigV1', 'v1FormelementdynamicdatasourceconfigV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelementdynamicdatasourceconfig-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementdynamicdatasourceconfigV1', 'v1FormelementdynamicdatasourceconfigV1'] +--- + +# FormelementdynamicdatasourceconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregationBucketField** | **(optional)** **string** | AggregationBucketField is the aggregation bucket field name | [default to undefined] +**indices** | **(optional)** **Array<string>** | Indices is a list of indices to use | [default to undefined] +**objectType** | **(optional)** **string** | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [default to undefined] +**query** | **(optional)** **string** | Query is a text | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelementpreviewrequest.md b/sdk-output/custom_forms/docs/Models/Formelementpreviewrequest.md new file mode 100644 index 00000000..ddf5a631 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelementpreviewrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-formelementpreviewrequest-v1 +title: FormelementpreviewrequestV1 +pagination_label: FormelementpreviewrequestV1 +sidebar_label: FormelementpreviewrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementpreviewrequestV1', 'v1FormelementpreviewrequestV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelementpreviewrequest-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementpreviewrequestV1', 'v1FormelementpreviewrequestV1'] +--- + +# FormelementpreviewrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dataSource** | **(optional)** **FormelementdynamicdatasourceV1** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formelementvalidationsset.md b/sdk-output/custom_forms/docs/Models/Formelementvalidationsset.md new file mode 100644 index 00000000..165af817 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formelementvalidationsset.md @@ -0,0 +1,19 @@ +--- +id: v1-formelementvalidationsset-v1 +title: FormelementvalidationssetV1 +pagination_label: FormelementvalidationssetV1 +sidebar_label: FormelementvalidationssetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormelementvalidationssetV1', 'v1FormelementvalidationssetV1'] +slug: /tools/sdk/typescript/custom_forms/models/formelementvalidationsset-v1 +tags: ['SDK', 'Software Development Kit', 'FormelementvalidationssetV1', 'v1FormelementvalidationssetV1'] +--- + +# FormelementvalidationssetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**validationType** | **(optional)** **string** | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formerror.md b/sdk-output/custom_forms/docs/Models/Formerror.md new file mode 100644 index 00000000..9b0284b1 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formerror.md @@ -0,0 +1,21 @@ +--- +id: v1-formerror-v1 +title: FormerrorV1 +pagination_label: FormerrorV1 +sidebar_label: FormerrorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormerrorV1', 'v1FormerrorV1'] +slug: /tools/sdk/typescript/custom_forms/models/formerror-v1 +tags: ['SDK', 'Software Development Kit', 'FormerrorV1', 'v1FormerrorV1'] +--- + +# FormerrorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Key is the technical key | [default to undefined] +**messages** | **(optional)** **Array<ErrormessageV1>** | Messages is a list of web.ErrorMessage items | [default to undefined] +**value** | **(optional)** **any** | Value is the value associated with a Key | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Forminstancecreatedby.md b/sdk-output/custom_forms/docs/Models/Forminstancecreatedby.md new file mode 100644 index 00000000..6274e658 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Forminstancecreatedby.md @@ -0,0 +1,20 @@ +--- +id: v1-forminstancecreatedby-v1 +title: ForminstancecreatedbyV1 +pagination_label: ForminstancecreatedbyV1 +sidebar_label: ForminstancecreatedbyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ForminstancecreatedbyV1', 'v1ForminstancecreatedbyV1'] +slug: /tools/sdk/typescript/custom_forms/models/forminstancecreatedby-v1 +tags: ['SDK', 'Software Development Kit', 'ForminstancecreatedbyV1', 'v1ForminstancecreatedbyV1'] +--- + +# ForminstancecreatedbyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID is a unique identifier | [default to undefined] +**type** | **(optional)** **string** | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Forminstancerecipient.md b/sdk-output/custom_forms/docs/Models/Forminstancerecipient.md new file mode 100644 index 00000000..f7e87909 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Forminstancerecipient.md @@ -0,0 +1,20 @@ +--- +id: v1-forminstancerecipient-v1 +title: ForminstancerecipientV1 +pagination_label: ForminstancerecipientV1 +sidebar_label: ForminstancerecipientV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ForminstancerecipientV1', 'v1ForminstancerecipientV1'] +slug: /tools/sdk/typescript/custom_forms/models/forminstancerecipient-v1 +tags: ['SDK', 'Software Development Kit', 'ForminstancerecipientV1', 'v1ForminstancerecipientV1'] +--- + +# ForminstancerecipientV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID is a unique identifier | [default to undefined] +**type** | **(optional)** **string** | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Forminstanceresponse.md b/sdk-output/custom_forms/docs/Models/Forminstanceresponse.md new file mode 100644 index 00000000..1ac076a4 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Forminstanceresponse.md @@ -0,0 +1,33 @@ +--- +id: v1-forminstanceresponse-v1 +title: ForminstanceresponseV1 +pagination_label: ForminstanceresponseV1 +sidebar_label: ForminstanceresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ForminstanceresponseV1', 'v1ForminstanceresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/forminstanceresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ForminstanceresponseV1', 'v1ForminstanceresponseV1'] +--- + +# ForminstanceresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique guid identifying this form instance | [default to undefined] +**expire** | **(optional)** **string** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [default to undefined] +**state** | **(optional)** **string** | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [default to undefined] +**standAloneForm** | **(optional)** **boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [default to false] +**standAloneFormUrl** | **(optional)** **string** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [default to undefined] +**createdBy** | **(optional)** **ForminstancecreatedbyV1** | | [default to undefined] +**formDefinitionId** | **(optional)** **string** | FormDefinitionID is the id of the form definition that created this form | [default to undefined] +**formInput** | **(optional)** | FormInput is an object of form input labels to value | [default to undefined] +**formElements** | **(optional)** **Array<FormelementV1>** | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [default to undefined] +**formData** | **(optional)** | FormData is the data provided by the form on submit. The data is in a key -> value map | [default to undefined] +**formErrors** | **(optional)** **Array<FormerrorV1>** | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [default to undefined] +**formConditions** | **(optional)** **Array<FormconditionV1>** | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [default to undefined] +**created** | **(optional)** **string** | Created is the date the form instance was assigned | [default to undefined] +**modified** | **(optional)** **string** | Modified is the last date the form instance was modified | [default to undefined] +**recipients** | **(optional)** **Array<ForminstancerecipientV1>** | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formowner.md b/sdk-output/custom_forms/docs/Models/Formowner.md new file mode 100644 index 00000000..8965ec7e --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formowner.md @@ -0,0 +1,21 @@ +--- +id: v1-formowner-v1 +title: FormownerV1 +pagination_label: FormownerV1 +sidebar_label: FormownerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormownerV1', 'v1FormownerV1'] +slug: /tools/sdk/typescript/custom_forms/models/formowner-v1 +tags: ['SDK', 'Software Development Kit', 'FormownerV1', 'v1FormownerV1'] +--- + +# FormownerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [default to undefined] +**id** | **(optional)** **string** | Unique identifier of the form\'s owner. | [default to undefined] +**name** | **(optional)** **string** | Name of the form\'s owner. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Formusedby.md b/sdk-output/custom_forms/docs/Models/Formusedby.md new file mode 100644 index 00000000..e063e912 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Formusedby.md @@ -0,0 +1,21 @@ +--- +id: v1-formusedby-v1 +title: FormusedbyV1 +pagination_label: FormusedbyV1 +sidebar_label: FormusedbyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormusedbyV1', 'v1FormusedbyV1'] +slug: /tools/sdk/typescript/custom_forms/models/formusedby-v1 +tags: ['SDK', 'Software Development Kit', 'FormusedbyV1', 'v1FormusedbyV1'] +--- + +# FormusedbyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [default to undefined] +**id** | **(optional)** **string** | Unique identifier of the system using the form. | [default to undefined] +**name** | **(optional)** **string** | Name of the system using the form. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202Response.md b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202Response.md new file mode 100644 index 00000000..e9b824e5 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202Response.md @@ -0,0 +1,22 @@ +--- +id: v1-import-form-definitions-v1202-response-v1 +title: ImportFormDefinitionsV1202ResponseV1 +pagination_label: ImportFormDefinitionsV1202ResponseV1 +sidebar_label: ImportFormDefinitionsV1202ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportFormDefinitionsV1202ResponseV1', 'v1ImportFormDefinitionsV1202ResponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/import-form-definitions-v1202-response-v1 +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsV1202ResponseV1', 'v1ImportFormDefinitionsV1202ResponseV1'] +--- + +# ImportFormDefinitionsV1202ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | **(optional)** **Array<ImportFormDefinitionsV1202ResponseErrorsInnerV1>** | | [default to undefined] +**importedObjects** | **(optional)** **Array<ImportFormDefinitionsV1RequestInnerV1>** | | [default to undefined] +**infos** | **(optional)** **Array<ImportFormDefinitionsV1202ResponseErrorsInnerV1>** | | [default to undefined] +**warnings** | **(optional)** **Array<ImportFormDefinitionsV1202ResponseErrorsInnerV1>** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202ResponseErrorsInner.md b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202ResponseErrorsInner.md new file mode 100644 index 00000000..d7d8a9bb --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1202ResponseErrorsInner.md @@ -0,0 +1,21 @@ +--- +id: v1-import-form-definitions-v1202-response-errors-inner-v1 +title: ImportFormDefinitionsV1202ResponseErrorsInnerV1 +pagination_label: ImportFormDefinitionsV1202ResponseErrorsInnerV1 +sidebar_label: ImportFormDefinitionsV1202ResponseErrorsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportFormDefinitionsV1202ResponseErrorsInnerV1', 'v1ImportFormDefinitionsV1202ResponseErrorsInnerV1'] +slug: /tools/sdk/typescript/custom_forms/models/import-form-definitions-v1202-response-errors-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsV1202ResponseErrorsInnerV1', 'v1ImportFormDefinitionsV1202ResponseErrorsInnerV1'] +--- + +# ImportFormDefinitionsV1202ResponseErrorsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detail** | **(optional)** | | [default to undefined] +**key** | **(optional)** **string** | | [default to undefined] +**text** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1RequestInner.md b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1RequestInner.md new file mode 100644 index 00000000..03fe390d --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/ImportFormDefinitionsV1RequestInner.md @@ -0,0 +1,21 @@ +--- +id: v1-import-form-definitions-v1-request-inner-v1 +title: ImportFormDefinitionsV1RequestInnerV1 +pagination_label: ImportFormDefinitionsV1RequestInnerV1 +sidebar_label: ImportFormDefinitionsV1RequestInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportFormDefinitionsV1RequestInnerV1', 'v1ImportFormDefinitionsV1RequestInnerV1'] +slug: /tools/sdk/typescript/custom_forms/models/import-form-definitions-v1-request-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsV1RequestInnerV1', 'v1ImportFormDefinitionsV1RequestInnerV1'] +--- + +# ImportFormDefinitionsV1RequestInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | **(optional)** **FormdefinitionresponseV1** | | [default to undefined] +**self** | **(optional)** **string** | | [default to undefined] +**version** | **(optional)** **number** | | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Index.md b/sdk-output/custom_forms/docs/Models/Index.md new file mode 100644 index 00000000..7153728e --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: custom_forms-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: custom_forms-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_forms', 'models'] +slug: /tools/sdk/typescript/custom_forms/models +tags: ['SDK', 'Software Development Kit', 'custom_forms', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/custom_forms/docs/Models/Listformdefinitionsbytenantresponse.md b/sdk-output/custom_forms/docs/Models/Listformdefinitionsbytenantresponse.md new file mode 100644 index 00000000..e78ecd7f --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Listformdefinitionsbytenantresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-listformdefinitionsbytenantresponse-v1 +title: ListformdefinitionsbytenantresponseV1 +pagination_label: ListformdefinitionsbytenantresponseV1 +sidebar_label: ListformdefinitionsbytenantresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListformdefinitionsbytenantresponseV1', 'v1ListformdefinitionsbytenantresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/listformdefinitionsbytenantresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ListformdefinitionsbytenantresponseV1', 'v1ListformdefinitionsbytenantresponseV1'] +--- + +# ListformdefinitionsbytenantresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **(optional)** **number** | Count number of results. | [default to undefined] +**results** | **(optional)** **Array<FormdefinitionresponseV1>** | List of FormDefinitionResponse items. | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Listformelementdatabyelementidresponse.md b/sdk-output/custom_forms/docs/Models/Listformelementdatabyelementidresponse.md new file mode 100644 index 00000000..971ad2bb --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Listformelementdatabyelementidresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-listformelementdatabyelementidresponse-v1 +title: ListformelementdatabyelementidresponseV1 +pagination_label: ListformelementdatabyelementidresponseV1 +sidebar_label: ListformelementdatabyelementidresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListformelementdatabyelementidresponseV1', 'v1ListformelementdatabyelementidresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/listformelementdatabyelementidresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ListformelementdatabyelementidresponseV1', 'v1ListformelementdatabyelementidresponseV1'] +--- + +# ListformelementdatabyelementidresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | **(optional)** **Array<FormelementdatasourceconfigoptionsV1>** | Results holds a list of FormElementDataSourceConfigOptions items | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Listforminstancesbytenantresponse.md b/sdk-output/custom_forms/docs/Models/Listforminstancesbytenantresponse.md new file mode 100644 index 00000000..14788ce8 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Listforminstancesbytenantresponse.md @@ -0,0 +1,33 @@ +--- +id: v1-listforminstancesbytenantresponse-v1 +title: ListforminstancesbytenantresponseV1 +pagination_label: ListforminstancesbytenantresponseV1 +sidebar_label: ListforminstancesbytenantresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListforminstancesbytenantresponseV1', 'v1ListforminstancesbytenantresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/listforminstancesbytenantresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ListforminstancesbytenantresponseV1', 'v1ListforminstancesbytenantresponseV1'] +--- + +# ListforminstancesbytenantresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique guid identifying this form instance | [default to undefined] +**expire** | **(optional)** **string** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [default to undefined] +**state** | **(optional)** **string** | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [default to undefined] +**standAloneForm** | **(optional)** **boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [default to false] +**standAloneFormUrl** | **(optional)** **string** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [default to undefined] +**createdBy** | **(optional)** **ForminstancecreatedbyV1** | | [default to undefined] +**formDefinitionId** | **(optional)** **string** | FormDefinitionID is the id of the form definition that created this form | [default to undefined] +**formInput** | **(optional)** | FormInput is an object of form input labels to value | [default to undefined] +**formElements** | **(optional)** **Array<FormelementV1>** | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [default to undefined] +**formData** | **(optional)** | FormData is the data provided by the form on submit. The data is in a key -> value map | [default to undefined] +**formErrors** | **(optional)** **Array<FormerrorV1>** | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [default to undefined] +**formConditions** | **(optional)** **Array<FormconditionV1>** | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [default to undefined] +**created** | **(optional)** **string** | Created is the date the form instance was assigned | [default to undefined] +**modified** | **(optional)** **string** | Modified is the last date the form instance was modified | [default to undefined] +**recipients** | **(optional)** **Array<ForminstancerecipientV1>** | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Listpredefinedselectoptionsresponse.md b/sdk-output/custom_forms/docs/Models/Listpredefinedselectoptionsresponse.md new file mode 100644 index 00000000..795ff91d --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Listpredefinedselectoptionsresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-listpredefinedselectoptionsresponse-v1 +title: ListpredefinedselectoptionsresponseV1 +pagination_label: ListpredefinedselectoptionsresponseV1 +sidebar_label: ListpredefinedselectoptionsresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListpredefinedselectoptionsresponseV1', 'v1ListpredefinedselectoptionsresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/listpredefinedselectoptionsresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ListpredefinedselectoptionsresponseV1', 'v1ListpredefinedselectoptionsresponseV1'] +--- + +# ListpredefinedselectoptionsresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | **(optional)** **Array<string>** | Results holds a list of PreDefinedSelectOption items | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/Previewdatasourceresponse.md b/sdk-output/custom_forms/docs/Models/Previewdatasourceresponse.md new file mode 100644 index 00000000..c5f3e1a9 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/Previewdatasourceresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-previewdatasourceresponse-v1 +title: PreviewdatasourceresponseV1 +pagination_label: PreviewdatasourceresponseV1 +sidebar_label: PreviewdatasourceresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PreviewdatasourceresponseV1', 'v1PreviewdatasourceresponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/previewdatasourceresponse-v1 +tags: ['SDK', 'Software Development Kit', 'PreviewdatasourceresponseV1', 'v1PreviewdatasourceresponseV1'] +--- + +# PreviewdatasourceresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | **(optional)** **Array<FormelementdatasourceconfigoptionsV1>** | Results holds a list of FormElementDataSourceConfigOptions items | [default to undefined] + diff --git a/sdk-output/custom_forms/docs/Models/README.md b/sdk-output/custom_forms/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_forms/docs/Models/SearchFormDefinitionsByTenantV1400Response.md b/sdk-output/custom_forms/docs/Models/SearchFormDefinitionsByTenantV1400Response.md new file mode 100644 index 00000000..300fd4a4 --- /dev/null +++ b/sdk-output/custom_forms/docs/Models/SearchFormDefinitionsByTenantV1400Response.md @@ -0,0 +1,22 @@ +--- +id: v1-search-form-definitions-by-tenant-v1400-response-v1 +title: SearchFormDefinitionsByTenantV1400ResponseV1 +pagination_label: SearchFormDefinitionsByTenantV1400ResponseV1 +sidebar_label: SearchFormDefinitionsByTenantV1400ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchFormDefinitionsByTenantV1400ResponseV1', 'v1SearchFormDefinitionsByTenantV1400ResponseV1'] +slug: /tools/sdk/typescript/custom_forms/models/search-form-definitions-by-tenant-v1400-response-v1 +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenantV1400ResponseV1', 'v1SearchFormDefinitionsByTenantV1400ResponseV1'] +--- + +# SearchFormDefinitionsByTenantV1400ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | | [default to undefined] +**messages** | **(optional)** **Array<ErrormessageV1>** | | [default to undefined] +**statusCode** | **(optional)** **number** | | [default to undefined] +**trackingId** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/custom_password_instructions/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/custom_password_instructions/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..afb7f87b --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,50 @@ +- path: /custom-password-instructions/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_password_instructions/methods/custom-password-instructions#create-custom-password-instructions-v1 + source: | + import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomPasswordInstructionsV1Api(configuration); + const custompasswordinstructionV1: CustompasswordinstructionV1 = {"pageId":"reset-password:enter-password","pageContent":"See company password policies for details by clicking here"}; // CustompasswordinstructionV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createCustomPasswordInstructionsV1(custompasswordinstructionV1); + console.log(result); +- path: /custom-password-instructions/v1/{pageId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_password_instructions/methods/custom-password-instructions#delete-custom-password-instructions-v1 + source: | + import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomPasswordInstructionsV1Api(configuration); + const pageId: string = 'mfa:select'; // 'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish' | The page ID of custom password instructions to delete. (default to undefined) + const locale: string = 'locale_example'; // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteCustomPasswordInstructionsV1(pageId); + console.log(result); +- path: /custom-password-instructions/v1/{pageId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_password_instructions/methods/custom-password-instructions#get-custom-password-instructions-v1 + source: | + import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomPasswordInstructionsV1Api(configuration); + const pageId: string = 'mfa:select'; // 'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish' | The page ID of custom password instructions to query. (default to undefined) + const locale: string = 'locale_example'; // string | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getCustomPasswordInstructionsV1(pageId); + console.log(result); diff --git a/sdk-output/custom_password_instructions/docs/Methods/CustomPasswordInstructionsV1Api.md b/sdk-output/custom_password_instructions/docs/Methods/CustomPasswordInstructionsV1Api.md new file mode 100644 index 00000000..025cd5d6 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Methods/CustomPasswordInstructionsV1Api.md @@ -0,0 +1,166 @@ +--- +id: v1-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CustomPasswordInstructions', 'v1CustomPasswordInstructions'] +slug: /tools/sdk/typescript/custom_password_instructions/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'v1CustomPasswordInstructions'] +--- + +# CustomPasswordInstructionsV1Api + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/v2025/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/v2025/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-password-instructions-v1**](#create-custom-password-instructions-v1) | **POST** `/custom-password-instructions/v1` | Create custom password instructions +[**delete-custom-password-instructions-v1**](#delete-custom-password-instructions-v1) | **DELETE** `/custom-password-instructions/v1/{pageId}` | Delete custom password instructions by page id +[**get-custom-password-instructions-v1**](#get-custom-password-instructions-v1) | **GET** `/custom-password-instructions/v1/{pageId}` | Get custom password instructions by page id + + +## create-custom-password-instructions-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create custom password instructions +This API creates the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-custom-password-instructions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**custompasswordinstructionV1** | **CustompasswordinstructionV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**CustompasswordinstructionV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomPasswordInstructionsV1Api(configuration); +const custompasswordinstructionV1: CustompasswordinstructionV1 = {"pageId":"reset-password:enter-password","pageContent":"See company password policies for details by clicking here"}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createCustomPasswordInstructionsV1(custompasswordinstructionV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-custom-password-instructions-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete custom password instructions by page id +This API delete the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-custom-password-instructions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**pageId** | **'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'** | The page ID of custom password instructions to delete. | [default to undefined] +**locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomPasswordInstructionsV1Api(configuration); +const pageId: string = mfa:select; // The page ID of custom password instructions to delete. +const locale: string = locale_example; // The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteCustomPasswordInstructionsV1(pageId); +console.log(result); +``` + +[[Back to top]](#) + +## get-custom-password-instructions-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get custom password instructions by page id +This API returns the custom password instructions for the specified page ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-custom-password-instructions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**pageId** | **'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'** | The page ID of custom password instructions to query. | [default to undefined] +**locale** | **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**CustompasswordinstructionV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomPasswordInstructionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomPasswordInstructionsV1Api(configuration); +const pageId: string = mfa:select; // The page ID of custom password instructions to query. +const locale: string = locale_example; // The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getCustomPasswordInstructionsV1(pageId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/custom_password_instructions/docs/Methods/Index.md b/sdk-output/custom_password_instructions/docs/Methods/Index.md new file mode 100644 index 00000000..65c0b3f7 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: custom_password_instructions-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: custom_password_instructions-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_password_instructions', 'methods'] +slug: /tools/sdk/typescript/custom_password_instructions/methods +tags: ['SDK', 'Software Development Kit', 'custom_password_instructions', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/custom_password_instructions/docs/Models/Custompasswordinstruction.md b/sdk-output/custom_password_instructions/docs/Models/Custompasswordinstruction.md new file mode 100644 index 00000000..2ef0ebb1 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/Custompasswordinstruction.md @@ -0,0 +1,21 @@ +--- +id: v1-custompasswordinstruction-v1 +title: CustompasswordinstructionV1 +pagination_label: CustompasswordinstructionV1 +sidebar_label: CustompasswordinstructionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CustompasswordinstructionV1', 'v1CustompasswordinstructionV1'] +slug: /tools/sdk/typescript/custom_password_instructions/models/custompasswordinstruction-v1 +tags: ['SDK', 'Software Development Kit', 'CustompasswordinstructionV1', 'v1CustompasswordinstructionV1'] +--- + +# CustompasswordinstructionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pageId** | **(optional)** **string** | The page ID that represents the page for forget user name, reset password and unlock account flow. | [default to undefined] +**pageContent** | **(optional)** **string** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `link`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target. | [default to undefined] +**locale** | **(optional)** **string** | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". | [default to undefined] + diff --git a/sdk-output/custom_password_instructions/docs/Models/Errormessagedto.md b/sdk-output/custom_password_instructions/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..48b07232 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/custom_password_instructions/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/custom_password_instructions/docs/Models/Errorresponsedto.md b/sdk-output/custom_password_instructions/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..0d58ebbf --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/custom_password_instructions/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/custom_password_instructions/docs/Models/Index.md b/sdk-output/custom_password_instructions/docs/Models/Index.md new file mode 100644 index 00000000..69c8eb58 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: custom_password_instructions-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: custom_password_instructions-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_password_instructions', 'models'] +slug: /tools/sdk/typescript/custom_password_instructions/models +tags: ['SDK', 'Software Development Kit', 'custom_password_instructions', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/custom_password_instructions/docs/Models/Localeorigin.md b/sdk-output/custom_password_instructions/docs/Models/Localeorigin.md new file mode 100644 index 00000000..1f6d0deb --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/custom_password_instructions/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/custom_password_instructions/docs/Models/README.md b/sdk-output/custom_password_instructions/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_password_instructions/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_user_levels/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/custom_user_levels/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..80d57a7a --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,156 @@ +- path: /authorization/v1/custom-user-levels + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#create-custom-user-level-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const userlevelrequestV1: UserlevelrequestV1 = {"name":"Identity And Access Management","description":"This is a description of the custom user level.","owner":{"id":"29b9da8273b441239238bc041c386817","name":"John Doe"},"rightSets":["idn:ui-identity-manage-example","idn:ui-identity-manage-child-one-example"]}; // UserlevelrequestV1 | Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createCustomUserLevelV1(userlevelrequestV1); + console.log(result); +- path: /authorization/v1/custom-user-levels/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#delete-user-level-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const id: string = '6e110911-5984-491b-be74-2707980a46a7'; // string | The unique identifier of the user level. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteUserLevelV1(id); + console.log(result); +- path: /authorization/v1/custom-user-levels/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#get-user-level-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const id: string = '6e110911-5984-491b-be74-2707980a46a7'; // string | The unique identifier of the user level. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getUserLevelV1(id); + console.log(result); +- path: /authorization/v1/authorization-assignable-right-sets + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#list-all-authorization-right-sets-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const filters: string = 'category eq "identity"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **category**: *eq* (optional) (default to undefined) + const sorters: string = 'name, -id, -category'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, category** (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listAllAuthorizationRightSetsV1(); + console.log(result); +- path: /authorization/v1/user-levels/{id}/identities + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#list-user-level-identities-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const id: string = 'idn:access-request-administrator'; // string | The unique identifier of the user level. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const count: boolean = true; // boolean | If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. (optional) (default to false) + const sorters: string = 'displayName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listUserLevelIdentitiesV1(id); + console.log(result); +- path: /authorization/v1/custom-user-levels + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#list-user-levels-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const detailLevel: string = 'FULL'; // 'FULL' | 'SLIM' | Specifies the level of detail for the user levels. (optional) (default to 'basic') + const filters: string = 'name co "identity", owner co "john", status eq "active", description co "some description"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* (optional) (default to undefined) + const sorters: string = 'name, -created, description, status, owner'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner** (optional) (default to undefined) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listUserLevelsV1(); + console.log(result); +- path: /authorization/v1/custom-user-levels/{id}/publish + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#publish-custom-user-level-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const id: string = '6e110911-5984-491b-be74-2707980a46a7'; // string | The unique identifier of the user level to publish. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.publishCustomUserLevelV1(id); + console.log(result); +- path: /authorization/v1/user-levels/get-identity-count + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#show-user-level-counts-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const requestBody: Array<string> = ; // Array | List of user level ids. Max 50 identifiers can be passed in a single request. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.showUserLevelCountsV1(requestBody); + console.log(result); +- path: /authorization/v1/custom-user-levels/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/custom_user_levels/methods/custom-user-levels#update-user-level-v1 + source: | + import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new CustomUserLevelsV1Api(configuration); + const id: string = '6e110911-5984-491b-be74-2707980a46a7'; // string | The unique identifier of the user level. (default to undefined) + const jsonpatchV1: JsonpatchV1 = [{"op":"replace","path":"/rightSets","value":["idn:ui-identity-manage-example"]}]; // JsonpatchV1 | JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateUserLevelV1(id, jsonpatchV1); + console.log(result); diff --git a/sdk-output/custom_user_levels/docs/Methods/CustomUserLevelsV1Api.md b/sdk-output/custom_user_levels/docs/Methods/CustomUserLevelsV1Api.md new file mode 100644 index 00000000..c2c3041b --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Methods/CustomUserLevelsV1Api.md @@ -0,0 +1,445 @@ +--- +id: v1-custom-user-levels +title: CustomUserLevels +pagination_label: CustomUserLevels +sidebar_label: CustomUserLevels +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CustomUserLevels', 'v1CustomUserLevels'] +slug: /tools/sdk/typescript/custom_user_levels/methods/custom-user-levels +tags: ['SDK', 'Software Development Kit', 'CustomUserLevels', 'v1CustomUserLevels'] +--- + +# CustomUserLevelsV1Api + Use this API to implement custom user level functionality. +With this functionality in place, administrators can create custom user levels and configure them for use throughout Identity Security Cloud. + +Custom user levels allow administrators to create custom user levels that can be used to control access to Identity Security Cloud features and APIs. + +Refer to [User Levels](https://documentation.sailpoint.com/saas/help/common/users/index.html) for more information about User Levels. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-user-level-v1**](#create-custom-user-level-v1) | **POST** `/authorization/v1/custom-user-levels` | Create a custom user level +[**delete-user-level-v1**](#delete-user-level-v1) | **DELETE** `/authorization/v1/custom-user-levels/{id}` | Delete a user level +[**get-user-level-v1**](#get-user-level-v1) | **GET** `/authorization/v1/custom-user-levels/{id}` | Retrieve a user level +[**list-all-authorization-right-sets-v1**](#list-all-authorization-right-sets-v1) | **GET** `/authorization/v1/authorization-assignable-right-sets` | List all uiAssignable right sets +[**list-user-level-identities-v1**](#list-user-level-identities-v1) | **GET** `/authorization/v1/user-levels/{id}/identities` | List user level identities +[**list-user-levels-v1**](#list-user-levels-v1) | **GET** `/authorization/v1/custom-user-levels` | List user levels +[**publish-custom-user-level-v1**](#publish-custom-user-level-v1) | **POST** `/authorization/v1/custom-user-levels/{id}/publish` | Publish a custom user level +[**show-user-level-counts-v1**](#show-user-level-counts-v1) | **POST** `/authorization/v1/user-levels/get-identity-count` | Count user levels identities +[**update-user-level-v1**](#update-user-level-v1) | **PATCH** `/authorization/v1/custom-user-levels/{id}` | Update a user level + + +## create-custom-user-level-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create a custom user level +Creates a new custom user level for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-custom-user-level-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**userlevelrequestV1** | **UserlevelrequestV1** | Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**UserlevelsummarydtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const userlevelrequestV1: UserlevelrequestV1 = {"name":"Identity And Access Management","description":"This is a description of the custom user level.","owner":{"id":"29b9da8273b441239238bc041c386817","name":"John Doe"},"rightSets":["idn:ui-identity-manage-example","idn:ui-identity-manage-child-one-example"]}; // Payload containing the details of the user level to be created. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createCustomUserLevelV1(userlevelrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-user-level-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete a user level +Deletes a specific user level by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-user-level-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the user level. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const id: string = 6e110911-5984-491b-be74-2707980a46a7; // The unique identifier of the user level. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteUserLevelV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-user-level-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve a user level +Fetches the details of a specific user level by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-user-level-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the user level. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**UserlevelsummarydtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const id: string = 6e110911-5984-491b-be74-2707980a46a7; // The unique identifier of the user level. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getUserLevelV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-all-authorization-right-sets-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List all uiAssignable right sets +Retrieves a list of authorization assignable right sets for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-all-authorization-right-sets-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **category**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, category** | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const filters: string = category eq "identity"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **category**: *eq* (optional) +const sorters: string = name, -id, -category; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, category** (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listAllAuthorizationRightSetsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-user-level-identities-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List user level identities +List of identities associated with a user level. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-user-level-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the user level. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**count** | **boolean** | If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const id: string = idn:access-request-administrator; // The unique identifier of the user level. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const count: boolean = true; // If true, X-Total-Count header with the the total number of identities for this user level will be included in the response. (optional) +const sorters: string = displayName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listUserLevelIdentitiesV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-user-levels-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List user levels +Retrieves a list of user levels for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-user-levels-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**detailLevel** | **'FULL' | 'SLIM'** | Specifies the level of detail for the user levels. | [optional] [default to 'basic'] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner** | [optional] [default to undefined] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const detailLevel: string = FULL; // Specifies the level of detail for the user levels. (optional) +const filters: string = name co "identity", owner co "john", status eq "active", description co "some description"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *co* **owner**: *co* **status**: *eq* **description**: *co* (optional) +const sorters: string = name, -created, description, status, owner; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, description, status, owner** (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listUserLevelsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## publish-custom-user-level-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Publish a custom user level +Publishes a custom user level for the tenant, making it active and available. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/publish-custom-user-level-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the user level to publish. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**UserlevelpublishsummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const id: string = 6e110911-5984-491b-be74-2707980a46a7; // The unique identifier of the user level to publish. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.publishCustomUserLevelV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## show-user-level-counts-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Count user levels identities +List of user levels along with the number of identities associated to it. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/show-user-level-counts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestBody** | **Array<string>** | List of user level ids. Max 50 identifiers can be passed in a single request. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const requestBody: Array<string> = ; // List of user level ids. Max 50 identifiers can be passed in a single request. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.showUserLevelCountsV1(requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## update-user-level-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update a user level +Updates the details of a specific user level using JSON Patch. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-user-level-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the user level. | [default to undefined] +**jsonpatchV1** | **JsonpatchV1** | JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**UserlevelsummarydtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { CustomUserLevelsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new CustomUserLevelsV1Api(configuration); +const id: string = 6e110911-5984-491b-be74-2707980a46a7; // The unique identifier of the user level. +const jsonpatchV1: JsonpatchV1 = [{"op":"replace","path":"/rightSets","value":["idn:ui-identity-manage-example"]}]; // JSON Patch payload for updating the user level. - If only a parent right set id is included in the request body, all child right sets associated with that parent will be automatically assigned. - If the request body includes both a parent right set and a subset of its children, only the explicitly listed right sets (parent and specified children) will be assigned. Implicit inheritance is not applied in this case. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateUserLevelV1(id, jsonpatchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/custom_user_levels/docs/Methods/Index.md b/sdk-output/custom_user_levels/docs/Methods/Index.md new file mode 100644 index 00000000..1c937d46 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: custom_user_levels-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: custom_user_levels-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_user_levels', 'methods'] +slug: /tools/sdk/typescript/custom_user_levels/methods +tags: ['SDK', 'Software Development Kit', 'custom_user_levels', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/custom_user_levels/docs/Models/ArrayInner.md b/sdk-output/custom_user_levels/docs/Models/ArrayInner.md new file mode 100644 index 00000000..32672aa3 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/custom_user_levels/docs/Models/Authuserlevelsidentitycount.md b/sdk-output/custom_user_levels/docs/Models/Authuserlevelsidentitycount.md new file mode 100644 index 00000000..c2f861c8 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Authuserlevelsidentitycount.md @@ -0,0 +1,20 @@ +--- +id: v1-authuserlevelsidentitycount-v1 +title: AuthuserlevelsidentitycountV1 +pagination_label: AuthuserlevelsidentitycountV1 +sidebar_label: AuthuserlevelsidentitycountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthuserlevelsidentitycountV1', 'v1AuthuserlevelsidentitycountV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/authuserlevelsidentitycount-v1 +tags: ['SDK', 'Software Development Kit', 'AuthuserlevelsidentitycountV1', 'v1AuthuserlevelsidentitycountV1'] +--- + +# AuthuserlevelsidentitycountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the user level. | [default to undefined] +**count** | **(optional)** **number** | Number of identities having this user level. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Authuserslimresponse.md b/sdk-output/custom_user_levels/docs/Models/Authuserslimresponse.md new file mode 100644 index 00000000..9f82301c --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Authuserslimresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-authuserslimresponse-v1 +title: AuthuserslimresponseV1 +pagination_label: AuthuserslimresponseV1 +sidebar_label: AuthuserslimresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthuserslimresponseV1', 'v1AuthuserslimresponseV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/authuserslimresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AuthuserslimresponseV1', 'v1AuthuserslimresponseV1'] +--- + +# AuthuserslimresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**uid** | **(optional)** **string** | Identity unique identifier. | [default to undefined] +**alias** | **(optional)** **string** | Identity alias. | [default to undefined] +**displayName** | **(optional)** **string** | Identity name in display format. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Dtotype.md b/sdk-output/custom_user_levels/docs/Models/Dtotype.md new file mode 100644 index 00000000..330b491f --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/custom_user_levels/docs/Models/Errormessagedto.md b/sdk-output/custom_user_levels/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..95ce439a --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Errorresponsedto.md b/sdk-output/custom_user_levels/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fee3276c --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Hierarchicalrightset.md b/sdk-output/custom_user_levels/docs/Models/Hierarchicalrightset.md new file mode 100644 index 00000000..1c173155 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Hierarchicalrightset.md @@ -0,0 +1,24 @@ +--- +id: v1-hierarchicalrightset-v1 +title: HierarchicalrightsetV1 +pagination_label: HierarchicalrightsetV1 +sidebar_label: HierarchicalrightsetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HierarchicalrightsetV1', 'v1HierarchicalrightsetV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/hierarchicalrightset-v1 +tags: ['SDK', 'Software Development Kit', 'HierarchicalrightsetV1', 'v1HierarchicalrightsetV1'] +--- + +# HierarchicalrightsetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the RightSet. | [default to undefined] +**name** | **(optional)** **string** | The human-readable name of the RightSet. | [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the RightSet. | [default to undefined] +**category** | **(optional)** **string** | The category of the RightSet. | [default to undefined] +**nestedConfig** | **(optional)** **NestedconfigV1** | | [default to undefined] +**children** | **(optional)** **Array<HierarchicalrightsetV1>** | List of child HierarchicalRightSets. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Identityreference.md b/sdk-output/custom_user_levels/docs/Models/Identityreference.md new file mode 100644 index 00000000..ba97e8da --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Identityreference.md @@ -0,0 +1,21 @@ +--- +id: v1-identityreference-v1 +title: IdentityreferenceV1 +pagination_label: IdentityreferenceV1 +sidebar_label: IdentityreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/identityreference-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +--- + +# IdentityreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Index.md b/sdk-output/custom_user_levels/docs/Models/Index.md new file mode 100644 index 00000000..83aba748 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: custom_user_levels-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: custom_user_levels-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'custom_user_levels', 'models'] +slug: /tools/sdk/typescript/custom_user_levels/models +tags: ['SDK', 'Software Development Kit', 'custom_user_levels', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/custom_user_levels/docs/Models/Jsonpatch.md b/sdk-output/custom_user_levels/docs/Models/Jsonpatch.md new file mode 100644 index 00000000..a5bc2456 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Jsonpatch.md @@ -0,0 +1,19 @@ +--- +id: v1-jsonpatch-v1 +title: JsonpatchV1 +pagination_label: JsonpatchV1 +sidebar_label: JsonpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchV1', 'v1JsonpatchV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/jsonpatch-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchV1', 'v1JsonpatchV1'] +--- + +# JsonpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | **(optional)** **Array<JsonpatchoperationV1>** | Operations to be applied | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Jsonpatchoperation.md b/sdk-output/custom_user_levels/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..a06e0959 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/JsonpatchoperationValue.md b/sdk-output/custom_user_levels/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..92b7fc56 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1401Response.md b/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1401Response.md new file mode 100644 index 00000000..b08cdd24 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-user-levels-v1401-response-v1 +title: ListUserLevelsV1401ResponseV1 +pagination_label: ListUserLevelsV1401ResponseV1 +sidebar_label: ListUserLevelsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListUserLevelsV1401ResponseV1', 'v1ListUserLevelsV1401ResponseV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/list-user-levels-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListUserLevelsV1401ResponseV1', 'v1ListUserLevelsV1401ResponseV1'] +--- + +# ListUserLevelsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1429Response.md b/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1429Response.md new file mode 100644 index 00000000..fcbc1cc0 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/ListUserLevelsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-user-levels-v1429-response-v1 +title: ListUserLevelsV1429ResponseV1 +pagination_label: ListUserLevelsV1429ResponseV1 +sidebar_label: ListUserLevelsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListUserLevelsV1429ResponseV1', 'v1ListUserLevelsV1429ResponseV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/list-user-levels-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListUserLevelsV1429ResponseV1', 'v1ListUserLevelsV1429ResponseV1'] +--- + +# ListUserLevelsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Localeorigin.md b/sdk-output/custom_user_levels/docs/Models/Localeorigin.md new file mode 100644 index 00000000..abb6326f --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/custom_user_levels/docs/Models/Nestedconfig.md b/sdk-output/custom_user_levels/docs/Models/Nestedconfig.md new file mode 100644 index 00000000..80d16f26 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Nestedconfig.md @@ -0,0 +1,22 @@ +--- +id: v1-nestedconfig-v1 +title: NestedconfigV1 +pagination_label: NestedconfigV1 +sidebar_label: NestedconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NestedconfigV1', 'v1NestedconfigV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/nestedconfig-v1 +tags: ['SDK', 'Software Development Kit', 'NestedconfigV1', 'v1NestedconfigV1'] +--- + +# NestedconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ancestorId** | **(optional)** **string** | The unique identifier of the ancestor RightSet. | [default to undefined] +**depth** | **(optional)** **number** | The depth level of the configuration. | [default to undefined] +**parentId** | **(optional)** **string** | The unique identifier of the parent RightSet. | [default to undefined] +**childrenIds** | **(optional)** **Array<string>** | List of unique identifiers for child configurations. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Publicidentity.md b/sdk-output/custom_user_levels/docs/Models/Publicidentity.md new file mode 100644 index 00000000..4211dbee --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Publicidentity.md @@ -0,0 +1,26 @@ +--- +id: v1-publicidentity-v1 +title: PublicidentityV1 +pagination_label: PublicidentityV1 +sidebar_label: PublicidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityV1', 'v1PublicidentityV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/publicidentity-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityV1', 'v1PublicidentityV1'] +--- + +# PublicidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] +**alias** | **(optional)** **string** | Alternate unique identifier for the identity. | [default to undefined] +**email** | **(optional)** **string** | Email address of identity. | [default to undefined] +**status** | **(optional)** **string** | The lifecycle status for the identity | [default to undefined] +**identityState** | **(optional)** **string** | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [default to undefined] +**manager** | **(optional)** **IdentityreferenceV1** | | [default to undefined] +**attributes** | **(optional)** **Array<PublicidentityAttributesInnerV1>** | The public identity attributes of the identity | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/PublicidentityAttributesInner.md b/sdk-output/custom_user_levels/docs/Models/PublicidentityAttributesInner.md new file mode 100644 index 00000000..dd2e43b6 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/PublicidentityAttributesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-publicidentity-attributes-inner-v1 +title: PublicidentityAttributesInnerV1 +pagination_label: PublicidentityAttributesInnerV1 +sidebar_label: PublicidentityAttributesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityAttributesInnerV1', 'v1PublicidentityAttributesInnerV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/publicidentity-attributes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityAttributesInnerV1', 'v1PublicidentityAttributesInnerV1'] +--- + +# PublicidentityAttributesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The attribute key | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the attribute | [default to undefined] +**value** | **(optional)** **string** | The attribute value | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/README.md b/sdk-output/custom_user_levels/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/custom_user_levels/docs/Models/Rightsetdto.md b/sdk-output/custom_user_levels/docs/Models/Rightsetdto.md new file mode 100644 index 00000000..8c5258ec --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Rightsetdto.md @@ -0,0 +1,29 @@ +--- +id: v1-rightsetdto-v1 +title: RightsetdtoV1 +pagination_label: RightsetdtoV1 +sidebar_label: RightsetdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RightsetdtoV1', 'v1RightsetdtoV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/rightsetdto-v1 +tags: ['SDK', 'Software Development Kit', 'RightsetdtoV1', 'v1RightsetdtoV1'] +--- + +# RightsetdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the RightSet. | [default to undefined] +**name** | **(optional)** **string** | The human-readable name of the RightSet. | [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the RightSet. | [default to undefined] +**category** | **(optional)** **string** | The category of the RightSet. | [default to undefined] +**rights** | **(optional)** **Array<string>** | Right is the most granular unit that determines specific API permissions, this is a list of rights associated with the RightSet. | [default to undefined] +**rightSetIds** | **(optional)** **Array<string>** | List of unique identifiers for related RightSets, current RightSet contains rights from these RightSets. | [default to undefined] +**uiAssignableChildRightSetIds** | **(optional)** **Array<string>** | List of unique identifiers for UI-assignable child RightSets, used to build UI components. | [default to undefined] +**uiAssignable** | **(optional)** **boolean** | Indicates whether the RightSet is UI-assignable. | [default to false] +**translatedName** | **(optional)** **string** | The translated name of the RightSet. | [default to undefined] +**translatedDescription** | **(optional)** **string** | The translated description of the RightSet. | [default to undefined] +**parentId** | **(optional)** **string** | The unique identifier of the parent RightSet for UI Assignable RightSet. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Userlevelpublishsummary.md b/sdk-output/custom_user_levels/docs/Models/Userlevelpublishsummary.md new file mode 100644 index 00000000..7097f217 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Userlevelpublishsummary.md @@ -0,0 +1,22 @@ +--- +id: v1-userlevelpublishsummary-v1 +title: UserlevelpublishsummaryV1 +pagination_label: UserlevelpublishsummaryV1 +sidebar_label: UserlevelpublishsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserlevelpublishsummaryV1', 'v1UserlevelpublishsummaryV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/userlevelpublishsummary-v1 +tags: ['SDK', 'Software Development Kit', 'UserlevelpublishsummaryV1', 'v1UserlevelpublishsummaryV1'] +--- + +# UserlevelpublishsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userLevelId** | **(optional)** **string** | The unique identifier of the UserLevel. | [default to undefined] +**publish** | **(optional)** **boolean** | Indicates whether the API call triggered a publish operation. | [default to false] +**status** | **(optional)** **string** | The status of the UserLevel publish operation. | [default to undefined] +**modified** | **(optional)** **string** | The last modification timestamp of the UserLevel. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Userlevelrequest.md b/sdk-output/custom_user_levels/docs/Models/Userlevelrequest.md new file mode 100644 index 00000000..be52a54b --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Userlevelrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-userlevelrequest-v1 +title: UserlevelrequestV1 +pagination_label: UserlevelrequestV1 +sidebar_label: UserlevelrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserlevelrequestV1', 'v1UserlevelrequestV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/userlevelrequest-v1 +tags: ['SDK', 'Software Development Kit', 'UserlevelrequestV1', 'v1UserlevelrequestV1'] +--- + +# UserlevelrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the user level. | [default to undefined] +**description** | **string** | A brief description of the user level. | [default to undefined] +**owner** | **PublicidentityV1** | | [default to undefined] +**rightSets** | **(optional)** **Array<string>** | A list of rights associated with the user level. | [default to undefined] + diff --git a/sdk-output/custom_user_levels/docs/Models/Userlevelsummarydto.md b/sdk-output/custom_user_levels/docs/Models/Userlevelsummarydto.md new file mode 100644 index 00000000..5a4abcf6 --- /dev/null +++ b/sdk-output/custom_user_levels/docs/Models/Userlevelsummarydto.md @@ -0,0 +1,33 @@ +--- +id: v1-userlevelsummarydto-v1 +title: UserlevelsummarydtoV1 +pagination_label: UserlevelsummarydtoV1 +sidebar_label: UserlevelsummarydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UserlevelsummarydtoV1', 'v1UserlevelsummarydtoV1'] +slug: /tools/sdk/typescript/custom_user_levels/models/userlevelsummarydto-v1 +tags: ['SDK', 'Software Development Kit', 'UserlevelsummarydtoV1', 'v1UserlevelsummarydtoV1'] +--- + +# UserlevelsummarydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the UserLevel. | [default to undefined] +**name** | **(optional)** **string** | The human-readable name of the UserLevel. | [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the UserLevel. | [default to undefined] +**legacyGroup** | **(optional)** **string** | The legacy group associated with the UserLevel, used for backward compatibility for the UserLevel id. | [default to undefined] +**rightSets** | **(optional)** **Array<RightsetdtoV1>** | List of RightSets associated with the UserLevel. | [default to undefined] +**custom** | **(optional)** **boolean** | Indicates whether the UserLevel is custom. | [default to true] +**adminAssignable** | **(optional)** **boolean** | Indicates whether the UserLevel is admin-assignable. | [default to true] +**translatedName** | **(optional)** **string** | The translated name of the UserLevel. | [default to undefined] +**translatedGrant** | **(optional)** **string** | The translated grant message for the UserLevel. | [default to undefined] +**translatedRemove** | **(optional)** **string** | The translated remove message for the UserLevel. | [default to undefined] +**owner** | **(optional)** **PublicidentityV1** | | [default to undefined] +**status** | **(optional)** **string** | The status of the UserLevel. | [default to undefined] +**created** | **(optional)** **string** | The creation timestamp of the UserLevel. | [default to undefined] +**modified** | **(optional)** **string** | The last modification timestamp of the UserLevel. | [default to undefined] +**associatedIdentitiesCount** | **(optional)** **number** | The count of associated identities for the UserLevel. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/data_access_security/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..98bde602 --- /dev/null +++ b/sdk-output/data_access_security/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,397 @@ +- path: /das/v1/tasks/cancel/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#cancel-task-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the task to cancel. (default to undefined) + const result = await apiInstance.cancelTaskV1(id); + console.log(result); +- path: /das/v1/applications + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#create-application-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const basecreateapplicationrequestV1: BasecreateapplicationrequestV1 = ; // BasecreateapplicationrequestV1 | Request body containing the details required to create a new application. + const result = await apiInstance.createApplicationV1(basecreateapplicationrequestV1); + console.log(result); +- path: /das/identity-collectors/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#create-identity-collector-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const createidentitycollectorrequestV1: CreateidentitycollectorrequestV1 = ; // CreateidentitycollectorrequestV1 | Request body containing the details required to create a new identity collector. + const result = await apiInstance.createIdentityCollectorV1(createidentitycollectorrequestV1); + console.log(result); +- path: /das/v1/tasks/schedules + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#create-schedule-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const createschedulerequestV1: CreateschedulerequestV1 = ; // CreateschedulerequestV1 | + const result = await apiInstance.createScheduleV1(createschedulerequestV1); + console.log(result); +- path: /das/v1/owners/assign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#das-v1-owners-assign-post + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const assignresourceownerrequestV1: AssignresourceownerrequestV1 = ; // AssignresourceownerrequestV1 | The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. + const result = await apiInstance.dasV1OwnersAssignPost(assignresourceownerrequestV1); + console.log(result); +- path: /das/v1/owners/{ownerIdentityId}/resources + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#das-v1-owners-owner-identity-id-resources-get + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const ownerIdentityId: string = 'a3f1c2d4-5678-4e9b-8c2d-123456789abc'; // string | Unique identifier for the owner. This should be a UUID representing the owner\'s identity. (default to undefined) + const limit: number = 250; // number | Not applicable for this endpoint. Do not use. (optional) (default to 250) + const offset: number = 0; // number | Not applicable for this endpoint. Do not use. (optional) (default to 0) + const result = await apiInstance.dasV1OwnersOwnerIdentityIdResourcesGet(ownerIdentityId); + console.log(result); +- path: /das/v1/owners/reelect + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#das-v1-owners-reelect-post + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const reelectrequestV1: ReelectrequestV1 = ; // ReelectrequestV1 | The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. + const result = await apiInstance.dasV1OwnersReelectPost(reelectrequestV1); + console.log(result); +- path: /das/v1/owners/resources/{resourceId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#das-v1-owners-resources-resource-id-get + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const resourceId: number = 101; // number | Unique identifier for the resource. (default to undefined) + const limit: number = 250; // number | Not applicable for this endpoint. Do not use. (optional) (default to 250) + const offset: number = 0; // number | Not applicable for this endpoint. Do not use. (optional) (default to 0) + const result = await apiInstance.dasV1OwnersResourcesResourceIdGet(resourceId); + console.log(result); +- path: /das/v1/owners/{sourceIdentityId}/reassign/{destinationIdentityId} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#das-v1-owners-source-identity-id-reassign-destination-identity-id-post + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const sourceIdentityId: string = 'a3f1c2d4-5678-4e9b-8c2d-123456789abc'; // string | Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. (default to undefined) + const destinationIdentityId: string = 'b4e2d3c5-6789-4f0a-9d3e-234567890bcd'; // string | Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. (default to undefined) + const result = await apiInstance.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId, destinationIdentityId); + console.log(result); +- path: /das/v1/applications/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#delete-application-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 12345; // number | The unique identifier of the application to delete. (default to undefined) + const result = await apiInstance.deleteApplicationV1(id); + console.log(result); +- path: /das/identity-collectors/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#delete-identity-collector-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 12345; // number | The unique identifier of the identity collector to delete. (default to undefined) + const result = await apiInstance.deleteIdentityCollectorV1(id); + console.log(result); +- path: /das/v1/tasks/schedules/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#delete-schedule-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the schedule to delete. (default to undefined) + const result = await apiInstance.deleteScheduleV1(id); + console.log(result); +- path: /das/v1/tasks/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#delete-task-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the task to delete. (default to undefined) + const result = await apiInstance.deleteTaskV1(id); + console.log(result); +- path: /das/v1/applications/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-application-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 12345; // number | The unique identifier of the application to retrieve. (default to undefined) + const result = await apiInstance.getApplicationV1(id); + console.log(result); +- path: /das/v1/applications + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-applications-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const filters: string = 'AppType eq 'ActiveDirectory' and Statuses eq 'Passed''; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getApplicationsV1(); + console.log(result); +- path: /das/v1/owners/applications/{appId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-owners-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const appId: number = 2001; // number | The unique identifier of the application for which to retrieve owners. (default to undefined) + const limit: number = 250; // number | Not applicable for this endpoint. Do not use. (optional) (default to 250) + const offset: number = 0; // number | Not applicable for this endpoint. Do not use. (optional) (default to 0) + const result = await apiInstance.getOwnersV1(appId); + console.log(result); +- path: /das/v1/tasks/schedules/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-schedule-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the schedule to retrieve. (default to undefined) + const result = await apiInstance.getScheduleV1(id); + console.log(result); +- path: /das/v1/tasks/schedules + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-schedules-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const filters: string = 'ScheduleType eq "Daily" and startTime eq 1762237200'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getSchedulesV1(); + console.log(result); +- path: /das/v1/tasks/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-task-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the task to retrieve. (default to undefined) + const result = await apiInstance.getTaskV1(id); + console.log(result); +- path: /das/v1/tasks + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#get-tasks-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const filters: string = 'TaskTypeName eq "DataClassification and EndBeforeTime eq 1762240800'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getTasksV1(); + console.log(result); +- path: /das/identity-collectors/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#list-identity-collectors-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const filters: string = 'sourceId eq "2c9180835d2e5168015d32f890ca1581"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listIdentityCollectorsV1(); + console.log(result); +- path: /das/v1/applications/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#put-application-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 12345; // number | The unique identifier of the application to update. (default to undefined) + const basecreateapplicationrequestV1: BasecreateapplicationrequestV1 = ; // BasecreateapplicationrequestV1 | Request body containing the updated details for the application. + const result = await apiInstance.putApplicationV1(id, basecreateapplicationrequestV1); + console.log(result); +- path: /das/identity-collectors/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#put-identity-collector-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 12345; // number | The unique identifier of the identity collector to update. (default to undefined) + const updateidentitycollectorrequestV1: UpdateidentitycollectorrequestV1 = ; // UpdateidentitycollectorrequestV1 | Request body containing the updated details for the identity collector. + const result = await apiInstance.putIdentityCollectorV1(id, updateidentitycollectorrequestV1); + console.log(result); +- path: /das/v1/tasks/schedules/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#put-schedule-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the schedule to update. (default to undefined) + const updateschedulerequestV1: UpdateschedulerequestV1 = ; // UpdateschedulerequestV1 | + const result = await apiInstance.putScheduleV1(id, updateschedulerequestV1); + console.log(result); +- path: /das/v1/tasks/rerun/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_access_security/methods/data-access-security#start-task-rerun-v1 + source: | + import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataAccessSecurityV1Api(configuration); + const id: number = 1001; // number | The unique identifier of the task to rerun. (default to undefined) + const result = await apiInstance.startTaskRerunV1(id); + console.log(result); diff --git a/sdk-output/data_access_security/docs/Methods/DataAccessSecurityV1Api.md b/sdk-output/data_access_security/docs/Methods/DataAccessSecurityV1Api.md new file mode 100644 index 00000000..757be365 --- /dev/null +++ b/sdk-output/data_access_security/docs/Methods/DataAccessSecurityV1Api.md @@ -0,0 +1,1043 @@ +--- +id: v1-data-access-security +title: DataAccessSecurity +pagination_label: DataAccessSecurity +sidebar_label: DataAccessSecurity +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataAccessSecurity', 'v1DataAccessSecurity'] +slug: /tools/sdk/typescript/data_access_security/methods/data-access-security +tags: ['SDK', 'Software Development Kit', 'DataAccessSecurity', 'v1DataAccessSecurity'] +--- + +# DataAccessSecurityV1Api + Use this API to enable data ownership election campaigns, assign resource owners, and respond to identity lifecycle events to maintain continuous accountability. +This API can also trigger and manage DAS tasks such as scans-starting them on demand, updating configurations or schedules, and retrieving statuses. Additionally, you can onboard and manage applications at scale by creating and configuring them, setting scanning schedules, retrieving metadata, and associating them with Virtual Appliances and Identity Collectors. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-task-v1**](#cancel-task-v1) | **POST** `/das/v1/tasks/cancel/{id}` | Cancel a DAS task. +[**create-application-v1**](#create-application-v1) | **POST** `/das/v1/applications` | Create application +[**create-identity-collector-v1**](#create-identity-collector-v1) | **POST** `/das/identity-collectors/v1` | Create identity collector +[**create-schedule-v1**](#create-schedule-v1) | **POST** `/das/v1/tasks/schedules` | Create a new schedule. +[**das-v1-owners-assign-post**](#das-v1-owners-assign-post) | **POST** `/das/v1/owners/assign` | Assign owner to application resource. +[**das-v1-owners-owner-identity-id-resources-get**](#das-v1-owners-owner-identity-id-resources-get) | **GET** `/das/v1/owners/{ownerIdentityId}/resources` | List resources for owner. +[**das-v1-owners-reelect-post**](#das-v1-owners-reelect-post) | **POST** `/das/v1/owners/reelect` | Re-elect resource owner. +[**das-v1-owners-resources-resource-id-get**](#das-v1-owners-resources-resource-id-get) | **GET** `/das/v1/owners/resources/{resourceId}` | List owners for resource. +[**das-v1-owners-source-identity-id-reassign-destination-identity-id-post**](#das-v1-owners-source-identity-id-reassign-destination-identity-id-post) | **POST** `/das/v1/owners/{sourceIdentityId}/reassign/{destinationIdentityId}` | Reassign resource owner. +[**delete-application-v1**](#delete-application-v1) | **DELETE** `/das/v1/applications/{id}` | Delete an application by identifier. +[**delete-identity-collector-v1**](#delete-identity-collector-v1) | **DELETE** `/das/identity-collectors/v1/{id}` | Delete identity collector by identifier +[**delete-schedule-v1**](#delete-schedule-v1) | **DELETE** `/das/v1/tasks/schedules/{id}` | Delete a DAS schedule. +[**delete-task-v1**](#delete-task-v1) | **DELETE** `/das/v1/tasks/{id}` | Delete a DAS task. +[**get-application-v1**](#get-application-v1) | **GET** `/das/v1/applications/{id}` | Retrieve application details by identifier. +[**get-applications-v1**](#get-applications-v1) | **GET** `/das/v1/applications` | Search applications in DAS. +[**get-owners-v1**](#get-owners-v1) | **GET** `/das/v1/owners/applications/{appId}` | Retrieve owners per application. +[**get-schedule-v1**](#get-schedule-v1) | **GET** `/das/v1/tasks/schedules/{id}` | Get a DAS schedule. +[**get-schedules-v1**](#get-schedules-v1) | **GET** `/das/v1/tasks/schedules` | List all schedules. +[**get-task-v1**](#get-task-v1) | **GET** `/das/v1/tasks/{id}` | Get a DAS task. +[**get-tasks-v1**](#get-tasks-v1) | **GET** `/das/v1/tasks` | Lists all DAS tasks. +[**list-identity-collectors-v1**](#list-identity-collectors-v1) | **GET** `/das/identity-collectors/v1` | List identity collectors +[**put-application-v1**](#put-application-v1) | **PUT** `/das/v1/applications/{id}` | Update application by identifier. +[**put-identity-collector-v1**](#put-identity-collector-v1) | **PUT** `/das/identity-collectors/v1/{id}` | Update identity collector by identifier +[**put-schedule-v1**](#put-schedule-v1) | **PUT** `/das/v1/tasks/schedules/{id}` | Update a schedule. +[**start-task-rerun-v1**](#start-task-rerun-v1) | **POST** `/das/v1/tasks/rerun/{id}` | Rerun a DAS task. + + +## cancel-task-v1 +Cancel a DAS task. +This end-point sends a request to cancel a task in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-task-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the task to cancel. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the task to cancel. +const result = await apiInstance.cancelTaskV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## create-application-v1 +Create application +This endpoint creates a new application in Data Access Security with the specified configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-application-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**basecreateapplicationrequestV1** | **BasecreateapplicationrequestV1** | Request body containing the details required to create a new application. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const basecreateapplicationrequestV1: BasecreateapplicationrequestV1 = ; // Request body containing the details required to create a new application. +const result = await apiInstance.createApplicationV1(basecreateapplicationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-identity-collector-v1 +Create identity collector +This endpoint creates a new identity collector in Data Access Security for the specified source. The identity collector type is derived from the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-identity-collector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createidentitycollectorrequestV1** | **CreateidentitycollectorrequestV1** | Request body containing the details required to create a new identity collector. | + +### Return type + +**CreateIdentityCollectorV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const createidentitycollectorrequestV1: CreateidentitycollectorrequestV1 = ; // Request body containing the details required to create a new identity collector. +const result = await apiInstance.createIdentityCollectorV1(createidentitycollectorrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-schedule-v1 +Create a new schedule. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createschedulerequestV1** | **CreateschedulerequestV1** | | + +### Return type + +**number** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const createschedulerequestV1: CreateschedulerequestV1 = ; // +const result = await apiInstance.createScheduleV1(createschedulerequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## das-v1-owners-assign-post +Assign owner to application resource. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/das-v1-owners-assign-post) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**assignresourceownerrequestV1** | **AssignresourceownerrequestV1** | The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. | + +### Return type + +**number** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const assignresourceownerrequestV1: AssignresourceownerrequestV1 = ; // The request body must contain the application ID, resource path, and identity ID to be assigned as the resource owner. +const result = await apiInstance.dasV1OwnersAssignPost(assignresourceownerrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## das-v1-owners-owner-identity-id-resources-get +List resources for owner. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/das-v1-owners-owner-identity-id-resources-get) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerIdentityId** | **string** | Unique identifier for the owner. This should be a UUID representing the owner\'s identity. | [default to undefined] +**limit** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 250] +**offset** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const ownerIdentityId: string = a3f1c2d4-5678-4e9b-8c2d-123456789abc; // Unique identifier for the owner. This should be a UUID representing the owner\'s identity. +const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional) +const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional) +const result = await apiInstance.dasV1OwnersOwnerIdentityIdResourcesGet(ownerIdentityId); +console.log(result); +``` + +[[Back to top]](#) + +## das-v1-owners-reelect-post +Re-elect resource owner. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/das-v1-owners-reelect-post) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reelectrequestV1** | **ReelectrequestV1** | The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. | + +### Return type + +**number** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const reelectrequestV1: ReelectrequestV1 = ; // The request body must contain details for re-electing a resource owner. Date/time fields should use epoch format in seconds. +const result = await apiInstance.dasV1OwnersReelectPost(reelectrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## das-v1-owners-resources-resource-id-get +List owners for resource. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/das-v1-owners-resources-resource-id-get) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**resourceId** | **number** | Unique identifier for the resource. | [default to undefined] +**limit** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 250] +**offset** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const resourceId: number = 101; // Unique identifier for the resource. +const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional) +const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional) +const result = await apiInstance.dasV1OwnersResourcesResourceIdGet(resourceId); +console.log(result); +``` + +[[Back to top]](#) + +## das-v1-owners-source-identity-id-reassign-destination-identity-id-post +Reassign resource owner. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/das-v1-owners-source-identity-id-reassign-destination-identity-id-post) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceIdentityId** | **string** | Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. | [default to undefined] +**destinationIdentityId** | **string** | Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. | [default to undefined] + +### Return type + +**number** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const sourceIdentityId: string = a3f1c2d4-5678-4e9b-8c2d-123456789abc; // Unique identifier for the source owner. This should be a UUID representing the identity to reassign from. +const destinationIdentityId: string = b4e2d3c5-6789-4f0a-9d3e-234567890bcd; // Unique identifier for the destination owner. This should be a UUID representing the identity to reassign to. +const result = await apiInstance.dasV1OwnersSourceIdentityIdReassignDestinationIdentityIdPost(sourceIdentityId, destinationIdentityId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-application-v1 +Delete an application by identifier. +This endpoint deletes an application from Data Access Security by its unique identifier. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-application-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the application to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 12345; // The unique identifier of the application to delete. +const result = await apiInstance.deleteApplicationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-identity-collector-v1 +Delete identity collector by identifier +This endpoint deletes an identity collector from Data Access Security by its unique identifier. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-collector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the identity collector to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 12345; // The unique identifier of the identity collector to delete. +const result = await apiInstance.deleteIdentityCollectorV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-schedule-v1 +Delete a DAS schedule. +This end-point sends a request to delete a schedule in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the schedule to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the schedule to delete. +const result = await apiInstance.deleteScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-task-v1 +Delete a DAS task. +This end-point sends a request to delete a task in Data Access Security. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-task-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the task to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the task to delete. +const result = await apiInstance.deleteTaskV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-application-v1 +Retrieve application details by identifier. +This endpoint retrieves the details of a specific application in Data Access Security by its unique identifier. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-application-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the application to retrieve. | [default to undefined] + +### Return type + +**ApplicationitemV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 12345; // The unique identifier of the application to retrieve. +const result = await apiInstance.getApplicationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-applications-v1 +Search applications in DAS. +This endpoint lists all the applications in Data Access Security with optional filtering. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-applications-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const filters: string = AppType eq 'ActiveDirectory' and Statuses eq 'Passed'; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **appIds**: *eq, in* **tagIds**: *eq, in* **statuses**: *eq, in* **groupCodes**: *eq, in* **virtualAppId**: *eq* **appName**: *eq* **supportsValidation**: *eq* Supported composite operators are *and, or* (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getApplicationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-owners-v1 +Retrieve owners per application. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-owners-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**appId** | **number** | The unique identifier of the application for which to retrieve owners. | [default to undefined] +**limit** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 250] +**offset** | **number** | Not applicable for this endpoint. Do not use. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const appId: number = 2001; // The unique identifier of the application for which to retrieve owners. +const limit: number = 250; // Not applicable for this endpoint. Do not use. (optional) +const offset: number = 0; // Not applicable for this endpoint. Do not use. (optional) +const result = await apiInstance.getOwnersV1(appId); +console.log(result); +``` + +[[Back to top]](#) + +## get-schedule-v1 +Get a DAS schedule. +This end-point gets a schedule in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the schedule to retrieve. | [default to undefined] + +### Return type + +**ScheduleinfoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the schedule to retrieve. +const result = await apiInstance.getScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-schedules-v1 +List all schedules. +This end-point lists all the schedules in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-schedules-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const filters: string = ScheduleType eq "Daily" and startTime eq 1762237200; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **scheduleTaskIds**: *eq, in* **taskTypeName**: *eq, in* **status**: *eq* **applicationId**: *eq* **fullName**: *eq* **nameSubString**: *eq* **scheduleType**: *eq* Supported composite operators are *and, or* (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getSchedulesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-task-v1 +Get a DAS task. +This end-point gets a task in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-task-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the task to retrieve. | [default to undefined] + +### Return type + +**TaskinfoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the task to retrieve. +const result = await apiInstance.getTaskV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-tasks-v1 +Lists all DAS tasks. +This end-point lists all the tasks in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tasks-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const filters: string = TaskTypeName eq "DataClassification and EndBeforeTime eq 1762240800; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **taskIds**: *eq, in* **statuses**: *eq, in* **taskTypeName**: *eq, in* **taskName**: *eq* **endBeforeTime**: *eq* Supported composite operators are *and, or* Example: taskTypeName eq \"DataSync\" and endBeforeTime eq 1762240800 (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getTasksV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-collectors-v1 +List identity collectors +This endpoint lists the identity collectors in Data Access Security with optional filtering and pagination. + +Sorting is not supported for this endpoint; supplying the `sorters` query parameter results in a validation error. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-collectors-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const filters: string = sourceId eq "2c9180835d2e5168015d32f890ca1581"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* **type**: *eq, in* **id**: *eq, in* Supported composite operators are *and, or* (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listIdentityCollectorsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-application-v1 +Update application by identifier. +This endpoint updates an existing application in Data Access Security with the specified configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-application-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the application to update. | [default to undefined] +**basecreateapplicationrequestV1** | **BasecreateapplicationrequestV1** | Request body containing the updated details for the application. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 12345; // The unique identifier of the application to update. +const basecreateapplicationrequestV1: BasecreateapplicationrequestV1 = ; // Request body containing the updated details for the application. +const result = await apiInstance.putApplicationV1(id, basecreateapplicationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-identity-collector-v1 +Update identity collector by identifier +This endpoint updates the name of an existing identity collector in Data Access Security. The `sourceId` and `type` cannot be changed and must match the current values. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-identity-collector-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the identity collector to update. | [default to undefined] +**updateidentitycollectorrequestV1** | **UpdateidentitycollectorrequestV1** | Request body containing the updated details for the identity collector. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 12345; // The unique identifier of the identity collector to update. +const updateidentitycollectorrequestV1: UpdateidentitycollectorrequestV1 = ; // Request body containing the updated details for the identity collector. +const result = await apiInstance.putIdentityCollectorV1(id, updateidentitycollectorrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-schedule-v1 +Update a schedule. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the schedule to update. | [default to undefined] +**updateschedulerequestV1** | **UpdateschedulerequestV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the schedule to update. +const updateschedulerequestV1: UpdateschedulerequestV1 = ; // +const result = await apiInstance.putScheduleV1(id, updateschedulerequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-task-rerun-v1 +Rerun a DAS task. +This end-point sends a request to re-run a task in Data Access Security. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-task-rerun-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **number** | The unique identifier of the task to rerun. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataAccessSecurityV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataAccessSecurityV1Api(configuration); +const id: number = 1001; // The unique identifier of the task to rerun. +const result = await apiInstance.startTaskRerunV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/data_access_security/docs/Methods/Index.md b/sdk-output/data_access_security/docs/Methods/Index.md new file mode 100644 index 00000000..09d7ee09 --- /dev/null +++ b/sdk-output/data_access_security/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: data_access_security-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: data_access_security-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'data_access_security', 'methods'] +slug: /tools/sdk/typescript/data_access_security/methods +tags: ['SDK', 'Software Development Kit', 'data_access_security', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/data_access_security/docs/Models/Activityconfigurationsettings.md b/sdk-output/data_access_security/docs/Models/Activityconfigurationsettings.md new file mode 100644 index 00000000..20effe37 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Activityconfigurationsettings.md @@ -0,0 +1,26 @@ +--- +id: v1-activityconfigurationsettings-v1 +title: ActivityconfigurationsettingsV1 +pagination_label: ActivityconfigurationsettingsV1 +sidebar_label: ActivityconfigurationsettingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ActivityconfigurationsettingsV1', 'v1ActivityconfigurationsettingsV1'] +slug: /tools/sdk/typescript/data_access_security/models/activityconfigurationsettings-v1 +tags: ['SDK', 'Software Development Kit', 'ActivityconfigurationsettingsV1', 'v1ActivityconfigurationsettingsV1'] +--- + +# ActivityconfigurationsettingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isEnabled** | **(optional)** **boolean** | Indicates whether the feature or configuration is enabled. | [default to false] +**clusterId** | **(optional)** **string** | The identifier of the cluster associated with this configuration, if applicable. | [default to undefined] +**retentionTimePeriod** | **(optional)** **number** | The time period for retaining activity logs. | [default to undefined] +**retentionTimeType** | **(optional)** **string** | The type of retention period (e.g., days, months, years). | [default to undefined] +**excludeUsers** | **(optional)** **Array<string>** | List of user identifiers to exclude from activity tracking. | [default to undefined] +**excludeFolders** | **(optional)** **Array<string>** | List of folder paths to exclude from activity tracking. | [default to undefined] +**excludeFileExtensions** | **(optional)** **Array<string>** | List of file extensions to exclude from activity tracking. | [default to undefined] +**excludeActions** | **(optional)** **Array<string>** | List of actions to exclude from activity tracking. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Applicationcrawlersettings.md b/sdk-output/data_access_security/docs/Models/Applicationcrawlersettings.md new file mode 100644 index 00000000..327657c5 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Applicationcrawlersettings.md @@ -0,0 +1,28 @@ +--- +id: v1-applicationcrawlersettings-v1 +title: ApplicationcrawlersettingsV1 +pagination_label: ApplicationcrawlersettingsV1 +sidebar_label: ApplicationcrawlersettingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationcrawlersettingsV1', 'v1ApplicationcrawlersettingsV1'] +slug: /tools/sdk/typescript/data_access_security/models/applicationcrawlersettings-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationcrawlersettingsV1', 'v1ApplicationcrawlersettingsV1'] +--- + +# ApplicationcrawlersettingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isEnabled** | **(optional)** **boolean** | Indicates whether the feature or configuration is enabled. | [default to false] +**clusterId** | **(optional)** **string** | The identifier of the cluster associated with this configuration, if applicable. | [default to undefined] +**calculateResourceSize** | **(optional)** **CrawlresourcessizesoptionsV1** | | [default to undefined] +**crawlSnapshotsFolder** | **(optional)** **boolean** | Indicates whether to crawl the snapshots folder. | [default to false] +**crawlMailboxes** | **(optional)** **boolean** | Indicates whether to crawl mailboxes. | [default to false] +**crawlPublicFolders** | **(optional)** **boolean** | Indicates whether to crawl public folders. | [default to false] +**excludedPathsByRegex** | **(optional)** **string** | Regular expression pattern for paths to exclude from crawling. | [default to undefined] +**crawlTopLevelShares** | **(optional)** **Array<string>** | List of top-level shares to crawl. | [default to undefined] +**excludedResources** | **(optional)** **Array<string>** | List of resource identifiers to exclude from crawling. | [default to undefined] +**includeResources** | **(optional)** **Array<string>** | List of resource identifiers to include in crawling. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Applicationitem.md b/sdk-output/data_access_security/docs/Models/Applicationitem.md new file mode 100644 index 00000000..8b0ff18a --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Applicationitem.md @@ -0,0 +1,28 @@ +--- +id: v1-applicationitem-v1 +title: ApplicationitemV1 +pagination_label: ApplicationitemV1 +sidebar_label: ApplicationitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationitemV1', 'v1ApplicationitemV1'] +slug: /tools/sdk/typescript/data_access_security/models/applicationitem-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationitemV1', 'v1ApplicationitemV1'] +--- + +# ApplicationitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **number** | The unique identifier of the application. | [default to undefined] +**name** | **(optional)** **string** | The display name of the application. | [default to undefined] +**description** | **(optional)** **string** | A brief description of the application and its purpose. | [default to undefined] +**type** | **(optional)** **string** | The type of the application. | [default to undefined] +**tags** | **(optional)** **Array<TagV1>** | A list of tags associated with the application. | [default to undefined] +**testConnectionStatus** | **(optional)** **string** | The status of the last connection test performed on the application. | [default to undefined] +**testConnectionDate** | **(optional)** **number** | The timestamp of the last connection test performed on the application, in milliseconds since epoch. | [default to undefined] +**rcClusterId** | **(optional)** **string** | The identifier of the cluster used for crawling resources. | [default to undefined] +**dcClusterId** | **(optional)** **string** | The identifier of the cluster used for data classification. | [default to undefined] +**pcClusterId** | **(optional)** **string** | The identifier of the cluster used for permission collection. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Applicationtype.md b/sdk-output/data_access_security/docs/Models/Applicationtype.md new file mode 100644 index 00000000..bcffbdb0 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Applicationtype.md @@ -0,0 +1,47 @@ +--- +id: v1-applicationtype-v1 +title: ApplicationtypeV1 +pagination_label: ApplicationtypeV1 +sidebar_label: ApplicationtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApplicationtypeV1', 'v1ApplicationtypeV1'] +slug: /tools/sdk/typescript/data_access_security/models/applicationtype-v1 +tags: ['SDK', 'Software Development Kit', 'ApplicationtypeV1', 'v1ApplicationtypeV1'] +--- + +# ApplicationtypeV1 + +## Enum + + +* `NUMBER_1` (value: `1`) + +* `NUMBER_8` (value: `8`) + +* `NUMBER_9` (value: `9`) + +* `NUMBER_11` (value: `11`) + +* `NUMBER_15` (value: `15`) + +* `NUMBER_20` (value: `20`) + +* `NUMBER_21` (value: `21`) + +* `NUMBER_24` (value: `24`) + +* `NUMBER_25` (value: `25`) + +* `NUMBER_27` (value: `27`) + +* `NUMBER_28` (value: `28`) + +* `NUMBER_29` (value: `29`) + +* `NUMBER_33` (value: `33`) + +* `NUMBER_35` (value: `35`) + +* `NUMBER_37` (value: `37`) + + diff --git a/sdk-output/data_access_security/docs/Models/Assignresourceownerrequest.md b/sdk-output/data_access_security/docs/Models/Assignresourceownerrequest.md new file mode 100644 index 00000000..bb1df596 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Assignresourceownerrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-assignresourceownerrequest-v1 +title: AssignresourceownerrequestV1 +pagination_label: AssignresourceownerrequestV1 +sidebar_label: AssignresourceownerrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AssignresourceownerrequestV1', 'v1AssignresourceownerrequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/assignresourceownerrequest-v1 +tags: ['SDK', 'Software Development Kit', 'AssignresourceownerrequestV1', 'v1AssignresourceownerrequestV1'] +--- + +# AssignresourceownerrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appId** | **(optional)** **number** | The unique identifier of the application containing the resource. | [default to undefined] +**fullPath** | **(optional)** **string** | The full path to the resource within the application (e.g., file path or object path). | [default to undefined] +**identityId** | **(optional)** **string** | The unique identifier (UUID) of the identity to be assigned as the resource owner. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Basecreateapplicationrequest.md b/sdk-output/data_access_security/docs/Models/Basecreateapplicationrequest.md new file mode 100644 index 00000000..d6eac1d3 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Basecreateapplicationrequest.md @@ -0,0 +1,30 @@ +--- +id: v1-basecreateapplicationrequest-v1 +title: BasecreateapplicationrequestV1 +pagination_label: BasecreateapplicationrequestV1 +sidebar_label: BasecreateapplicationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecreateapplicationrequestV1', 'v1BasecreateapplicationrequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/basecreateapplicationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'BasecreateapplicationrequestV1', 'v1BasecreateapplicationrequestV1'] +--- + +# BasecreateapplicationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**applicationType** | **ApplicationtypeV1** | | [default to undefined] +**name** | **string** | The display name of the application. | [default to undefined] +**description** | **(optional)** **string** | A brief description of the application and its purpose. | [default to undefined] +**tags** | **(optional)** **Array<Int64stringkeyvaluepairV1>** | A list of tags to categorize or identify the application. | [default to undefined] +**identityCollectorId** | **(optional)** **number** | The unique identifier for the identity collector associated with this application. | [default to undefined] +**adIdentityCollectorId** | **(optional)** **number** | The unique identifier for the AD identity collector. | [default to undefined] +**nisIdentityCollectorId** | **(optional)** **number** | The unique identifier for the NIS identity collector. | [default to undefined] +**applicationCrawlerSettings** | **(optional)** **ApplicationcrawlersettingsV1** | | [default to undefined] +**permissionCollectorSettings** | **(optional)** **PermissioncollectorsettingsV1** | | [default to undefined] +**dataClassificationSettings** | **(optional)** **DataclassificationsettingsV1** | | [default to undefined] +**activityConfigurationSettings** | **(optional)** **ActivityconfigurationsettingsV1** | | [default to undefined] +**executeNow** | **(optional)** **boolean** | If true, the application setup will be executed immediately after creation. | [default to false] + diff --git a/sdk-output/data_access_security/docs/Models/Basesettings.md b/sdk-output/data_access_security/docs/Models/Basesettings.md new file mode 100644 index 00000000..b0ceae8a --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Basesettings.md @@ -0,0 +1,20 @@ +--- +id: v1-basesettings-v1 +title: BasesettingsV1 +pagination_label: BasesettingsV1 +sidebar_label: BasesettingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasesettingsV1', 'v1BasesettingsV1'] +slug: /tools/sdk/typescript/data_access_security/models/basesettings-v1 +tags: ['SDK', 'Software Development Kit', 'BasesettingsV1', 'v1BasesettingsV1'] +--- + +# BasesettingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isEnabled** | **(optional)** **boolean** | Indicates whether the feature or configuration is enabled. | [default to false] +**clusterId** | **(optional)** **string** | The identifier of the cluster associated with this configuration, if applicable. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Businessservicetype.md b/sdk-output/data_access_security/docs/Models/Businessservicetype.md new file mode 100644 index 00000000..a941694c --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Businessservicetype.md @@ -0,0 +1,157 @@ +--- +id: v1-businessservicetype-v1 +title: BusinessservicetypeV1 +pagination_label: BusinessservicetypeV1 +sidebar_label: BusinessservicetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BusinessservicetypeV1', 'v1BusinessservicetypeV1'] +slug: /tools/sdk/typescript/data_access_security/models/businessservicetype-v1 +tags: ['SDK', 'Software Development Kit', 'BusinessservicetypeV1', 'v1BusinessservicetypeV1'] +--- + +# BusinessservicetypeV1 + +## Enum + + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +* `NUMBER_3` (value: `3`) + +* `NUMBER_4` (value: `4`) + +* `NUMBER_5` (value: `5`) + +* `NUMBER_6` (value: `6`) + +* `NUMBER_7` (value: `7`) + +* `NUMBER_8` (value: `8`) + +* `NUMBER_9` (value: `9`) + +* `NUMBER_10` (value: `10`) + +* `NUMBER_11` (value: `11`) + +* `NUMBER_12` (value: `12`) + +* `NUMBER_13` (value: `13`) + +* `NUMBER_14` (value: `14`) + +* `NUMBER_15` (value: `15`) + +* `NUMBER_16` (value: `16`) + +* `NUMBER_18` (value: `18`) + +* `NUMBER_24` (value: `24`) + +* `NUMBER_25` (value: `25`) + +* `NUMBER_30` (value: `30`) + +* `NUMBER_801` (value: `801`) + +* `NUMBER_908` (value: `908`) + +* `NUMBER_909` (value: `909`) + +* `NUMBER_910` (value: `910`) + +* `NUMBER_912` (value: `912`) + +* `NUMBER_913` (value: `913`) + +* `NUMBER_914` (value: `914`) + +* `NUMBER_950` (value: `950`) + +* `NUMBER_951` (value: `951`) + +* `NUMBER_952` (value: `952`) + +* `NUMBER_953` (value: `953`) + +* `NUMBER_1000` (value: `1000`) + +* `NUMBER_1100` (value: `1100`) + +* `NUMBER_1101` (value: `1101`) + +* `NUMBER_1200` (value: `1200`) + +* `NUMBER_1201` (value: `1201`) + +* `NUMBER_1202` (value: `1202`) + +* `NUMBER_1203` (value: `1203`) + +* `NUMBER_1204` (value: `1204`) + +* `NUMBER_1205` (value: `1205`) + +* `NUMBER_1206` (value: `1206`) + +* `NUMBER_1207` (value: `1207`) + +* `NUMBER_1208` (value: `1208`) + +* `NUMBER_1209` (value: `1209`) + +* `NUMBER_1210` (value: `1210`) + +* `NUMBER_1211` (value: `1211`) + +* `NUMBER_1212` (value: `1212`) + +* `NUMBER_1213` (value: `1213`) + +* `NUMBER_1214` (value: `1214`) + +* `NUMBER_1215` (value: `1215`) + +* `NUMBER_1216` (value: `1216`) + +* `NUMBER_1300` (value: `1300`) + +* `NUMBER_1301` (value: `1301`) + +* `NUMBER_1302` (value: `1302`) + +* `NUMBER_1303` (value: `1303`) + +* `NUMBER_1304` (value: `1304`) + +* `NUMBER_1305` (value: `1305`) + +* `NUMBER_1400` (value: `1400`) + +* `NUMBER_1401` (value: `1401`) + +* `NUMBER_1402` (value: `1402`) + +* `NUMBER_1403` (value: `1403`) + +* `NUMBER_1404` (value: `1404`) + +* `NUMBER_1405` (value: `1405`) + +* `NUMBER_1406` (value: `1406`) + +* `NUMBER_1407` (value: `1407`) + +* `NUMBER_1408` (value: `1408`) + +* `NUMBER_1409` (value: `1409`) + +* `NUMBER_1410` (value: `1410`) + +* `NUMBER_1411` (value: `1411`) + + diff --git a/sdk-output/data_access_security/docs/Models/Crawlresourcessizesoptions.md b/sdk-output/data_access_security/docs/Models/Crawlresourcessizesoptions.md new file mode 100644 index 00000000..57c8cd14 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Crawlresourcessizesoptions.md @@ -0,0 +1,25 @@ +--- +id: v1-crawlresourcessizesoptions-v1 +title: CrawlresourcessizesoptionsV1 +pagination_label: CrawlresourcessizesoptionsV1 +sidebar_label: CrawlresourcessizesoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CrawlresourcessizesoptionsV1', 'v1CrawlresourcessizesoptionsV1'] +slug: /tools/sdk/typescript/data_access_security/models/crawlresourcessizesoptions-v1 +tags: ['SDK', 'Software Development Kit', 'CrawlresourcessizesoptionsV1', 'v1CrawlresourcessizesoptionsV1'] +--- + +# CrawlresourcessizesoptionsV1 + +## Enum + + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +* `NUMBER_3` (value: `3`) + + diff --git a/sdk-output/data_access_security/docs/Models/CreateIdentityCollectorV1200Response.md b/sdk-output/data_access_security/docs/Models/CreateIdentityCollectorV1200Response.md new file mode 100644 index 00000000..83105753 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/CreateIdentityCollectorV1200Response.md @@ -0,0 +1,20 @@ +--- +id: v1-create-identity-collector-v1200-response-v1 +title: CreateIdentityCollectorV1200ResponseV1 +pagination_label: CreateIdentityCollectorV1200ResponseV1 +sidebar_label: CreateIdentityCollectorV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateIdentityCollectorV1200ResponseV1', 'v1CreateIdentityCollectorV1200ResponseV1'] +slug: /tools/sdk/typescript/data_access_security/models/create-identity-collector-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateIdentityCollectorV1200ResponseV1', 'v1CreateIdentityCollectorV1200ResponseV1'] +--- + +# CreateIdentityCollectorV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **number** | The unique identifier of the created identity collector. | [default to undefined] +**name** | **(optional)** **string** | The display name of the created identity collector. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Createidentitycollectorrequest.md b/sdk-output/data_access_security/docs/Models/Createidentitycollectorrequest.md new file mode 100644 index 00000000..6763d899 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Createidentitycollectorrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-createidentitycollectorrequest-v1 +title: CreateidentitycollectorrequestV1 +pagination_label: CreateidentitycollectorrequestV1 +sidebar_label: CreateidentitycollectorrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateidentitycollectorrequestV1', 'v1CreateidentitycollectorrequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/createidentitycollectorrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateidentitycollectorrequestV1', 'v1CreateidentitycollectorrequestV1'] +--- + +# CreateidentitycollectorrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The display name for the new identity collector. Must be unique within the tenant. | [default to undefined] +**sourceId** | **string** | The identifier of the source to create the identity collector for, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. The identity collector type is derived from this source. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Createschedulerequest.md b/sdk-output/data_access_security/docs/Models/Createschedulerequest.md new file mode 100644 index 00000000..b4700e60 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Createschedulerequest.md @@ -0,0 +1,28 @@ +--- +id: v1-createschedulerequest-v1 +title: CreateschedulerequestV1 +pagination_label: CreateschedulerequestV1 +sidebar_label: CreateschedulerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateschedulerequestV1', 'v1CreateschedulerequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/createschedulerequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateschedulerequestV1', 'v1CreateschedulerequestV1'] +--- + +# CreateschedulerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taskTypeName** | **(optional)** **string** | The type or category of the scheduled task. | [default to undefined] +**scheduleType** | **(optional)** **string** | The scheduling type, such as \"Daily\", \"Weekly\" etc. | [default to undefined] +**interval** | **(optional)** **number** | The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. | [default to undefined] +**scheduleTaskName** | **(optional)** **string** | The display name of the scheduled task. | [default to undefined] +**startTime** | **(optional)** **number** | The start time for the scheduled task, represented as epoch seconds. | [default to undefined] +**endTime** | **(optional)** **number** | The end time for the scheduled task, represented as epoch seconds. | [default to undefined] +**daysOfWeek** | **(optional)** **Array<string>** | A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). | [default to undefined] +**active** | **(optional)** **boolean** | Indicates whether the scheduled task is currently active. | [default to false] +**runAfterScheduleTaskId** | **(optional)** **number** | The ID of another scheduled task that triggers this scheduled task upon its completion. | [default to undefined] +**applicationId** | **(optional)** **number** | The unique identifier of the application associated with the scheduled task. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Dataclassificationsettings.md b/sdk-output/data_access_security/docs/Models/Dataclassificationsettings.md new file mode 100644 index 00000000..ac7e77c9 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Dataclassificationsettings.md @@ -0,0 +1,20 @@ +--- +id: v1-dataclassificationsettings-v1 +title: DataclassificationsettingsV1 +pagination_label: DataclassificationsettingsV1 +sidebar_label: DataclassificationsettingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataclassificationsettingsV1', 'v1DataclassificationsettingsV1'] +slug: /tools/sdk/typescript/data_access_security/models/dataclassificationsettings-v1 +tags: ['SDK', 'Software Development Kit', 'DataclassificationsettingsV1', 'v1DataclassificationsettingsV1'] +--- + +# DataclassificationsettingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isEnabled** | **(optional)** **boolean** | Indicates whether the feature or configuration is enabled. | [default to false] +**clusterId** | **(optional)** **string** | The identifier of the cluster associated with this configuration, if applicable. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Dataownermodel.md b/sdk-output/data_access_security/docs/Models/Dataownermodel.md new file mode 100644 index 00000000..939500ad --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Dataownermodel.md @@ -0,0 +1,21 @@ +--- +id: v1-dataownermodel-v1 +title: DataownermodelV1 +pagination_label: DataownermodelV1 +sidebar_label: DataownermodelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataownermodelV1', 'v1DataownermodelV1'] +slug: /tools/sdk/typescript/data_access_security/models/dataownermodel-v1 +tags: ['SDK', 'Software Development Kit', 'DataownermodelV1', 'v1DataownermodelV1'] +--- + +# DataownermodelV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The unique identifier (UUID) of the identity assigned as the owner of the resource. | [default to undefined] +**resourceId** | **(optional)** **number** | The unique identifier of the resource owned by the identity. | [default to undefined] +**fullPath** | **(optional)** **string** | The full path to the resource within the system or application. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Errormessagedto.md b/sdk-output/data_access_security/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..2695027e --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/data_access_security/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Errorresponsedto.md b/sdk-output/data_access_security/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cd6c1fec --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/data_access_security/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/GetTasksV1401Response.md b/sdk-output/data_access_security/docs/Models/GetTasksV1401Response.md new file mode 100644 index 00000000..ab91cc7b --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/GetTasksV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tasks-v1401-response-v1 +title: GetTasksV1401ResponseV1 +pagination_label: GetTasksV1401ResponseV1 +sidebar_label: GetTasksV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTasksV1401ResponseV1', 'v1GetTasksV1401ResponseV1'] +slug: /tools/sdk/typescript/data_access_security/models/get-tasks-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTasksV1401ResponseV1', 'v1GetTasksV1401ResponseV1'] +--- + +# GetTasksV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/GetTasksV1429Response.md b/sdk-output/data_access_security/docs/Models/GetTasksV1429Response.md new file mode 100644 index 00000000..10a6be6e --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/GetTasksV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tasks-v1429-response-v1 +title: GetTasksV1429ResponseV1 +pagination_label: GetTasksV1429ResponseV1 +sidebar_label: GetTasksV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTasksV1429ResponseV1', 'v1GetTasksV1429ResponseV1'] +slug: /tools/sdk/typescript/data_access_security/models/get-tasks-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTasksV1429ResponseV1', 'v1GetTasksV1429ResponseV1'] +--- + +# GetTasksV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Identitycollectorlistitem.md b/sdk-output/data_access_security/docs/Models/Identitycollectorlistitem.md new file mode 100644 index 00000000..6f8e5e3a --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Identitycollectorlistitem.md @@ -0,0 +1,22 @@ +--- +id: v1-identitycollectorlistitem-v1 +title: IdentitycollectorlistitemV1 +pagination_label: IdentitycollectorlistitemV1 +sidebar_label: IdentitycollectorlistitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycollectorlistitemV1', 'v1IdentitycollectorlistitemV1'] +slug: /tools/sdk/typescript/data_access_security/models/identitycollectorlistitem-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycollectorlistitemV1', 'v1IdentitycollectorlistitemV1'] +--- + +# IdentitycollectorlistitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the identity collector. | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity collector. | [default to undefined] +**type** | **(optional)** **string** | The identity collector type, derived from its underlying source. Possible values include \"Active Directory\", \"Azure Active Directory\", \"Google Drive\", \"Dropbox\", \"Box\", \"Microsoft Entra SaaS\", \"Snowflake\", and \"Databricks\". | [default to undefined] +**sourceId** | **(optional)** **string** | The identifier of the source the identity collector is associated with, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Index.md b/sdk-output/data_access_security/docs/Models/Index.md new file mode 100644 index 00000000..225cfe3f --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: data_access_security-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: data_access_security-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'data_access_security', 'models'] +slug: /tools/sdk/typescript/data_access_security/models +tags: ['SDK', 'Software Development Kit', 'data_access_security', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/data_access_security/docs/Models/Int64stringkeyvaluepair.md b/sdk-output/data_access_security/docs/Models/Int64stringkeyvaluepair.md new file mode 100644 index 00000000..e6b2c3bb --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Int64stringkeyvaluepair.md @@ -0,0 +1,20 @@ +--- +id: v1-int64stringkeyvaluepair-v1 +title: Int64stringkeyvaluepairV1 +pagination_label: Int64stringkeyvaluepairV1 +sidebar_label: Int64stringkeyvaluepairV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Int64stringkeyvaluepairV1', 'v1Int64stringkeyvaluepairV1'] +slug: /tools/sdk/typescript/data_access_security/models/int64stringkeyvaluepair-v1 +tags: ['SDK', 'Software Development Kit', 'Int64stringkeyvaluepairV1', 'v1Int64stringkeyvaluepairV1'] +--- + +# Int64stringkeyvaluepairV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **number** | The key for the tag or pair. | [default to undefined] +**value** | **(optional)** **string** | The value for the tag or pair. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Localeorigin.md b/sdk-output/data_access_security/docs/Models/Localeorigin.md new file mode 100644 index 00000000..b48059c9 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/data_access_security/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/data_access_security/docs/Models/Permissioncollectorsettings.md b/sdk-output/data_access_security/docs/Models/Permissioncollectorsettings.md new file mode 100644 index 00000000..d319bdde --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Permissioncollectorsettings.md @@ -0,0 +1,24 @@ +--- +id: v1-permissioncollectorsettings-v1 +title: PermissioncollectorsettingsV1 +pagination_label: PermissioncollectorsettingsV1 +sidebar_label: PermissioncollectorsettingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissioncollectorsettingsV1', 'v1PermissioncollectorsettingsV1'] +slug: /tools/sdk/typescript/data_access_security/models/permissioncollectorsettings-v1 +tags: ['SDK', 'Software Development Kit', 'PermissioncollectorsettingsV1', 'v1PermissioncollectorsettingsV1'] +--- + +# PermissioncollectorsettingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isEnabled** | **(optional)** **boolean** | Indicates whether the feature or configuration is enabled. | [default to false] +**clusterId** | **(optional)** **string** | The identifier of the cluster associated with this configuration, if applicable. | [default to undefined] +**analyzeUniquePermissions** | **(optional)** **boolean** | Indicates whether unique permissions should be analyzed for resources. | [default to false] +**calculateEffectivePermissions** | **(optional)** **boolean** | Indicates whether effective permissions should be calculated. | [default to false] +**calculateRiskiestPermissions** | **(optional)** **boolean** | Indicates whether riskiest permissions should be calculated. | [default to false] +**effectivePermissionsSource** | **(optional)** **string** | Source for effective permissions calculation. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409Response.md b/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409Response.md new file mode 100644 index 00000000..efdec3da --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409Response.md @@ -0,0 +1,21 @@ +--- +id: v1-put-identity-collector-v1409-response-v1 +title: PutIdentityCollectorV1409ResponseV1 +pagination_label: PutIdentityCollectorV1409ResponseV1 +sidebar_label: PutIdentityCollectorV1409ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutIdentityCollectorV1409ResponseV1', 'v1PutIdentityCollectorV1409ResponseV1'] +slug: /tools/sdk/typescript/data_access_security/models/put-identity-collector-v1409-response-v1 +tags: ['SDK', 'Software Development Kit', 'PutIdentityCollectorV1409ResponseV1', 'v1PutIdentityCollectorV1409ResponseV1'] +--- + +# PutIdentityCollectorV1409ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<PutIdentityCollectorV1409ResponseMessagesInnerV1>** | Generic localized reason for error. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409ResponseMessagesInner.md b/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409ResponseMessagesInner.md new file mode 100644 index 00000000..034128cd --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/PutIdentityCollectorV1409ResponseMessagesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-put-identity-collector-v1409-response-messages-inner-v1 +title: PutIdentityCollectorV1409ResponseMessagesInnerV1 +pagination_label: PutIdentityCollectorV1409ResponseMessagesInnerV1 +sidebar_label: PutIdentityCollectorV1409ResponseMessagesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutIdentityCollectorV1409ResponseMessagesInnerV1', 'v1PutIdentityCollectorV1409ResponseMessagesInnerV1'] +slug: /tools/sdk/typescript/data_access_security/models/put-identity-collector-v1409-response-messages-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PutIdentityCollectorV1409ResponseMessagesInnerV1', 'v1PutIdentityCollectorV1409ResponseMessagesInnerV1'] +--- + +# PutIdentityCollectorV1409ResponseMessagesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **string** | An indicator of how the locale was selected. | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/README.md b/sdk-output/data_access_security/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/data_access_security/docs/Models/Reelectrequest.md b/sdk-output/data_access_security/docs/Models/Reelectrequest.md new file mode 100644 index 00000000..f72f14ca --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Reelectrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-reelectrequest-v1 +title: ReelectrequestV1 +pagination_label: ReelectrequestV1 +sidebar_label: ReelectrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReelectrequestV1', 'v1ReelectrequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/reelectrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ReelectrequestV1', 'v1ReelectrequestV1'] +--- + +# ReelectrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ownerId** | **(optional)** **string** | The UUID of the identity proposed to be re-elected as the resource owner. | [default to undefined] +**campaignName** | **(optional)** **string** | The name of the campaign or election process for re-electing the owner. | [default to undefined] +**reviewers** | **(optional)** **Array<string>** | A list of UUIDs representing the identities of reviewers participating in the re-election process. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Resourcemodel.md b/sdk-output/data_access_security/docs/Models/Resourcemodel.md new file mode 100644 index 00000000..59109f71 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Resourcemodel.md @@ -0,0 +1,24 @@ +--- +id: v1-resourcemodel-v1 +title: ResourcemodelV1 +pagination_label: ResourcemodelV1 +sidebar_label: ResourcemodelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ResourcemodelV1', 'v1ResourcemodelV1'] +slug: /tools/sdk/typescript/data_access_security/models/resourcemodel-v1 +tags: ['SDK', 'Software Development Kit', 'ResourcemodelV1', 'v1ResourcemodelV1'] +--- + +# ResourcemodelV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **number** | The unique identifier for the resource. | [default to undefined] +**name** | **(optional)** **string** | The display name or label for the resource. | [default to undefined] +**fullPath** | **(optional)** **string** | The full path to the resource within the system or application. | [default to undefined] +**applicationId** | **(optional)** **number** | The unique identifier of the application to which this resource belongs. | [default to undefined] +**type** | **(optional)** **BusinessservicetypeV1** | | [default to undefined] +**owners** | **(optional)** **Array<string>** | A list of UUIDs representing the owners of the resource. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Scheduleinfo.md b/sdk-output/data_access_security/docs/Models/Scheduleinfo.md new file mode 100644 index 00000000..7b5f6f15 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Scheduleinfo.md @@ -0,0 +1,33 @@ +--- +id: v1-scheduleinfo-v1 +title: ScheduleinfoV1 +pagination_label: ScheduleinfoV1 +sidebar_label: ScheduleinfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleinfoV1', 'v1ScheduleinfoV1'] +slug: /tools/sdk/typescript/data_access_security/models/scheduleinfo-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleinfoV1', 'v1ScheduleinfoV1'] +--- + +# ScheduleinfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduleTaskId** | **(optional)** **number** | The unique identifier for the scheduled task. | [default to undefined] +**scheduleTaskName** | **(optional)** **string** | The display name of the scheduled task. | [default to undefined] +**taskTypeName** | **(optional)** **string** | The type or category of the scheduled task. | [default to undefined] +**interval** | **(optional)** **number** | The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. | [default to undefined] +**scheduleType** | **(optional)** **string** | The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. | [default to undefined] +**active** | **(optional)** **boolean** | Indicates whether the scheduled task is currently active. | [default to false] +**startTime** | **(optional)** **number** | The start time for the scheduled task, represented as epoch seconds. | [default to undefined] +**endTime** | **(optional)** **number** | The end time for the scheduled task, represented as epoch seconds. | [default to undefined] +**daysOfWeek** | **(optional)** **Array<string>** | A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). | [default to undefined] +**runAfterScheduleTaskId** | **(optional)** **number** | The ID of another scheduled task that triggers this scheduled task upon its completion. | [default to undefined] +**runAfterScheduleTaskName** | **(optional)** **string** | The name of the scheduled task that must complete before this task runs. | [default to undefined] +**applicationId** | **(optional)** **number** | The unique identifier of the application associated with the scheduled task. | [default to undefined] +**createdByDisplayName** | **(optional)** **string** | The display name of the user who created the scheduled task. | [default to undefined] +**nextRun** | **(optional)** **number** | The next scheduled run time for the task, represented as epoch seconds. | [default to undefined] +**lastRun** | **(optional)** **number** | The last run time of the task, represented as epoch seconds. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Tag.md b/sdk-output/data_access_security/docs/Models/Tag.md new file mode 100644 index 00000000..915be54c --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Tag.md @@ -0,0 +1,20 @@ +--- +id: v1-tag-v1 +title: TagV1 +pagination_label: TagV1 +sidebar_label: TagV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TagV1', 'v1TagV1'] +slug: /tools/sdk/typescript/data_access_security/models/tag-v1 +tags: ['SDK', 'Software Development Kit', 'TagV1', 'v1TagV1'] +--- + +# TagV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **number** | The unique identifier for the tag. | [default to undefined] +**name** | **(optional)** **string** | The display name or label for the tag. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Taskinfo.md b/sdk-output/data_access_security/docs/Models/Taskinfo.md new file mode 100644 index 00000000..37d54079 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Taskinfo.md @@ -0,0 +1,28 @@ +--- +id: v1-taskinfo-v1 +title: TaskinfoV1 +pagination_label: TaskinfoV1 +sidebar_label: TaskinfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskinfoV1', 'v1TaskinfoV1'] +slug: /tools/sdk/typescript/data_access_security/models/taskinfo-v1 +tags: ['SDK', 'Software Development Kit', 'TaskinfoV1', 'v1TaskinfoV1'] +--- + +# TaskinfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taskId** | **(optional)** **number** | The unique identifier for the task. | [default to undefined] +**taskTypeName** | **(optional)** **string** | The type or category of the task. | [default to undefined] +**startTime** | **(optional)** **number** | The start time of the task, represented as epoch seconds. | [default to undefined] +**endTime** | **(optional)** **number** | The end time of the task, represented as epoch seconds. | [default to undefined] +**taskName** | **(optional)** **string** | The display name of the task. | [default to undefined] +**createdByDisplayName** | **(optional)** **string** | The display name of the user who created the task. | [default to undefined] +**progress** | **(optional)** **number** | The progress of the task, typically represented as a percentage (0-100). | [default to undefined] +**status** | **(optional)** **string** | The current status of the task (e.g., \"Running\", \"Completed\", \"Failed\"). | [default to undefined] +**details** | **(optional)** **string** | Additional details or information about the task. | [default to undefined] +**scheduleTaskId** | **(optional)** **number** | The unique identifier of the associated scheduled task, if applicable. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Updateidentitycollectorrequest.md b/sdk-output/data_access_security/docs/Models/Updateidentitycollectorrequest.md new file mode 100644 index 00000000..960112ea --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Updateidentitycollectorrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-updateidentitycollectorrequest-v1 +title: UpdateidentitycollectorrequestV1 +pagination_label: UpdateidentitycollectorrequestV1 +sidebar_label: UpdateidentitycollectorrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdateidentitycollectorrequestV1', 'v1UpdateidentitycollectorrequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/updateidentitycollectorrequest-v1 +tags: ['SDK', 'Software Development Kit', 'UpdateidentitycollectorrequestV1', 'v1UpdateidentitycollectorrequestV1'] +--- + +# UpdateidentitycollectorrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The display name of the identity collector. Must be unique within the tenant. | [default to undefined] +**sourceId** | **string** | The identifier of the associated source, represented as a UUID. Both hyphenated and non-hyphenated formats are accepted. This value cannot be modified for an existing identity collector and must match the current value. | [default to undefined] +**type** | **string** | The identity collector type. This value cannot be modified for an existing identity collector and must match the current value. | [default to undefined] + diff --git a/sdk-output/data_access_security/docs/Models/Updateschedulerequest.md b/sdk-output/data_access_security/docs/Models/Updateschedulerequest.md new file mode 100644 index 00000000..4fe546b0 --- /dev/null +++ b/sdk-output/data_access_security/docs/Models/Updateschedulerequest.md @@ -0,0 +1,28 @@ +--- +id: v1-updateschedulerequest-v1 +title: UpdateschedulerequestV1 +pagination_label: UpdateschedulerequestV1 +sidebar_label: UpdateschedulerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdateschedulerequestV1', 'v1UpdateschedulerequestV1'] +slug: /tools/sdk/typescript/data_access_security/models/updateschedulerequest-v1 +tags: ['SDK', 'Software Development Kit', 'UpdateschedulerequestV1', 'v1UpdateschedulerequestV1'] +--- + +# UpdateschedulerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taskTypeName** | **(optional)** **string** | The type or category of the scheduled task. | [default to undefined] +**scheduleType** | **(optional)** **string** | The scheduling type, such as \"Daily\", \"Weekly\", or \"Manual\" etc. | [default to undefined] +**interval** | **(optional)** **number** | The interval depends on the chosen schedule cycle (scheduleType), i.e. if the schedule is daily, the interval will represent the days between executions. | [default to undefined] +**scheduleTaskName** | **(optional)** **string** | The display name of the scheduled task. | [default to undefined] +**startTime** | **(optional)** **number** | The start time for the scheduled task, represented as epoch seconds. | [default to undefined] +**endTime** | **(optional)** **number** | The end time for the scheduled task, represented as epoch seconds. | [default to undefined] +**daysOfWeek** | **(optional)** **Array<string>** | A list of days of the week when the task should run (e.g., \"Monday\", \"Wednesday\"). | [default to undefined] +**active** | **(optional)** **boolean** | Indicates whether the scheduled task is currently active. | [default to false] +**runAfterScheduleTaskId** | **(optional)** **number** | The ID of another scheduled task that triggers this scheduled task upon its completion. | [default to undefined] +**applicationId** | **(optional)** **number** | The unique identifier of the application associated with the scheduled task. | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/data_segmentation/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..af48d42a --- /dev/null +++ b/sdk-output/data_segmentation/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,137 @@ +- path: /data-segments/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#create-data-segment-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const dataSegmentV1: DataSegmentV1 = ; // DataSegmentV1 | + const result = await apiInstance.createDataSegmentV1(dataSegmentV1); + console.log(result); +- path: /data-segments/v1/{segmentId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#delete-data-segment-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const segmentId: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The segment ID to delete. (default to undefined) + const published: boolean = false; // boolean | This determines which version of the segment to delete (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteDataSegmentV1(segmentId); + console.log(result); +- path: /data-segments/v1/membership/{identityId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#get-data-segment-identity-membership-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const identityId: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The identity ID to retrieve the segments they are in. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getDataSegmentIdentityMembershipV1(identityId); + console.log(result); +- path: /data-segments/v1/{segmentId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#get-data-segment-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const segmentId: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The segment ID to retrieve. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getDataSegmentV1(segmentId); + console.log(result); +- path: /data-segments/v1/user-enabled/{identityId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#get-data-segmentation-enabled-for-user-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const identityId: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The identity ID to retrieve if segmentation is enabled for the identity. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getDataSegmentationEnabledForUserV1(identityId); + console.log(result); +- path: /data-segments/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#list-data-segments-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const enabled: boolean = true; // boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to true) + const unique: boolean = false; // boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to false) + const published: boolean = true; // boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (default to true) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq ""'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listDataSegmentsV1(); + console.log(result); +- path: /data-segments/v1/{segmentId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#patch-data-segment-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const segmentId: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The segment ID to modify. (default to undefined) + const requestBody: Array<object> = [{"op":"replace","path":"/memberFilter","value":{"expression":{"operator":"AND","children":[{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Philadelphia"}},{"operator":"EQUALS","attribute":"department","value":{"type":"STRING","value":"HR"}}]}}}]; // Array | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchDataSegmentV1(segmentId, requestBody); + console.log(result); +- path: /data-segments/v1/{segmentId} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/data_segmentation/methods/data-segmentation#publish-data-segment-v1 + source: | + import { DataSegmentationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DataSegmentationV1Api(configuration); + const segmentId: string = 'segmentId_example'; // string | The segmentId. (default to undefined) + const requestBody: Array<string> = ; // Array | A list of segment ids that you wish to publish + const publishAll: boolean = true; // boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to true) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.publishDataSegmentV1(segmentId, requestBody); + console.log(result); diff --git a/sdk-output/data_segmentation/docs/Methods/DataSegmentationV1Api.md b/sdk-output/data_segmentation/docs/Methods/DataSegmentationV1Api.md new file mode 100644 index 00000000..6dafba28 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Methods/DataSegmentationV1Api.md @@ -0,0 +1,389 @@ +--- +id: v1-data-segmentation +title: DataSegmentation +pagination_label: DataSegmentation +sidebar_label: DataSegmentation +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataSegmentation', 'v1DataSegmentation'] +slug: /tools/sdk/typescript/data_segmentation/methods/data-segmentation +tags: ['SDK', 'Software Development Kit', 'DataSegmentation', 'v1DataSegmentation'] +--- + +# DataSegmentationV1Api + This service is responsible for creating segments that will determine how access is delegated to identities +withing the organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-data-segment-v1**](#create-data-segment-v1) | **POST** `/data-segments/v1` | Create segment +[**delete-data-segment-v1**](#delete-data-segment-v1) | **DELETE** `/data-segments/v1/{segmentId}` | Delete segment by id +[**get-data-segment-identity-membership-v1**](#get-data-segment-identity-membership-v1) | **GET** `/data-segments/v1/membership/{identityId}` | Get segmentmembership by identity id +[**get-data-segment-v1**](#get-data-segment-v1) | **GET** `/data-segments/v1/{segmentId}` | Get segment by id +[**get-data-segmentation-enabled-for-user-v1**](#get-data-segmentation-enabled-for-user-v1) | **GET** `/data-segments/v1/user-enabled/{identityId}` | Is segmentation enabled by identity +[**list-data-segments-v1**](#list-data-segments-v1) | **GET** `/data-segments/v1` | Get segments +[**patch-data-segment-v1**](#patch-data-segment-v1) | **PATCH** `/data-segments/v1/{segmentId}` | Update segment +[**publish-data-segment-v1**](#publish-data-segment-v1) | **POST** `/data-segments/v1/{segmentId}` | Publish segment by id + + +## create-data-segment-v1 +Create segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-data-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**dataSegmentV1** | **DataSegmentV1** | | + +### Return type + +**DataSegmentV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const dataSegmentV1: DataSegmentV1 = ; // +const result = await apiInstance.createDataSegmentV1(dataSegmentV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-data-segment-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete segment by id +This API deletes the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-data-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentId** | **string** | The segment ID to delete. | [default to undefined] +**published** | **boolean** | This determines which version of the segment to delete | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const segmentId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The segment ID to delete. +const published: boolean = false; // This determines which version of the segment to delete (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteDataSegmentV1(segmentId); +console.log(result); +``` + +[[Back to top]](#) + +## get-data-segment-identity-membership-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get segmentmembership by identity id +This API returns the segment membership specified by the given identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-data-segment-identity-membership-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | The identity ID to retrieve the segments they are in. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const identityId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The identity ID to retrieve the segments they are in. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getDataSegmentIdentityMembershipV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + +## get-data-segment-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get segment by id +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-data-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentId** | **string** | The segment ID to retrieve. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**DataSegmentV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const segmentId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The segment ID to retrieve. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getDataSegmentV1(segmentId); +console.log(result); +``` + +[[Back to top]](#) + +## get-data-segmentation-enabled-for-user-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Is segmentation enabled by identity +This API returns whether or not segmentation is enabled for the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-data-segmentation-enabled-for-user-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | The identity ID to retrieve if segmentation is enabled for the identity. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**boolean** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const identityId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The identity ID to retrieve if segmentation is enabled for the identity. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getDataSegmentationEnabledForUserV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + +## list-data-segments-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get segments +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-data-segments-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**enabled** | **boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to true] +**unique** | **boolean** | This returns only one record if set to true and that would be the published record if exists. | [optional] [default to false] +**published** | **boolean** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published | [optional] [default to true] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const enabled: boolean = true; // This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) +const unique: boolean = false; // This returns only one record if set to true and that would be the published record if exists. (optional) +const published: boolean = true; // This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq ""; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listDataSegmentsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-data-segment-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-data-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentId** | **string** | The segment ID to modify. | [default to undefined] +**requestBody** | **Array<object>** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**DataSegmentV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const segmentId: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The segment ID to modify. +const requestBody: Array<object> = [{"op":"replace","path":"/memberFilter","value":{"expression":{"operator":"AND","children":[{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Philadelphia"}},{"operator":"EQUALS","attribute":"department","value":{"type":"STRING","value":"HR"}}]}}}]; // A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchDataSegmentV1(segmentId, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## publish-data-segment-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Publish segment by id +This will publish the segment so that it starts applying the segmentation to the desired users if enabled + +[API Spec](https://developer.sailpoint.com/docs/api/v1/publish-data-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentId** | **string** | The segmentId. | [default to undefined] +**requestBody** | **Array<string>** | A list of segment ids that you wish to publish | +**publishAll** | **boolean** | This flag decides whether you want to publish all unpublished or a list of specific segment ids | [optional] [default to true] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DataSegmentationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DataSegmentationV1Api(configuration); +const segmentId: string = segmentId_example; // The segmentId. +const requestBody: Array<string> = ; // A list of segment ids that you wish to publish +const publishAll: boolean = true; // This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.publishDataSegmentV1(segmentId, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/data_segmentation/docs/Methods/Index.md b/sdk-output/data_segmentation/docs/Methods/Index.md new file mode 100644 index 00000000..a96c0bee --- /dev/null +++ b/sdk-output/data_segmentation/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: data_segmentation-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: data_segmentation-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'data_segmentation', 'methods'] +slug: /tools/sdk/typescript/data_segmentation/methods +tags: ['SDK', 'Software Development Kit', 'data_segmentation', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/data_segmentation/docs/Models/DataSegment.md b/sdk-output/data_segmentation/docs/Models/DataSegment.md new file mode 100644 index 00000000..7f498911 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/DataSegment.md @@ -0,0 +1,29 @@ +--- +id: v1-data-segment-v1 +title: DataSegmentV1 +pagination_label: DataSegmentV1 +sidebar_label: DataSegmentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DataSegmentV1', 'v1DataSegmentV1'] +slug: /tools/sdk/typescript/data_segmentation/models/data-segment-v1 +tags: ['SDK', 'Software Development Kit', 'DataSegmentV1', 'v1DataSegmentV1'] +--- + +# DataSegmentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The segment\'s ID. | [default to undefined] +**name** | **(optional)** **string** | The segment\'s business name. | [default to undefined] +**created** | **(optional)** **string** | The time when the segment is created. | [default to undefined] +**modified** | **(optional)** **string** | The time when the segment is modified. | [default to undefined] +**description** | **(optional)** **string** | The segment\'s optional description. | [default to undefined] +**scopes** | **(optional)** **Array<ScopeV1>** | List of Scopes that are assigned to the segment | [default to undefined] +**memberSelection** | **(optional)** **Array<RefV1>** | List of Identities that are assigned to the segment | [default to undefined] +**memberFilter** | **(optional)** **VisibilitycriteriaV1** | | [default to undefined] +**membership** | **(optional)** **MembershiptypeV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [default to false] +**published** | **(optional)** **boolean** | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified to until published | [default to false] + diff --git a/sdk-output/data_segmentation/docs/Models/Dtotype.md b/sdk-output/data_segmentation/docs/Models/Dtotype.md new file mode 100644 index 00000000..2d2b675a --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/data_segmentation/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/data_segmentation/docs/Models/Errormessagedto.md b/sdk-output/data_segmentation/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..699d8296 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/data_segmentation/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Errorresponsedto.md b/sdk-output/data_segmentation/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..8d300dc4 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/data_segmentation/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Expression.md b/sdk-output/data_segmentation/docs/Models/Expression.md new file mode 100644 index 00000000..d96cc12e --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Expression.md @@ -0,0 +1,22 @@ +--- +id: v1-expression-v1 +title: ExpressionV1 +pagination_label: ExpressionV1 +sidebar_label: ExpressionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExpressionV1', 'v1ExpressionV1'] +slug: /tools/sdk/typescript/data_segmentation/models/expression-v1 +tags: ['SDK', 'Software Development Kit', 'ExpressionV1', 'v1ExpressionV1'] +--- + +# ExpressionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | Operator for the expression | [default to undefined] +**attribute** | **(optional)** **string** | Name for the attribute | [default to undefined] +**value** | **(optional)** **ValueV1** | | [default to undefined] +**children** | **(optional)** **Array<ExpressionChildrenInnerV1>** | List of expressions | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/ExpressionChildrenInner.md b/sdk-output/data_segmentation/docs/Models/ExpressionChildrenInner.md new file mode 100644 index 00000000..748feb56 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/ExpressionChildrenInner.md @@ -0,0 +1,22 @@ +--- +id: v1-expression-children-inner-v1 +title: ExpressionChildrenInnerV1 +pagination_label: ExpressionChildrenInnerV1 +sidebar_label: ExpressionChildrenInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExpressionChildrenInnerV1', 'v1ExpressionChildrenInnerV1'] +slug: /tools/sdk/typescript/data_segmentation/models/expression-children-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInnerV1', 'v1ExpressionChildrenInnerV1'] +--- + +# ExpressionChildrenInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | Operator for the expression | [default to undefined] +**attribute** | **(optional)** **string** | Name for the attribute | [default to undefined] +**value** | **(optional)** **ValueV1** | | [default to undefined] +**children** | **(optional)** **string** | There cannot be anymore nested children. This will always be null. | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1401Response.md b/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1401Response.md new file mode 100644 index 00000000..8f2f4aad --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-data-segment-identity-membership-v1401-response-v1 +title: GetDataSegmentIdentityMembershipV1401ResponseV1 +pagination_label: GetDataSegmentIdentityMembershipV1401ResponseV1 +sidebar_label: GetDataSegmentIdentityMembershipV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetDataSegmentIdentityMembershipV1401ResponseV1', 'v1GetDataSegmentIdentityMembershipV1401ResponseV1'] +slug: /tools/sdk/typescript/data_segmentation/models/get-data-segment-identity-membership-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetDataSegmentIdentityMembershipV1401ResponseV1', 'v1GetDataSegmentIdentityMembershipV1401ResponseV1'] +--- + +# GetDataSegmentIdentityMembershipV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1429Response.md b/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1429Response.md new file mode 100644 index 00000000..4ac2398d --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/GetDataSegmentIdentityMembershipV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-data-segment-identity-membership-v1429-response-v1 +title: GetDataSegmentIdentityMembershipV1429ResponseV1 +pagination_label: GetDataSegmentIdentityMembershipV1429ResponseV1 +sidebar_label: GetDataSegmentIdentityMembershipV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetDataSegmentIdentityMembershipV1429ResponseV1', 'v1GetDataSegmentIdentityMembershipV1429ResponseV1'] +slug: /tools/sdk/typescript/data_segmentation/models/get-data-segment-identity-membership-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetDataSegmentIdentityMembershipV1429ResponseV1', 'v1GetDataSegmentIdentityMembershipV1429ResponseV1'] +--- + +# GetDataSegmentIdentityMembershipV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Index.md b/sdk-output/data_segmentation/docs/Models/Index.md new file mode 100644 index 00000000..530876dd --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: data_segmentation-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: data_segmentation-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'data_segmentation', 'models'] +slug: /tools/sdk/typescript/data_segmentation/models +tags: ['SDK', 'Software Development Kit', 'data_segmentation', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/data_segmentation/docs/Models/Localeorigin.md b/sdk-output/data_segmentation/docs/Models/Localeorigin.md new file mode 100644 index 00000000..1883fcb7 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/data_segmentation/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/data_segmentation/docs/Models/Membershiptype.md b/sdk-output/data_segmentation/docs/Models/Membershiptype.md new file mode 100644 index 00000000..958465c5 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Membershiptype.md @@ -0,0 +1,23 @@ +--- +id: v1-membershiptype-v1 +title: MembershiptypeV1 +pagination_label: MembershiptypeV1 +sidebar_label: MembershiptypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MembershiptypeV1', 'v1MembershiptypeV1'] +slug: /tools/sdk/typescript/data_segmentation/models/membershiptype-v1 +tags: ['SDK', 'Software Development Kit', 'MembershiptypeV1', 'v1MembershiptypeV1'] +--- + +# MembershiptypeV1 + +## Enum + + +* `All` (value: `'ALL'`) + +* `Filter` (value: `'FILTER'`) + +* `Selection` (value: `'SELECTION'`) + + diff --git a/sdk-output/data_segmentation/docs/Models/README.md b/sdk-output/data_segmentation/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/data_segmentation/docs/Models/Ref.md b/sdk-output/data_segmentation/docs/Models/Ref.md new file mode 100644 index 00000000..dc50bdf0 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Ref.md @@ -0,0 +1,20 @@ +--- +id: v1-ref-v1 +title: RefV1 +pagination_label: RefV1 +sidebar_label: RefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RefV1', 'v1RefV1'] +slug: /tools/sdk/typescript/data_segmentation/models/ref-v1 +tags: ['SDK', 'Software Development Kit', 'RefV1', 'v1RefV1'] +--- + +# RefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Scope.md b/sdk-output/data_segmentation/docs/Models/Scope.md new file mode 100644 index 00000000..7be9a7b7 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Scope.md @@ -0,0 +1,22 @@ +--- +id: v1-scope-v1 +title: ScopeV1 +pagination_label: ScopeV1 +sidebar_label: ScopeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScopeV1', 'v1ScopeV1'] +slug: /tools/sdk/typescript/data_segmentation/models/scope-v1 +tags: ['SDK', 'Software Development Kit', 'ScopeV1', 'v1ScopeV1'] +--- + +# ScopeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | **(optional)** **ScopetypeV1** | | [default to undefined] +**visibility** | **(optional)** **ScopevisibilitytypeV1** | | [default to undefined] +**scopeFilter** | **(optional)** **VisibilitycriteriaV1** | | [default to undefined] +**scopeSelection** | **(optional)** **Array<RefV1>** | List of Identities that are assigned to the segment | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Scopetype.md b/sdk-output/data_segmentation/docs/Models/Scopetype.md new file mode 100644 index 00000000..af96caae --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Scopetype.md @@ -0,0 +1,25 @@ +--- +id: v1-scopetype-v1 +title: ScopetypeV1 +pagination_label: ScopetypeV1 +sidebar_label: ScopetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScopetypeV1', 'v1ScopetypeV1'] +slug: /tools/sdk/typescript/data_segmentation/models/scopetype-v1 +tags: ['SDK', 'Software Development Kit', 'ScopetypeV1', 'v1ScopetypeV1'] +--- + +# ScopetypeV1 + +## Enum + + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Identity` (value: `'IDENTITY'`) + +* `Entitlementrequest` (value: `'ENTITLEMENTREQUEST'`) + + diff --git a/sdk-output/data_segmentation/docs/Models/Scopevisibilitytype.md b/sdk-output/data_segmentation/docs/Models/Scopevisibilitytype.md new file mode 100644 index 00000000..cff70862 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Scopevisibilitytype.md @@ -0,0 +1,25 @@ +--- +id: v1-scopevisibilitytype-v1 +title: ScopevisibilitytypeV1 +pagination_label: ScopevisibilitytypeV1 +sidebar_label: ScopevisibilitytypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScopevisibilitytypeV1', 'v1ScopevisibilitytypeV1'] +slug: /tools/sdk/typescript/data_segmentation/models/scopevisibilitytype-v1 +tags: ['SDK', 'Software Development Kit', 'ScopevisibilitytypeV1', 'v1ScopevisibilitytypeV1'] +--- + +# ScopevisibilitytypeV1 + +## Enum + + +* `All` (value: `'ALL'`) + +* `Filter` (value: `'FILTER'`) + +* `Selection` (value: `'SELECTION'`) + +* `Unsegmented` (value: `'UNSEGMENTED'`) + + diff --git a/sdk-output/data_segmentation/docs/Models/Segmentmembership.md b/sdk-output/data_segmentation/docs/Models/Segmentmembership.md new file mode 100644 index 00000000..eb585ef1 --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Segmentmembership.md @@ -0,0 +1,21 @@ +--- +id: v1-segmentmembership-v1 +title: SegmentmembershipV1 +pagination_label: SegmentmembershipV1 +sidebar_label: SegmentmembershipV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SegmentmembershipV1', 'v1SegmentmembershipV1'] +slug: /tools/sdk/typescript/data_segmentation/models/segmentmembership-v1 +tags: ['SDK', 'Software Development Kit', 'SegmentmembershipV1', 'v1SegmentmembershipV1'] +--- + +# SegmentmembershipV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**segments** | **(optional)** **Array<string>** | List of segment ids that the identity is associated with. | [default to undefined] +**allAccessScopes** | **(optional)** **Array<ScopetypeV1>** | They type of scopes that are assigned to the identity. | [default to undefined] +**refreshBy** | **(optional)** **string** | Date time string that lets you know when the membership data is going to be refreshed. | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Value.md b/sdk-output/data_segmentation/docs/Models/Value.md new file mode 100644 index 00000000..19b03d4d --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Value.md @@ -0,0 +1,20 @@ +--- +id: v1-value-v1 +title: ValueV1 +pagination_label: ValueV1 +sidebar_label: ValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ValueV1', 'v1ValueV1'] +slug: /tools/sdk/typescript/data_segmentation/models/value-v1 +tags: ['SDK', 'Software Development Kit', 'ValueV1', 'v1ValueV1'] +--- + +# ValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of attribute value | [default to undefined] +**value** | **(optional)** **string** | The attribute value | [default to undefined] + diff --git a/sdk-output/data_segmentation/docs/Models/Visibilitycriteria.md b/sdk-output/data_segmentation/docs/Models/Visibilitycriteria.md new file mode 100644 index 00000000..65cf3a1d --- /dev/null +++ b/sdk-output/data_segmentation/docs/Models/Visibilitycriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-visibilitycriteria-v1 +title: VisibilitycriteriaV1 +pagination_label: VisibilitycriteriaV1 +sidebar_label: VisibilitycriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VisibilitycriteriaV1', 'v1VisibilitycriteriaV1'] +slug: /tools/sdk/typescript/data_segmentation/models/visibilitycriteria-v1 +tags: ['SDK', 'Software Development Kit', 'VisibilitycriteriaV1', 'v1VisibilitycriteriaV1'] +--- + +# VisibilitycriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | **(optional)** **ExpressionV1** | | [default to undefined] + diff --git a/sdk-output/declassify_source/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/declassify_source/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..52a7ef04 --- /dev/null +++ b/sdk-output/declassify_source/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,15 @@ +- path: /sources/v1/{sourceId}/declassify + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/declassify_source/methods/declassify-source#send-declassify-machine-account-from-source-v1 + source: | + import { DeclassifySourceV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DeclassifySourceV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const result = await apiInstance.sendDeclassifyMachineAccountFromSourceV1(sourceId); + console.log(result); diff --git a/sdk-output/declassify_source/docs/Methods/DeclassifySourceV1Api.md b/sdk-output/declassify_source/docs/Methods/DeclassifySourceV1Api.md new file mode 100644 index 00000000..0de62a56 --- /dev/null +++ b/sdk-output/declassify_source/docs/Methods/DeclassifySourceV1Api.md @@ -0,0 +1,59 @@ +--- +id: v1-declassify-source +title: DeclassifySource +pagination_label: DeclassifySource +sidebar_label: DeclassifySource +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeclassifySource', 'v1DeclassifySource'] +slug: /tools/sdk/typescript/declassify_source/methods/declassify-source +tags: ['SDK', 'Software Development Kit', 'DeclassifySource', 'v1DeclassifySource'] +--- + +# DeclassifySourceV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**send-declassify-machine-account-from-source-v1**](#send-declassify-machine-account-from-source-v1) | **POST** `/sources/v1/{sourceId}/declassify` | Declassify source\'s all accounts + + +## send-declassify-machine-account-from-source-v1 +Declassify source\'s all accounts +Use this API to declassify all the accounts from a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-declassify-machine-account-from-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DeclassifySourceV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DeclassifySourceV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const result = await apiInstance.sendDeclassifyMachineAccountFromSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/declassify_source/docs/Methods/Index.md b/sdk-output/declassify_source/docs/Methods/Index.md new file mode 100644 index 00000000..dbf67bbb --- /dev/null +++ b/sdk-output/declassify_source/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: declassify_source-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: declassify_source-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'declassify_source', 'methods'] +slug: /tools/sdk/typescript/declassify_source/methods +tags: ['SDK', 'Software Development Kit', 'declassify_source', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/declassify_source/docs/Models/Errormessagedto.md b/sdk-output/declassify_source/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..caa74bb5 --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/declassify_source/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/declassify_source/docs/Models/Errorresponsedto.md b/sdk-output/declassify_source/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..9498532c --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/declassify_source/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/declassify_source/docs/Models/Index.md b/sdk-output/declassify_source/docs/Models/Index.md new file mode 100644 index 00000000..a3bff875 --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: declassify_source-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: declassify_source-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'declassify_source', 'models'] +slug: /tools/sdk/typescript/declassify_source/models +tags: ['SDK', 'Software Development Kit', 'declassify_source', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/declassify_source/docs/Models/Localeorigin.md b/sdk-output/declassify_source/docs/Models/Localeorigin.md new file mode 100644 index 00000000..5c363631 --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/declassify_source/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/declassify_source/docs/Models/README.md b/sdk-output/declassify_source/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1401Response.md b/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1401Response.md new file mode 100644 index 00000000..0088b1df --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-declassify-machine-account-from-source-v1401-response-v1 +title: SendDeclassifyMachineAccountFromSourceV1401ResponseV1 +pagination_label: SendDeclassifyMachineAccountFromSourceV1401ResponseV1 +sidebar_label: SendDeclassifyMachineAccountFromSourceV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendDeclassifyMachineAccountFromSourceV1401ResponseV1', 'v1SendDeclassifyMachineAccountFromSourceV1401ResponseV1'] +slug: /tools/sdk/typescript/declassify_source/models/send-declassify-machine-account-from-source-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendDeclassifyMachineAccountFromSourceV1401ResponseV1', 'v1SendDeclassifyMachineAccountFromSourceV1401ResponseV1'] +--- + +# SendDeclassifyMachineAccountFromSourceV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1429Response.md b/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1429Response.md new file mode 100644 index 00000000..b9f0b05b --- /dev/null +++ b/sdk-output/declassify_source/docs/Models/SendDeclassifyMachineAccountFromSourceV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-declassify-machine-account-from-source-v1429-response-v1 +title: SendDeclassifyMachineAccountFromSourceV1429ResponseV1 +pagination_label: SendDeclassifyMachineAccountFromSourceV1429ResponseV1 +sidebar_label: SendDeclassifyMachineAccountFromSourceV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendDeclassifyMachineAccountFromSourceV1429ResponseV1', 'v1SendDeclassifyMachineAccountFromSourceV1429ResponseV1'] +slug: /tools/sdk/typescript/declassify_source/models/send-declassify-machine-account-from-source-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendDeclassifyMachineAccountFromSourceV1429ResponseV1', 'v1SendDeclassifyMachineAccountFromSourceV1429ResponseV1'] +--- + +# SendDeclassifyMachineAccountFromSourceV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/dimensions/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..47c8871e --- /dev/null +++ b/sdk-output/dimensions/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,144 @@ +- path: /roles/v1/{roleId}/dimensions + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#create-dimension-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionV1: DimensionV1 = ; // DimensionV1 | + const result = await apiInstance.createDimensionV1(roleId, dimensionV1); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#delete-bulk-dimensions-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimensions. (default to undefined) + const dimensionbulkdeleterequestV1: DimensionbulkdeleterequestV1 = {"dimensionIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // DimensionbulkdeleterequestV1 | + const result = await apiInstance.deleteBulkDimensionsV1(roleId, dimensionbulkdeleterequestV1); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#delete-dimension-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionId: string = '2c9180835d191a86015d28455b4a2329'; // string | Id of the Dimension (default to undefined) + const result = await apiInstance.deleteDimensionV1(roleId, dimensionId); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#get-dimension-entitlements-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionId: string = '2c9180835d191a86015d28455b4a2329'; // string | Id of the Dimension (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) (default to undefined) + const result = await apiInstance.getDimensionEntitlementsV1(roleId, dimensionId); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#get-dimension-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionId: string = '2c9180835d191a86015d28455b4a2329'; // string | Id of the Dimension (default to undefined) + const result = await apiInstance.getDimensionV1(roleId, dimensionId); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#list-dimension-access-profiles-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionId: string = '2c9180835d191a86015d28455b4a2329'; // string | Id of the Dimension (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'source.id eq "2c91808982f979270182f99e386d00fa"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const result = await apiInstance.listDimensionAccessProfilesV1(roleId, dimensionId); + console.log(result); +- path: /roles/v1/{roleId}/dimensions + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#list-dimensions-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const forSubadmin: string = '5168015d32f890ca15812c9180835d2e'; // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) (default to undefined) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq '2c918086749d78830174a1a40e121518''; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const result = await apiInstance.listDimensionsV1(roleId); + console.log(result); +- path: /roles/v1/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/dimensions/methods/dimensions#patch-dimension-v1 + source: | + import { DimensionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new DimensionsV1Api(configuration); + const roleId: string = '6603fba3004f43c687610a29195252ce'; // string | Parent Role Id of the dimension. (default to undefined) + const dimensionId: string = '2c9180835d191a86015d28455b4a2329'; // string | Id of the Dimension (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Test Description"},{"op":"replace","path":"/name","value":"new name"}]; // Array | + const result = await apiInstance.patchDimensionV1(roleId, dimensionId, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/dimensions/docs/Methods/DimensionsV1Api.md b/sdk-output/dimensions/docs/Methods/DimensionsV1Api.md new file mode 100644 index 00000000..c3a204af --- /dev/null +++ b/sdk-output/dimensions/docs/Methods/DimensionsV1Api.md @@ -0,0 +1,399 @@ +--- +id: v1-dimensions +title: Dimensions +pagination_label: Dimensions +sidebar_label: Dimensions +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Dimensions', 'v1Dimensions'] +slug: /tools/sdk/typescript/dimensions/methods/dimensions +tags: ['SDK', 'Software Development Kit', 'Dimensions', 'v1Dimensions'] +--- + +# DimensionsV1Api + Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-dimension-v1**](#create-dimension-v1) | **POST** `/roles/v1/{roleId}/dimensions` | Create a dimension +[**delete-bulk-dimensions-v1**](#delete-bulk-dimensions-v1) | **POST** `/roles/v1/{roleId}/dimensions/bulk-delete` | Delete dimension(s) +[**delete-dimension-v1**](#delete-dimension-v1) | **DELETE** `/roles/v1/{roleId}/dimensions/{dimensionId}` | Delete a dimension +[**get-dimension-entitlements-v1**](#get-dimension-entitlements-v1) | **GET** `/roles/v1/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension\'s entitlements +[**get-dimension-v1**](#get-dimension-v1) | **GET** `/roles/v1/{roleId}/dimensions/{dimensionId}` | Get a dimension under role. +[**list-dimension-access-profiles-v1**](#list-dimension-access-profiles-v1) | **GET** `/roles/v1/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension\'s access profiles +[**list-dimensions-v1**](#list-dimensions-v1) | **GET** `/roles/v1/{roleId}/dimensions` | List dimensions +[**patch-dimension-v1**](#patch-dimension-v1) | **PATCH** `/roles/v1/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension + + +## create-dimension-v1 +Create a dimension +This API creates a dimension. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. +Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-dimension-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionV1** | **DimensionV1** | | + +### Return type + +**DimensionV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionV1: DimensionV1 = ; // +const result = await apiInstance.createDimensionV1(roleId, dimensionV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-bulk-dimensions-v1 +Delete dimension(s) +This endpoint initiates a bulk deletion of one or more dimensions. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-bulk-dimensions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimensions. | [default to undefined] +**dimensionbulkdeleterequestV1** | **DimensionbulkdeleterequestV1** | | + +### Return type + +**TaskresultdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimensions. +const dimensionbulkdeleterequestV1: DimensionbulkdeleterequestV1 = {"dimensionIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // +const result = await apiInstance.deleteBulkDimensionsV1(roleId, dimensionbulkdeleterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-dimension-v1 +Delete a dimension +This API deletes a Dimension by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-dimension-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionId** | **string** | Id of the Dimension | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionId: string = 2c9180835d191a86015d28455b4a2329; // Id of the Dimension +const result = await apiInstance.deleteDimensionV1(roleId, dimensionId); +console.log(result); +``` + +[[Back to top]](#) + +## get-dimension-entitlements-v1 +List dimension\'s entitlements +This API lists the Entitlements associated with a given dimension. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-dimension-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionId** | **string** | Id of the Dimension | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionId: string = 2c9180835d191a86015d28455b4a2329; // Id of the Dimension +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) +const result = await apiInstance.getDimensionEntitlementsV1(roleId, dimensionId); +console.log(result); +``` + +[[Back to top]](#) + +## get-dimension-v1 +Get a dimension under role. +This API returns a Dimension by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-dimension-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionId** | **string** | Id of the Dimension | [default to undefined] + +### Return type + +**DimensionV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionId: string = 2c9180835d191a86015d28455b4a2329; // Id of the Dimension +const result = await apiInstance.getDimensionV1(roleId, dimensionId); +console.log(result); +``` + +[[Back to top]](#) + +## list-dimension-access-profiles-v1 +List dimension\'s access profiles +This API lists the Access Profiles associated with a given Dimension + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-dimension-access-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionId** | **string** | Id of the Dimension | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionId: string = 2c9180835d191a86015d28455b4a2329; // Id of the Dimension +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = source.id eq "2c91808982f979270182f99e386d00fa"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const result = await apiInstance.listDimensionAccessProfilesV1(roleId, dimensionId); +console.log(result); +``` + +[[Back to top]](#) + +## list-dimensions-v1 +List dimensions +This API returns a list of dimensions under a specified role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-dimensions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | [optional] [default to undefined] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const forSubadmin: string = 5168015d32f890ca15812c9180835d2e; // If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq '2c918086749d78830174a1a40e121518'; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const result = await apiInstance.listDimensionsV1(roleId); +console.log(result); +``` + +[[Back to top]](#) + +## patch-dimension-v1 +Patch a specified dimension +This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. +When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-dimension-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleId** | **string** | Parent Role Id of the dimension. | [default to undefined] +**dimensionId** | **string** | Id of the Dimension | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**DimensionV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { DimensionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new DimensionsV1Api(configuration); +const roleId: string = 6603fba3004f43c687610a29195252ce; // Parent Role Id of the dimension. +const dimensionId: string = 2c9180835d191a86015d28455b4a2329; // Id of the Dimension +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Test Description"},{"op":"replace","path":"/name","value":"new name"}]; // +const result = await apiInstance.patchDimensionV1(roleId, dimensionId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/dimensions/docs/Methods/Index.md b/sdk-output/dimensions/docs/Methods/Index.md new file mode 100644 index 00000000..4e6c9ef7 --- /dev/null +++ b/sdk-output/dimensions/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: dimensions-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: dimensions-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'dimensions', 'methods'] +slug: /tools/sdk/typescript/dimensions/methods +tags: ['SDK', 'Software Development Kit', 'dimensions', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/dimensions/docs/Models/Accessduration.md b/sdk-output/dimensions/docs/Models/Accessduration.md new file mode 100644 index 00000000..26fb289a --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessduration.md @@ -0,0 +1,20 @@ +--- +id: v1-accessduration-v1 +title: AccessdurationV1 +pagination_label: AccessdurationV1 +sidebar_label: AccessdurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessdurationV1', 'v1AccessdurationV1'] +slug: /tools/sdk/typescript/dimensions/models/accessduration-v1 +tags: ['SDK', 'Software Development Kit', 'AccessdurationV1', 'v1AccessdurationV1'] +--- + +# AccessdurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value representing the amount of time, which is defined in the **timeUnit**. | [default to undefined] +**timeUnit** | **(optional)** **string** | The unit of time that corresponds to the **value**. It defines the scale of the time period. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Accessmodelmetadata.md b/sdk-output/dimensions/docs/Models/Accessmodelmetadata.md new file mode 100644 index 00000000..8597b7ab --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessmodelmetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-accessmodelmetadata-v1 +title: AccessmodelmetadataV1 +pagination_label: AccessmodelmetadataV1 +sidebar_label: AccessmodelmetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +slug: /tools/sdk/typescript/dimensions/models/accessmodelmetadata-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +--- + +# AccessmodelmetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Unique identifier for the metadata type | [default to undefined] +**name** | **(optional)** **string** | Human readable name of the metadata type | [default to undefined] +**multiselect** | **(optional)** **boolean** | Allows selecting multiple values | [default to false] +**status** | **(optional)** **string** | The state of the metadata item | [default to undefined] +**type** | **(optional)** **string** | The type of the metadata item | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | The types of objects | [default to undefined] +**description** | **(optional)** **string** | Describes the metadata item | [default to undefined] +**values** | **(optional)** **Array<AccessmodelmetadataValuesInnerV1>** | The value to assign to the metadata item | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/AccessmodelmetadataValuesInner.md b/sdk-output/dimensions/docs/Models/AccessmodelmetadataValuesInner.md new file mode 100644 index 00000000..9ead1bda --- /dev/null +++ b/sdk-output/dimensions/docs/Models/AccessmodelmetadataValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessmodelmetadata-values-inner-v1 +title: AccessmodelmetadataValuesInnerV1 +pagination_label: AccessmodelmetadataValuesInnerV1 +sidebar_label: AccessmodelmetadataValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +slug: /tools/sdk/typescript/dimensions/models/accessmodelmetadata-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +--- + +# AccessmodelmetadataValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The value to assign to the metdata item | [default to undefined] +**name** | **(optional)** **string** | Display name of the value | [default to undefined] +**status** | **(optional)** **string** | The status of the individual value | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Accessprofile.md b/sdk-output/dimensions/docs/Models/Accessprofile.md new file mode 100644 index 00000000..a79ab356 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessprofile.md @@ -0,0 +1,34 @@ +--- +id: v1-accessprofile-v1 +title: AccessprofileV1 +pagination_label: AccessprofileV1 +sidebar_label: AccessprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileV1', 'v1AccessprofileV1'] +slug: /tools/sdk/typescript/dimensions/models/accessprofile-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileV1', 'v1AccessprofileV1'] +--- + +# AccessprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Access profile ID. | [readonly] [default to undefined] +**name** | **string** | Access profile name. | [default to undefined] +**description** | **(optional)** **string** | Access profile description. | [default to undefined] +**created** | **(optional)** **string** | Date and time when the access profile was created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Date and time when the access profile was last modified. | [readonly] [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement. | [default to false] +**owner** | **OwnerreferenceV1** | | [default to undefined] +**source** | **AccessprofilesourcerefV1** | | [default to undefined] +**entitlements** | **(optional)** **Array<EntitlementrefV1>** | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [default to undefined] +**requestable** | **(optional)** **boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [default to true] +**accessRequestConfig** | **(optional)** **RequestabilityV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **RevocabilityV1** | | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of segment IDs, if any, that the access profile is assigned to. | [default to undefined] +**accessModelMetadata** | **(optional)** **AttributedtolistV1** | | [default to undefined] +**provisioningCriteria** | **(optional)** **Provisioningcriterialevel1V1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Accessprofileapprovalscheme.md b/sdk-output/dimensions/docs/Models/Accessprofileapprovalscheme.md new file mode 100644 index 00000000..887841d0 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessprofileapprovalscheme.md @@ -0,0 +1,20 @@ +--- +id: v1-accessprofileapprovalscheme-v1 +title: AccessprofileapprovalschemeV1 +pagination_label: AccessprofileapprovalschemeV1 +sidebar_label: AccessprofileapprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofileapprovalschemeV1', 'v1AccessprofileapprovalschemeV1'] +slug: /tools/sdk/typescript/dimensions/models/accessprofileapprovalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofileapprovalschemeV1', 'v1AccessprofileapprovalschemeV1'] +--- + +# AccessprofileapprovalschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Access Profile, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Access Profile, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Accessprofileref.md b/sdk-output/dimensions/docs/Models/Accessprofileref.md new file mode 100644 index 00000000..545a8b9e --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessprofileref.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofileref-v1 +title: AccessprofilerefV1 +pagination_label: AccessprofilerefV1 +sidebar_label: AccessprofilerefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilerefV1', 'v1AccessprofilerefV1'] +slug: /tools/sdk/typescript/dimensions/models/accessprofileref-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilerefV1', 'v1AccessprofilerefV1'] +--- + +# AccessprofilerefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the Access Profile | [default to undefined] +**type** | **(optional)** **string** | Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Accessprofilesourceref.md b/sdk-output/dimensions/docs/Models/Accessprofilesourceref.md new file mode 100644 index 00000000..d010ec08 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Accessprofilesourceref.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofilesourceref-v1 +title: AccessprofilesourcerefV1 +pagination_label: AccessprofilesourcerefV1 +sidebar_label: AccessprofilesourcerefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilesourcerefV1', 'v1AccessprofilesourcerefV1'] +slug: /tools/sdk/typescript/dimensions/models/accessprofilesourceref-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilesourcerefV1', 'v1AccessprofilesourcerefV1'] +--- + +# AccessprofilesourcerefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the source the access profile is associated with. | [default to undefined] +**type** | **(optional)** **string** | Source\'s DTO type. | [default to undefined] +**name** | **(optional)** **string** | Source name. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Additionalownerref.md b/sdk-output/dimensions/docs/Models/Additionalownerref.md new file mode 100644 index 00000000..b3d5fb16 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Additionalownerref.md @@ -0,0 +1,21 @@ +--- +id: v1-additionalownerref-v1 +title: AdditionalownerrefV1 +pagination_label: AdditionalownerrefV1 +sidebar_label: AdditionalownerrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +slug: /tools/sdk/typescript/dimensions/models/additionalownerref-v1 +tags: ['SDK', 'Software Development Kit', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +--- + +# AdditionalownerrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity or governance group. | [default to undefined] +**name** | **(optional)** **string** | Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/ArrayInner.md b/sdk-output/dimensions/docs/Models/ArrayInner.md new file mode 100644 index 00000000..46f45880 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/dimensions/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/dimensions/docs/Models/Attributedto.md b/sdk-output/dimensions/docs/Models/Attributedto.md new file mode 100644 index 00000000..a1cb3720 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Attributedto.md @@ -0,0 +1,26 @@ +--- +id: v1-attributedto-v1 +title: AttributedtoV1 +pagination_label: AttributedtoV1 +sidebar_label: AttributedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtoV1', 'v1AttributedtoV1'] +slug: /tools/sdk/typescript/dimensions/models/attributedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtoV1', 'v1AttributedtoV1'] +--- + +# AttributedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the key. | [default to undefined] +**multiselect** | **(optional)** **boolean** | Indicates whether the attribute can have multiple values. | [default to false] +**status** | **(optional)** **string** | The status of the Attribute. | [default to undefined] +**type** | **(optional)** **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [default to undefined] +**description** | **(optional)** **string** | The description of the Attribute. | [default to undefined] +**values** | **(optional)** **Array<AttributevaluedtoV1>** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Attributedtolist.md b/sdk-output/dimensions/docs/Models/Attributedtolist.md new file mode 100644 index 00000000..db8db395 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Attributedtolist.md @@ -0,0 +1,19 @@ +--- +id: v1-attributedtolist-v1 +title: AttributedtolistV1 +pagination_label: AttributedtolistV1 +sidebar_label: AttributedtolistV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtolistV1', 'v1AttributedtolistV1'] +slug: /tools/sdk/typescript/dimensions/models/attributedtolist-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtolistV1', 'v1AttributedtolistV1'] +--- + +# AttributedtolistV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AttributedtoV1>** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Attributevaluedto.md b/sdk-output/dimensions/docs/Models/Attributevaluedto.md new file mode 100644 index 00000000..6d78ea3b --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Attributevaluedto.md @@ -0,0 +1,21 @@ +--- +id: v1-attributevaluedto-v1 +title: AttributevaluedtoV1 +pagination_label: AttributevaluedtoV1 +sidebar_label: AttributevaluedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +slug: /tools/sdk/typescript/dimensions/models/attributevaluedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +--- + +# AttributevaluedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the Attribute value. | [default to undefined] +**status** | **(optional)** **string** | The status of the Attribute value. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimension.md b/sdk-output/dimensions/docs/Models/Dimension.md new file mode 100644 index 00000000..af2c54e2 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimension.md @@ -0,0 +1,28 @@ +--- +id: v1-dimension-v1 +title: DimensionV1 +pagination_label: DimensionV1 +sidebar_label: DimensionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionV1', 'v1DimensionV1'] +slug: /tools/sdk/typescript/dimensions/models/dimension-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionV1', 'v1DimensionV1'] +--- + +# DimensionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. | [default to undefined] +**name** | **string** | The human-readable display name of the Dimension | [default to undefined] +**created** | **(optional)** **string** | Date the Dimension was created | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Date the Dimension was last modified. | [readonly] [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the Dimension | [default to undefined] +**owner** | **OwnerreferenceV1** | | [default to undefined] +**accessProfiles** | **(optional)** **Array<AccessprofilerefV1>** | | [default to undefined] +**entitlements** | **(optional)** **Array<EntitlementrefV1>** | | [default to undefined] +**membership** | **(optional)** **DimensionmembershipselectorV1** | | [default to undefined] +**parentId** | **(optional)** **string** | The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensionbulkdeleterequest.md b/sdk-output/dimensions/docs/Models/Dimensionbulkdeleterequest.md new file mode 100644 index 00000000..c6e5cbc8 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensionbulkdeleterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-dimensionbulkdeleterequest-v1 +title: DimensionbulkdeleterequestV1 +pagination_label: DimensionbulkdeleterequestV1 +sidebar_label: DimensionbulkdeleterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionbulkdeleterequestV1', 'v1DimensionbulkdeleterequestV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensionbulkdeleterequest-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionbulkdeleterequestV1', 'v1DimensionbulkdeleterequestV1'] +--- + +# DimensionbulkdeleterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimensionIds** | **Array<string>** | List of IDs of Dimensions to be deleted. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriteriakey.md b/sdk-output/dimensions/docs/Models/Dimensioncriteriakey.md new file mode 100644 index 00000000..ba39026f --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriteriakey.md @@ -0,0 +1,20 @@ +--- +id: v1-dimensioncriteriakey-v1 +title: DimensioncriteriakeyV1 +pagination_label: DimensioncriteriakeyV1 +sidebar_label: DimensioncriteriakeyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensioncriteriakeyV1', 'v1DimensioncriteriakeyV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriteriakey-v1 +tags: ['SDK', 'Software Development Kit', 'DimensioncriteriakeyV1', 'v1DimensioncriteriakeyV1'] +--- + +# DimensioncriteriakeyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **DimensioncriteriakeytypeV1** | | [default to undefined] +**property** | **string** | The name of the identity attribute to which the associated criteria applies. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriteriakeytype.md b/sdk-output/dimensions/docs/Models/Dimensioncriteriakeytype.md new file mode 100644 index 00000000..b8835bff --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriteriakeytype.md @@ -0,0 +1,19 @@ +--- +id: v1-dimensioncriteriakeytype-v1 +title: DimensioncriteriakeytypeV1 +pagination_label: DimensioncriteriakeytypeV1 +sidebar_label: DimensioncriteriakeytypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensioncriteriakeytypeV1', 'v1DimensioncriteriakeytypeV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriteriakeytype-v1 +tags: ['SDK', 'Software Development Kit', 'DimensioncriteriakeytypeV1', 'v1DimensioncriteriakeytypeV1'] +--- + +# DimensioncriteriakeytypeV1 + +## Enum + + +* `Identity` (value: `'IDENTITY'`) + + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriterialevel1.md b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel1.md new file mode 100644 index 00000000..fd8dfe75 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel1.md @@ -0,0 +1,22 @@ +--- +id: v1-dimensioncriterialevel1-v1 +title: Dimensioncriterialevel1V1 +pagination_label: Dimensioncriterialevel1V1 +sidebar_label: Dimensioncriterialevel1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Dimensioncriterialevel1V1', 'v1Dimensioncriterialevel1V1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriterialevel1-v1 +tags: ['SDK', 'Software Development Kit', 'Dimensioncriterialevel1V1', 'v1Dimensioncriterialevel1V1'] +--- + +# Dimensioncriterialevel1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **DimensioncriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **DimensioncriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. | [default to undefined] +**children** | **(optional)** **Array<Dimensioncriterialevel2V1>** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriterialevel2.md b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel2.md new file mode 100644 index 00000000..1ed7b4f8 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel2.md @@ -0,0 +1,22 @@ +--- +id: v1-dimensioncriterialevel2-v1 +title: Dimensioncriterialevel2V1 +pagination_label: Dimensioncriterialevel2V1 +sidebar_label: Dimensioncriterialevel2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Dimensioncriterialevel2V1', 'v1Dimensioncriterialevel2V1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriterialevel2-v1 +tags: ['SDK', 'Software Development Kit', 'Dimensioncriterialevel2V1', 'v1Dimensioncriterialevel2V1'] +--- + +# Dimensioncriterialevel2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **DimensioncriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **DimensioncriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [default to undefined] +**children** | **(optional)** **Array<Dimensioncriterialevel3V1>** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriterialevel3.md b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel3.md new file mode 100644 index 00000000..9fa28383 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriterialevel3.md @@ -0,0 +1,21 @@ +--- +id: v1-dimensioncriterialevel3-v1 +title: Dimensioncriterialevel3V1 +pagination_label: Dimensioncriterialevel3V1 +sidebar_label: Dimensioncriterialevel3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Dimensioncriterialevel3V1', 'v1Dimensioncriterialevel3V1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriterialevel3-v1 +tags: ['SDK', 'Software Development Kit', 'Dimensioncriterialevel3V1', 'v1Dimensioncriterialevel3V1'] +--- + +# Dimensioncriterialevel3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **DimensioncriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **DimensioncriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensioncriteriaoperation.md b/sdk-output/dimensions/docs/Models/Dimensioncriteriaoperation.md new file mode 100644 index 00000000..ad9b1fcb --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensioncriteriaoperation.md @@ -0,0 +1,23 @@ +--- +id: v1-dimensioncriteriaoperation-v1 +title: DimensioncriteriaoperationV1 +pagination_label: DimensioncriteriaoperationV1 +sidebar_label: DimensioncriteriaoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensioncriteriaoperationV1', 'v1DimensioncriteriaoperationV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensioncriteriaoperation-v1 +tags: ['SDK', 'Software Development Kit', 'DimensioncriteriaoperationV1', 'v1DimensioncriteriaoperationV1'] +--- + +# DimensioncriteriaoperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/dimensions/docs/Models/Dimensionmembershipselector.md b/sdk-output/dimensions/docs/Models/Dimensionmembershipselector.md new file mode 100644 index 00000000..c3979601 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensionmembershipselector.md @@ -0,0 +1,20 @@ +--- +id: v1-dimensionmembershipselector-v1 +title: DimensionmembershipselectorV1 +pagination_label: DimensionmembershipselectorV1 +sidebar_label: DimensionmembershipselectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionmembershipselectorV1', 'v1DimensionmembershipselectorV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensionmembershipselector-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionmembershipselectorV1', 'v1DimensionmembershipselectorV1'] +--- + +# DimensionmembershipselectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DimensionmembershipselectortypeV1** | | [default to undefined] +**criteria** | **(optional)** **Dimensioncriterialevel1V1** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Dimensionmembershipselectortype.md b/sdk-output/dimensions/docs/Models/Dimensionmembershipselectortype.md new file mode 100644 index 00000000..3ca5f0c7 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Dimensionmembershipselectortype.md @@ -0,0 +1,19 @@ +--- +id: v1-dimensionmembershipselectortype-v1 +title: DimensionmembershipselectortypeV1 +pagination_label: DimensionmembershipselectortypeV1 +sidebar_label: DimensionmembershipselectortypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionmembershipselectortypeV1', 'v1DimensionmembershipselectortypeV1'] +slug: /tools/sdk/typescript/dimensions/models/dimensionmembershipselectortype-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionmembershipselectortypeV1', 'v1DimensionmembershipselectortypeV1'] +--- + +# DimensionmembershipselectortypeV1 + +## Enum + + +* `Standard` (value: `'STANDARD'`) + + diff --git a/sdk-output/dimensions/docs/Models/Entitlement.md b/sdk-output/dimensions/docs/Models/Entitlement.md new file mode 100644 index 00000000..e6651555 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Entitlement.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlement-v1 +title: EntitlementV1 +pagination_label: EntitlementV1 +sidebar_label: EntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementV1', 'v1EntitlementV1'] +slug: /tools/sdk/typescript/dimensions/models/entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementV1', 'v1EntitlementV1'] +--- + +# EntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | True if the entitlement is privileged | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **EntitlementOwnerV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **EntitlementAccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **EntitlementSourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/EntitlementAccessModelMetadata.md b/sdk-output/dimensions/docs/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 00000000..7743c5f5 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlement-access-model-metadata-v1 +title: EntitlementAccessModelMetadataV1 +pagination_label: EntitlementAccessModelMetadataV1 +sidebar_label: EntitlementAccessModelMetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +slug: /tools/sdk/typescript/dimensions/models/entitlement-access-model-metadata-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +--- + +# EntitlementAccessModelMetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AccessmodelmetadataV1>** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/EntitlementOwner.md b/sdk-output/dimensions/docs/Models/EntitlementOwner.md new file mode 100644 index 00000000..e1848c30 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/EntitlementOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-owner-v1 +title: EntitlementOwnerV1 +pagination_label: EntitlementOwnerV1 +sidebar_label: EntitlementOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +slug: /tools/sdk/typescript/dimensions/models/entitlement-owner-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +--- + +# EntitlementOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | The type of object | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/EntitlementSource.md b/sdk-output/dimensions/docs/Models/EntitlementSource.md new file mode 100644 index 00000000..8a29478d --- /dev/null +++ b/sdk-output/dimensions/docs/Models/EntitlementSource.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-source-v1 +title: EntitlementSourceV1 +pagination_label: EntitlementSourceV1 +sidebar_label: EntitlementSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +slug: /tools/sdk/typescript/dimensions/models/entitlement-source-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +--- + +# EntitlementSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Entitlementref.md b/sdk-output/dimensions/docs/Models/Entitlementref.md new file mode 100644 index 00000000..e5b684b9 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Entitlementref.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementref-v1 +title: EntitlementrefV1 +pagination_label: EntitlementrefV1 +sidebar_label: EntitlementrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrefV1', 'v1EntitlementrefV1'] +slug: /tools/sdk/typescript/dimensions/models/entitlementref-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrefV1', 'v1EntitlementrefV1'] +--- + +# EntitlementrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Entitlement\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Entitlement\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Entitlement\'s display name. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Errormessagedto.md b/sdk-output/dimensions/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..d0605408 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/dimensions/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Errorresponsedto.md b/sdk-output/dimensions/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..670391f4 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/dimensions/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Index.md b/sdk-output/dimensions/docs/Models/Index.md new file mode 100644 index 00000000..c800b7bd --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: dimensions-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: dimensions-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'dimensions', 'models'] +slug: /tools/sdk/typescript/dimensions/models +tags: ['SDK', 'Software Development Kit', 'dimensions', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/dimensions/docs/Models/Jsonpatchoperation.md b/sdk-output/dimensions/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..f0ffe991 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/dimensions/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/JsonpatchoperationValue.md b/sdk-output/dimensions/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..451aa51f --- /dev/null +++ b/sdk-output/dimensions/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/dimensions/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/dimensions/docs/Models/ListDimensionsV1401Response.md b/sdk-output/dimensions/docs/Models/ListDimensionsV1401Response.md new file mode 100644 index 00000000..5737f1ad --- /dev/null +++ b/sdk-output/dimensions/docs/Models/ListDimensionsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-dimensions-v1401-response-v1 +title: ListDimensionsV1401ResponseV1 +pagination_label: ListDimensionsV1401ResponseV1 +sidebar_label: ListDimensionsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListDimensionsV1401ResponseV1', 'v1ListDimensionsV1401ResponseV1'] +slug: /tools/sdk/typescript/dimensions/models/list-dimensions-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListDimensionsV1401ResponseV1', 'v1ListDimensionsV1401ResponseV1'] +--- + +# ListDimensionsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/ListDimensionsV1429Response.md b/sdk-output/dimensions/docs/Models/ListDimensionsV1429Response.md new file mode 100644 index 00000000..16aba1c7 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/ListDimensionsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-dimensions-v1429-response-v1 +title: ListDimensionsV1429ResponseV1 +pagination_label: ListDimensionsV1429ResponseV1 +sidebar_label: ListDimensionsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListDimensionsV1429ResponseV1', 'v1ListDimensionsV1429ResponseV1'] +slug: /tools/sdk/typescript/dimensions/models/list-dimensions-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListDimensionsV1429ResponseV1', 'v1ListDimensionsV1429ResponseV1'] +--- + +# ListDimensionsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Localeorigin.md b/sdk-output/dimensions/docs/Models/Localeorigin.md new file mode 100644 index 00000000..614bd0b3 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/dimensions/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/dimensions/docs/Models/Ownerreference.md b/sdk-output/dimensions/docs/Models/Ownerreference.md new file mode 100644 index 00000000..31ca3666 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Ownerreference.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerreference-v1 +title: OwnerreferenceV1 +pagination_label: OwnerreferenceV1 +sidebar_label: OwnerreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +slug: /tools/sdk/typescript/dimensions/models/ownerreference-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +--- + +# OwnerreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Permissiondto.md b/sdk-output/dimensions/docs/Models/Permissiondto.md new file mode 100644 index 00000000..7425eb4e --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/dimensions/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Provisioningcriterialevel1.md b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel1.md new file mode 100644 index 00000000..1b7fa83c --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel1.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel1-v1 +title: Provisioningcriterialevel1V1 +pagination_label: Provisioningcriterialevel1V1 +sidebar_label: Provisioningcriterialevel1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel1V1', 'v1Provisioningcriterialevel1V1'] +slug: /tools/sdk/typescript/dimensions/models/provisioningcriterialevel1-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel1V1', 'v1Provisioningcriterialevel1V1'] +--- + +# Provisioningcriterialevel1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **Array<Provisioningcriterialevel2V1>** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Provisioningcriterialevel2.md b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel2.md new file mode 100644 index 00000000..38816925 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel2.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel2-v1 +title: Provisioningcriterialevel2V1 +pagination_label: Provisioningcriterialevel2V1 +sidebar_label: Provisioningcriterialevel2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel2V1', 'v1Provisioningcriterialevel2V1'] +slug: /tools/sdk/typescript/dimensions/models/provisioningcriterialevel2-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel2V1', 'v1Provisioningcriterialevel2V1'] +--- + +# Provisioningcriterialevel2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **Array<Provisioningcriterialevel3V1>** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Provisioningcriterialevel3.md b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel3.md new file mode 100644 index 00000000..fa6c1e6d --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Provisioningcriterialevel3.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningcriterialevel3-v1 +title: Provisioningcriterialevel3V1 +pagination_label: Provisioningcriterialevel3V1 +sidebar_label: Provisioningcriterialevel3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningcriterialevel3V1', 'v1Provisioningcriterialevel3V1'] +slug: /tools/sdk/typescript/dimensions/models/provisioningcriterialevel3-v1 +tags: ['SDK', 'Software Development Kit', 'Provisioningcriterialevel3V1', 'v1Provisioningcriterialevel3V1'] +--- + +# Provisioningcriterialevel3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **ProvisioningcriteriaoperationV1** | | [default to undefined] +**attribute** | **(optional)** **string** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [default to undefined] +**value** | **(optional)** **string** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [default to undefined] +**children** | **(optional)** **string** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Provisioningcriteriaoperation.md b/sdk-output/dimensions/docs/Models/Provisioningcriteriaoperation.md new file mode 100644 index 00000000..b916534d --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Provisioningcriteriaoperation.md @@ -0,0 +1,29 @@ +--- +id: v1-provisioningcriteriaoperation-v1 +title: ProvisioningcriteriaoperationV1 +pagination_label: ProvisioningcriteriaoperationV1 +sidebar_label: ProvisioningcriteriaoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcriteriaoperationV1', 'v1ProvisioningcriteriaoperationV1'] +slug: /tools/sdk/typescript/dimensions/models/provisioningcriteriaoperation-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcriteriaoperationV1', 'v1ProvisioningcriteriaoperationV1'] +--- + +# ProvisioningcriteriaoperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `NotEquals` (value: `'NOT_EQUALS'`) + +* `Contains` (value: `'CONTAINS'`) + +* `Has` (value: `'HAS'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/dimensions/docs/Models/README.md b/sdk-output/dimensions/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/dimensions/docs/Models/Requestability.md b/sdk-output/dimensions/docs/Models/Requestability.md new file mode 100644 index 00000000..c1248a10 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Requestability.md @@ -0,0 +1,24 @@ +--- +id: v1-requestability-v1 +title: RequestabilityV1 +pagination_label: RequestabilityV1 +sidebar_label: RequestabilityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestabilityV1', 'v1RequestabilityV1'] +slug: /tools/sdk/typescript/dimensions/models/requestability-v1 +tags: ['SDK', 'Software Development Kit', 'RequestabilityV1', 'v1RequestabilityV1'] +--- + +# RequestabilityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentsRequired** | **(optional)** **boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [default to false] +**denialCommentsRequired** | **(optional)** **boolean** | Indicates whether an approver must provide comments when denying the request. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Indicates whether reauthorization is required for the request. | [default to false] +**requireEndDate** | **(optional)** **boolean** | Indicates whether the requester of the containing object must provide access end date. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **AccessdurationV1** | | [default to undefined] +**approvalSchemes** | **(optional)** **Array<AccessprofileapprovalschemeV1>** | List describing the steps involved in approving the request. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Revocability.md b/sdk-output/dimensions/docs/Models/Revocability.md new file mode 100644 index 00000000..f7f6dbe3 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Revocability.md @@ -0,0 +1,19 @@ +--- +id: v1-revocability-v1 +title: RevocabilityV1 +pagination_label: RevocabilityV1 +sidebar_label: RevocabilityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RevocabilityV1', 'v1RevocabilityV1'] +slug: /tools/sdk/typescript/dimensions/models/revocability-v1 +tags: ['SDK', 'Software Development Kit', 'RevocabilityV1', 'v1RevocabilityV1'] +--- + +# RevocabilityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<AccessprofileapprovalschemeV1>** | List describing the steps involved in approving the revocation request. | [default to undefined] + diff --git a/sdk-output/dimensions/docs/Models/Taskresultdto.md b/sdk-output/dimensions/docs/Models/Taskresultdto.md new file mode 100644 index 00000000..9ee706f6 --- /dev/null +++ b/sdk-output/dimensions/docs/Models/Taskresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taskresultdto-v1 +title: TaskresultdtoV1 +pagination_label: TaskresultdtoV1 +sidebar_label: TaskresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +slug: /tools/sdk/typescript/dimensions/models/taskresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +--- + +# TaskresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Task result DTO type. | [default to undefined] +**id** | **(optional)** **string** | Task result ID. | [default to undefined] +**name** | **(optional)** **string** | Task result display name. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/entitlement_connections/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bc028f55 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,89 @@ +- path: /entitlement-connections/v1/current-identity + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlement_connections/methods/entitlement-connections#list-entitlement-connections-for-current-identity-v1 + source: | + import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementConnectionsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const filters: string = 'state.value co "Available"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. (optional) (default to undefined) + const sorters: string = 'id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** (optional) (default to undefined) + const result = await apiInstance.listEntitlementConnectionsForCurrentIdentityV1(); + console.log(result); +- path: /entitlement-connections/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlement_connections/methods/entitlement-connections#list-entitlement-connections-v1 + source: | + import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementConnectionsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const filters: string = 'type eq "JIT"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* (optional) (default to undefined) + const sorters: string = '-type,id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. (optional) (default to undefined) + const result = await apiInstance.listEntitlementConnectionsV1(); + console.log(result); +- path: /entitlement-connections/v1/{connectionId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlement_connections/methods/entitlement-connections#patch-entitlement-connection-by-id-v1 + source: | + import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementConnectionsV1Api(configuration); + const connectionId: string = '6c692d9972f8400ca4560a68f62c4c5f'; // string | Connection ID (UUID with or without hyphens). (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | + const result = await apiInstance.patchEntitlementConnectionByIdV1(connectionId, jsonpatchoperationV1); + console.log(result); +- path: /entitlement-connections/v1 + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlement_connections/methods/entitlement-connections#patch-entitlement-connection-by-query-v1 + source: | + import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementConnectionsV1Api(configuration); + const entitlementId: string = 'dcfd09e551644ad5aa162ce977862031'; // string | Entitlement ID (UUID with or without hyphens). (default to undefined) + const identityId: string = '5470d8d4817a4207a8020bf533187da9'; // string | Identity ID (UUID with or without hyphens). (default to undefined) + const accountId: string = '323bfddfb3dd4197b8f10f7735307d27'; // string | Account ID (UUID with or without hyphens). (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | + const result = await apiInstance.patchEntitlementConnectionByQueryV1(entitlementId, identityId, accountId, jsonpatchoperationV1); + console.log(result); +- path: /entitlement-connections/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlement_connections/methods/entitlement-connections#update-entitlement-connections-bulk-v1 + source: | + import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementConnectionsV1Api(configuration); + const entitlementconnectionbulkupdateitemV1: Array<EntitlementconnectionbulkupdateitemV1> = [{"connectionId":"d532fa5cb15748e2873c6a01e5923ec4","type":"JIT"},{"connectionId":"57bdbfcab8a34afb91c0a9fb4dba52b8","type":"STANDING"},{"connectionId":"0f571cefc8a2411790e0ee09f77e25a3","type":"STANDING"},{"connectionId":"025542c7e42144258c6f2325b6feeba8","type":"JIT"},{"connectionId":"6bccbc42381f49028dac9bfe68dbad2e","type":"JIT"}]; // Array | + const result = await apiInstance.updateEntitlementConnectionsBulkV1(entitlementconnectionbulkupdateitemV1); + console.log(result); diff --git a/sdk-output/entitlement_connections/docs/Methods/EntitlementConnectionsV1Api.md b/sdk-output/entitlement_connections/docs/Methods/EntitlementConnectionsV1Api.md new file mode 100644 index 00000000..b360a2bb --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Methods/EntitlementConnectionsV1Api.md @@ -0,0 +1,255 @@ +--- +id: v1-entitlement-connections +title: EntitlementConnections +pagination_label: EntitlementConnections +sidebar_label: EntitlementConnections +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementConnections', 'v1EntitlementConnections'] +slug: /tools/sdk/typescript/entitlement_connections/methods/entitlement-connections +tags: ['SDK', 'Software Development Kit', 'EntitlementConnections', 'v1EntitlementConnections'] +--- + +# EntitlementConnectionsV1Api + Use this API to search and manage entitlement connections. +Entitlement connections represent the relationship between an identity account and an entitlement on a source, including its access type and JIT lifecycle state. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-entitlement-connections-for-current-identity-v1**](#list-entitlement-connections-for-current-identity-v1) | **GET** `/entitlement-connections/v1/current-identity` | List my entitlement connections +[**list-entitlement-connections-v1**](#list-entitlement-connections-v1) | **GET** `/entitlement-connections/v1` | List entitlement connections +[**patch-entitlement-connection-by-id-v1**](#patch-entitlement-connection-by-id-v1) | **PATCH** `/entitlement-connections/v1/{connectionId}` | Update entitlement connection +[**patch-entitlement-connection-by-query-v1**](#patch-entitlement-connection-by-query-v1) | **PATCH** `/entitlement-connections/v1` | Update connection by query +[**update-entitlement-connections-bulk-v1**](#update-entitlement-connections-bulk-v1) | **POST** `/entitlement-connections/v1` | Update connections in bulk + + +## list-entitlement-connections-for-current-identity-v1 +List my entitlement connections +Returns entitlement connections constrained to the authenticated identity. +This endpoint proxies to Search and supports standard collection query parameters. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlement-connections-for-current-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementConnectionsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const filters: string = state.value co "Available"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. (optional) +const sorters: string = id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** (optional) +const result = await apiInstance.listEntitlementConnectionsForCurrentIdentityV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlement-connections-v1 +List entitlement connections +Returns entitlement connections for the tenant. + +This endpoint proxies to Search and supports standard collection query parameters. +The `filters` and `sorters` values support the Entitlement Connections search fields documented by ECS. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlement-connections-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementConnectionsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const filters: string = type eq "JIT"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* (optional) +const sorters: string = -type,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. (optional) +const result = await apiInstance.listEntitlementConnectionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-entitlement-connection-by-id-v1 +Update entitlement connection +Applies JSON Patch operations to an entitlement connection selected by `connectionId`. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-entitlement-connection-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**connectionId** | **string** | Connection ID (UUID with or without hyphens). | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**EntitlementconnectionV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementConnectionsV1Api(configuration); +const connectionId: string = 6c692d9972f8400ca4560a68f62c4c5f; // Connection ID (UUID with or without hyphens). +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // +const result = await apiInstance.patchEntitlementConnectionByIdV1(connectionId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-entitlement-connection-by-query-v1 +Update connection by query +Applies JSON Patch operations to a single entitlement connection selected by +`entitlementId`, `identityId`, and `accountId`. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-entitlement-connection-by-query-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementId** | **string** | Entitlement ID (UUID with or without hyphens). | [default to undefined] +**identityId** | **string** | Identity ID (UUID with or without hyphens). | [default to undefined] +**accountId** | **string** | Account ID (UUID with or without hyphens). | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**EntitlementconnectionV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementConnectionsV1Api(configuration); +const entitlementId: string = dcfd09e551644ad5aa162ce977862031; // Entitlement ID (UUID with or without hyphens). +const identityId: string = 5470d8d4817a4207a8020bf533187da9; // Identity ID (UUID with or without hyphens). +const accountId: string = 323bfddfb3dd4197b8f10f7735307d27; // Account ID (UUID with or without hyphens). +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // +const result = await apiInstance.patchEntitlementConnectionByQueryV1(entitlementId, identityId, accountId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-entitlement-connections-bulk-v1 +Update connections in bulk +Updates connection type for up to 100 connections in one request. +The API returns per-item results in a 207 Multi-Status response. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-entitlement-connections-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementconnectionbulkupdateitemV1** | **Array<EntitlementconnectionbulkupdateitemV1>** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementConnectionsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementConnectionsV1Api(configuration); +const entitlementconnectionbulkupdateitemV1: Array<EntitlementconnectionbulkupdateitemV1> = [{"connectionId":"d532fa5cb15748e2873c6a01e5923ec4","type":"JIT"},{"connectionId":"57bdbfcab8a34afb91c0a9fb4dba52b8","type":"STANDING"},{"connectionId":"0f571cefc8a2411790e0ee09f77e25a3","type":"STANDING"},{"connectionId":"025542c7e42144258c6f2325b6feeba8","type":"JIT"},{"connectionId":"6bccbc42381f49028dac9bfe68dbad2e","type":"JIT"}]; // +const result = await apiInstance.updateEntitlementConnectionsBulkV1(entitlementconnectionbulkupdateitemV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/entitlement_connections/docs/Methods/Index.md b/sdk-output/entitlement_connections/docs/Methods/Index.md new file mode 100644 index 00000000..d2675be7 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: entitlement_connections-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: entitlement_connections-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'entitlement_connections', 'methods'] +slug: /tools/sdk/typescript/entitlement_connections/methods +tags: ['SDK', 'Software Development Kit', 'entitlement_connections', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/entitlement_connections/docs/Models/ArrayInner.md b/sdk-output/entitlement_connections/docs/Models/ArrayInner.md new file mode 100644 index 00000000..e9052ebb --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/entitlement_connections/docs/Models/Entitlementconnection.md b/sdk-output/entitlement_connections/docs/Models/Entitlementconnection.md new file mode 100644 index 00000000..87c29440 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Entitlementconnection.md @@ -0,0 +1,41 @@ +--- +id: v1-entitlementconnection-v1 +title: EntitlementconnectionV1 +pagination_label: EntitlementconnectionV1 +sidebar_label: EntitlementconnectionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionV1', 'v1EntitlementconnectionV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnection-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionV1', 'v1EntitlementconnectionV1'] +--- + +# EntitlementconnectionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenantId** | **(optional)** **string** | Tenant identifier that owns the connection. | [default to undefined] +**connectionId** | **(optional)** **string** | Entitlement connection identifier. | [default to undefined] +**identityId** | **(optional)** **string** | Identity identifier associated with the connection. | [default to undefined] +**machineIdentityId** | **(optional)** **string** | Machine identity identifier when the connection is machine-backed. | [default to undefined] +**accountId** | **(optional)** **string** | Account identifier for the connected source account. | [default to undefined] +**entitlementId** | **(optional)** **string** | Entitlement identifier on the source. | [default to undefined] +**sourceId** | **(optional)** **string** | Source identifier that provides the account and entitlement. | [default to undefined] +**standalone** | **(optional)** **boolean** | Indicates whether the connection is marked as standalone. | [default to false] +**attributeName** | **(optional)** **string** | Entitlement attribute name on the source. | [default to undefined] +**attributeValue** | **(optional)** **string** | Entitlement attribute value on the source. | [default to undefined] +**type** | **(optional)** **string** | Connection type classification. | [default to undefined] +**state** | **(optional)** **string** | Current lifecycle state of the connection. | [default to undefined] +**stateChanged** | **(optional)** **string** | Time the connection state was last updated. | [default to undefined] +**stateChangedBy** | **(optional)** **string** | Identifier of the actor that last changed state. | [default to undefined] +**jitActivation** | **(optional)** **string** | Time JIT activation occurred. | [default to undefined] +**jitProvision** | **(optional)** **string** | Time provisioning completed for JIT activation. | [default to undefined] +**jitDeactivation** | **(optional)** **string** | Time JIT deactivation occurred. | [default to undefined] +**jitDeprovision** | **(optional)** **string** | Time deprovisioning completed after JIT deactivation. | [default to undefined] +**jitExpiration** | **(optional)** **string** | Time when JIT access expires. | [default to undefined] +**deleteAfter** | **(optional)** **string** | Time after which the connection is eligible for deletion. | [default to undefined] +**created** | **(optional)** **string** | Time when the connection was created. | [default to undefined] +**modified** | **(optional)** **string** | Time when the connection was last modified. | [default to undefined] +**actorName** | **(optional)** **string** | Display value for the actor associated with the latest change. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateitem.md b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateitem.md new file mode 100644 index 00000000..d108d1d6 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateitem.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementconnectionbulkupdateitem-v1 +title: EntitlementconnectionbulkupdateitemV1 +pagination_label: EntitlementconnectionbulkupdateitemV1 +sidebar_label: EntitlementconnectionbulkupdateitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionbulkupdateitemV1', 'v1EntitlementconnectionbulkupdateitemV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnectionbulkupdateitem-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionbulkupdateitemV1', 'v1EntitlementconnectionbulkupdateitemV1'] +--- + +# EntitlementconnectionbulkupdateitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectionId** | **string** | Connection ID to update. | [default to undefined] +**type** | **string** | Target connection type. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateresultitem.md b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateresultitem.md new file mode 100644 index 00000000..a10f4db5 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionbulkupdateresultitem.md @@ -0,0 +1,22 @@ +--- +id: v1-entitlementconnectionbulkupdateresultitem-v1 +title: EntitlementconnectionbulkupdateresultitemV1 +pagination_label: EntitlementconnectionbulkupdateresultitemV1 +sidebar_label: EntitlementconnectionbulkupdateresultitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionbulkupdateresultitemV1', 'v1EntitlementconnectionbulkupdateresultitemV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnectionbulkupdateresultitem-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionbulkupdateresultitemV1', 'v1EntitlementconnectionbulkupdateresultitemV1'] +--- + +# EntitlementconnectionbulkupdateresultitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectionId** | **(optional)** **string** | Connection ID processed in this row. | [default to undefined] +**type** | **(optional)** **string** | Requested or resulting connection type for the row. | [default to undefined] +**status** | **(optional)** **number** | Item-level result status code. | [default to undefined] +**description** | **(optional)** **string** | Item-level result message. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhit.md b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhit.md new file mode 100644 index 00000000..99c18afb --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhit.md @@ -0,0 +1,28 @@ +--- +id: v1-entitlementconnectionsearchhit-v1 +title: EntitlementconnectionsearchhitV1 +pagination_label: EntitlementconnectionsearchhitV1 +sidebar_label: EntitlementconnectionsearchhitV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionsearchhitV1', 'v1EntitlementconnectionsearchhitV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnectionsearchhit-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionsearchhitV1', 'v1EntitlementconnectionsearchhitV1'] +--- + +# EntitlementconnectionsearchhitV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Connection ID as represented in search results. | [default to undefined] +**identity** | **(optional)** | Identity summary object from search index. | [default to undefined] +**machineIdentity** | **(optional)** | Machine identity summary object when available. | [default to undefined] +**account** | **(optional)** | Account summary object. | [default to undefined] +**entitlement** | **(optional)** **EntitlementconnectionsearchhitentitlementV1** | | [default to undefined] +**source** | **(optional)** | Source summary object. | [default to undefined] +**state** | **(optional)** | Connection state object. | [default to undefined] +**jit** | **(optional)** | JIT timestamps for lifecycle events. | [default to undefined] +**standalone** | **(optional)** **boolean** | Indicates whether the connection is marked as standalone. | [default to false] +**type** | **(optional)** **string** | Connection type classification. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhitentitlement.md b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhitentitlement.md new file mode 100644 index 00000000..db2c2613 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Entitlementconnectionsearchhitentitlement.md @@ -0,0 +1,26 @@ +--- +id: v1-entitlementconnectionsearchhitentitlement-v1 +title: EntitlementconnectionsearchhitentitlementV1 +pagination_label: EntitlementconnectionsearchhitentitlementV1 +sidebar_label: EntitlementconnectionsearchhitentitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionsearchhitentitlementV1', 'v1EntitlementconnectionsearchhitentitlementV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnectionsearchhitentitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionsearchhitentitlementV1', 'v1EntitlementconnectionsearchhitentitlementV1'] +--- + +# EntitlementconnectionsearchhitentitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Entitlement identifier. | [default to undefined] +**name** | **(optional)** **string** | Entitlement name. | [default to undefined] +**displayName** | **(optional)** **string** | Human-readable entitlement label. | [default to undefined] +**description** | **(optional)** **string** | Entitlement description. | [default to undefined] +**attribute** | **(optional)** **string** | Source attribute carrying entitlement values. | [default to undefined] +**value** | **(optional)** **string** | Source entitlement value. | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | Source schema object type for the entitlement. | [default to undefined] +**privilegeLevel** | **(optional)** **EntitlementconnectionsearchhitentitlementPrivilegeLevelV1** | | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/EntitlementconnectionsearchhitentitlementPrivilegeLevel.md b/sdk-output/entitlement_connections/docs/Models/EntitlementconnectionsearchhitentitlementPrivilegeLevel.md new file mode 100644 index 00000000..8690a893 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/EntitlementconnectionsearchhitentitlementPrivilegeLevel.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementconnectionsearchhitentitlement-privilege-level-v1 +title: EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 +pagination_label: EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 +sidebar_label: EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementconnectionsearchhitentitlementPrivilegeLevelV1', 'v1EntitlementconnectionsearchhitentitlementPrivilegeLevelV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/entitlementconnectionsearchhitentitlement-privilege-level-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementconnectionsearchhitentitlementPrivilegeLevelV1', 'v1EntitlementconnectionsearchhitentitlementPrivilegeLevelV1'] +--- + +# EntitlementconnectionsearchhitentitlementPrivilegeLevelV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**effective** | **(optional)** **string** | Effective privilege level. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Errormessagedto.md b/sdk-output/entitlement_connections/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..16869065 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Errorresponsedto.md b/sdk-output/entitlement_connections/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cce9073a --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Index.md b/sdk-output/entitlement_connections/docs/Models/Index.md new file mode 100644 index 00000000..280463d9 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: entitlement_connections-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: entitlement_connections-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'entitlement_connections', 'models'] +slug: /tools/sdk/typescript/entitlement_connections/models +tags: ['SDK', 'Software Development Kit', 'entitlement_connections', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/entitlement_connections/docs/Models/Jsonpatchoperation.md b/sdk-output/entitlement_connections/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..497ceecd --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/JsonpatchoperationValue.md b/sdk-output/entitlement_connections/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..65883cf5 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1401Response.md b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1401Response.md new file mode 100644 index 00000000..435862a3 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-entitlement-connections-v1401-response-v1 +title: ListEntitlementConnectionsV1401ResponseV1 +pagination_label: ListEntitlementConnectionsV1401ResponseV1 +sidebar_label: ListEntitlementConnectionsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListEntitlementConnectionsV1401ResponseV1', 'v1ListEntitlementConnectionsV1401ResponseV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/list-entitlement-connections-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListEntitlementConnectionsV1401ResponseV1', 'v1ListEntitlementConnectionsV1401ResponseV1'] +--- + +# ListEntitlementConnectionsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1412Response.md b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1412Response.md new file mode 100644 index 00000000..1948e697 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1412Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-entitlement-connections-v1412-response-v1 +title: ListEntitlementConnectionsV1412ResponseV1 +pagination_label: ListEntitlementConnectionsV1412ResponseV1 +sidebar_label: ListEntitlementConnectionsV1412ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListEntitlementConnectionsV1412ResponseV1', 'v1ListEntitlementConnectionsV1412ResponseV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/list-entitlement-connections-v1412-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListEntitlementConnectionsV1412ResponseV1', 'v1ListEntitlementConnectionsV1412ResponseV1'] +--- + +# ListEntitlementConnectionsV1412ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1429Response.md b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1429Response.md new file mode 100644 index 00000000..2be08614 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/ListEntitlementConnectionsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-entitlement-connections-v1429-response-v1 +title: ListEntitlementConnectionsV1429ResponseV1 +pagination_label: ListEntitlementConnectionsV1429ResponseV1 +sidebar_label: ListEntitlementConnectionsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListEntitlementConnectionsV1429ResponseV1', 'v1ListEntitlementConnectionsV1429ResponseV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/list-entitlement-connections-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListEntitlementConnectionsV1429ResponseV1', 'v1ListEntitlementConnectionsV1429ResponseV1'] +--- + +# ListEntitlementConnectionsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/entitlement_connections/docs/Models/Localeorigin.md b/sdk-output/entitlement_connections/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d0f0e115 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/entitlement_connections/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/entitlement_connections/docs/Models/README.md b/sdk-output/entitlement_connections/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/entitlement_connections/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/entitlements/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/entitlements/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..fb9dbd30 --- /dev/null +++ b/sdk-output/entitlements/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,227 @@ +- path: /entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#create-access-model-metadata-for-entitlement-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808c74ff913f0175097daa9d59cd'; // string | The entitlement id. (default to undefined) + const attributeKey: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const attributeValue: string = 'public'; // string | Technical name of the Attribute Value. (default to undefined) + const result = await apiInstance.createAccessModelMetadataForEntitlementV1(id, attributeKey, attributeValue); + console.log(result); +- path: /entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#delete-access-model-metadata-from-entitlement-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808c74ff913f0175097daa9d59cd'; // string | The entitlement id. (default to undefined) + const attributeKey: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const attributeValue: string = 'public'; // string | Technical name of the Attribute Value. (default to undefined) + const result = await apiInstance.deleteAccessModelMetadataFromEntitlementV1(id, attributeKey, attributeValue); + console.log(result); +- path: /entitlements/v1/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#get-entitlement-request-config-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808874ff91550175097daaec161c'; // string | Entitlement Id (default to undefined) + const result = await apiInstance.getEntitlementRequestConfigV1(id); + console.log(result); +- path: /entitlements/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#get-entitlement-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808874ff91550175097daaec161c'; // string | The entitlement ID (default to undefined) + const result = await apiInstance.getEntitlementV1(id); + console.log(result); +- path: /entitlements/v1/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#import-entitlements-by-source-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source Id (default to undefined) + const csvFile: File = BINARY_DATA_HERE; // File | The CSV file containing the source entitlements to aggregate. (optional) (default to undefined) + const result = await apiInstance.importEntitlementsBySourceV1(id); + console.log(result); +- path: /entitlements/v1/{id}/children + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#list-entitlement-children-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808874ff91550175097daaec161c'; // string | Entitlement Id (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const sorters: string = 'name,id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) (default to undefined) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) (default to undefined) + const result = await apiInstance.listEntitlementChildrenV1(id); + console.log(result); +- path: /entitlements/v1/{id}/parents + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#list-entitlement-parents-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808c74ff913f0175097daa9d59cd'; // string | Entitlement Id (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const sorters: string = 'name,id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) (default to undefined) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) (default to undefined) + const result = await apiInstance.listEntitlementParentsV1(id); + console.log(result); +- path: /entitlements/v1/account/{accountId}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#list-entitlements-by-account-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const accountId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The account ID to get entitlements for (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const sorters: string = 'name,id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) (default to undefined) + const result = await apiInstance.listEntitlementsByAccountV1(accountId); + console.log(result); +- path: /entitlements/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#list-entitlements-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const segmentedForIdentity: string = 'e554098913544630b5985e9042f5e44b'; // string | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. (optional) (default to undefined) + const forSegmentIds: string = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649'; // string | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. (optional) (default to undefined) + const includeUnsegmented: boolean = true; // boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to true) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const searchAfter: string = 'Account Payable,2c91808375d8e80a0175e1f88a575221'; // string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) (default to undefined) + const sorters: string = 'name,id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) (default to undefined) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) (default to undefined) + const result = await apiInstance.listEntitlementsV1(); + console.log(result); +- path: /entitlements/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#patch-entitlement-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the entitlement to patch (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]; // Array | (optional) + const result = await apiInstance.patchEntitlementV1(id); + console.log(result); +- path: /entitlements/v1/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#put-entitlement-request-config-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | Entitlement ID (default to undefined) + const entitlementrequestconfigV1: EntitlementrequestconfigV1 = ; // EntitlementrequestconfigV1 | + const result = await apiInstance.putEntitlementRequestConfigV1(id, entitlementrequestconfigV1); + console.log(result); +- path: /entitlements/v1/reset/sources/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#reset-source-entitlements-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | ID of source for the entitlement reset (default to undefined) + const result = await apiInstance.resetSourceEntitlementsV1(id); + console.log(result); +- path: /entitlements/v1/bulk-update + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/entitlements/methods/entitlements#update-entitlements-in-bulk-v1 + source: | + import { EntitlementsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new EntitlementsV1Api(configuration); + const entitlementbulkupdaterequestV1: EntitlementbulkupdaterequestV1 = ; // EntitlementbulkupdaterequestV1 | + const result = await apiInstance.updateEntitlementsInBulkV1(entitlementbulkupdaterequestV1); + console.log(result); diff --git a/sdk-output/entitlements/docs/Methods/EntitlementsV1Api.md b/sdk-output/entitlements/docs/Methods/EntitlementsV1Api.md new file mode 100644 index 00000000..112b88b2 --- /dev/null +++ b/sdk-output/entitlements/docs/Methods/EntitlementsV1Api.md @@ -0,0 +1,614 @@ +--- +id: v1-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlements', 'v1Entitlements'] +slug: /tools/sdk/typescript/entitlements/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'v1Entitlements'] +--- + +# EntitlementsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-access-model-metadata-for-entitlement-v1**](#create-access-model-metadata-for-entitlement-v1) | **POST** `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**delete-access-model-metadata-from-entitlement-v1**](#delete-access-model-metadata-from-entitlement-v1) | **DELETE** `/entitlements/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**get-entitlement-request-config-v1**](#get-entitlement-request-config-v1) | **GET** `/entitlements/v1/{id}/entitlement-request-config` | Get entitlement request config +[**get-entitlement-v1**](#get-entitlement-v1) | **GET** `/entitlements/v1/{id}` | Get an entitlement +[**import-entitlements-by-source-v1**](#import-entitlements-by-source-v1) | **POST** `/entitlements/v1/aggregate/sources/{id}` | Aggregate entitlements +[**list-entitlement-children-v1**](#list-entitlement-children-v1) | **GET** `/entitlements/v1/{id}/children` | List of entitlements children +[**list-entitlement-parents-v1**](#list-entitlement-parents-v1) | **GET** `/entitlements/v1/{id}/parents` | List of entitlements parents +[**list-entitlements-by-account-v1**](#list-entitlements-by-account-v1) | **GET** `/entitlements/v1/account/{accountId}/entitlements` | Get entitlements for an account +[**list-entitlements-v1**](#list-entitlements-v1) | **GET** `/entitlements/v1` | Gets a list of entitlements. +[**patch-entitlement-v1**](#patch-entitlement-v1) | **PATCH** `/entitlements/v1/{id}` | Patch an entitlement +[**put-entitlement-request-config-v1**](#put-entitlement-request-config-v1) | **PUT** `/entitlements/v1/{id}/entitlement-request-config` | Replace entitlement request config +[**reset-source-entitlements-v1**](#reset-source-entitlements-v1) | **POST** `/entitlements/v1/reset/sources/{id}` | Reset source entitlements +[**update-entitlements-in-bulk-v1**](#update-entitlements-in-bulk-v1) | **POST** `/entitlements/v1/bulk-update` | Bulk update an entitlement list + + +## create-access-model-metadata-for-entitlement-v1 +Add metadata to an entitlement. +Add single Access Model Metadata to an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-access-model-metadata-for-entitlement-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The entitlement id. | [default to undefined] +**attributeKey** | **string** | Technical name of the Attribute. | [default to undefined] +**attributeValue** | **string** | Technical name of the Attribute Value. | [default to undefined] + +### Return type + +**EntitlementV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808c74ff913f0175097daa9d59cd; // The entitlement id. +const attributeKey: string = iscPrivacy; // Technical name of the Attribute. +const attributeValue: string = public; // Technical name of the Attribute Value. +const result = await apiInstance.createAccessModelMetadataForEntitlementV1(id, attributeKey, attributeValue); +console.log(result); +``` + +[[Back to top]](#) + +## delete-access-model-metadata-from-entitlement-v1 +Remove metadata from an entitlement. +Remove single Access Model Metadata from an entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-access-model-metadata-from-entitlement-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The entitlement id. | [default to undefined] +**attributeKey** | **string** | Technical name of the Attribute. | [default to undefined] +**attributeValue** | **string** | Technical name of the Attribute Value. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808c74ff913f0175097daa9d59cd; // The entitlement id. +const attributeKey: string = iscPrivacy; // Technical name of the Attribute. +const attributeValue: string = public; // Technical name of the Attribute Value. +const result = await apiInstance.deleteAccessModelMetadataFromEntitlementV1(id, attributeKey, attributeValue); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-request-config-v1 +Get entitlement request config +This API returns the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-request-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Entitlement Id | [default to undefined] + +### Return type + +**EntitlementrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808874ff91550175097daaec161c; // Entitlement Id +const result = await apiInstance.getEntitlementRequestConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-v1 +Get an entitlement +This API returns an entitlement by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The entitlement ID | [default to undefined] + +### Return type + +**Entitlementv2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808874ff91550175097daaec161c; // The entitlement ID +const result = await apiInstance.getEntitlementV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-entitlements-by-source-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +Aggregate entitlements +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-entitlements-by-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id | [default to undefined] +**csvFile** | **File** | The CSV file containing the source entitlements to aggregate. | [optional] [default to undefined] + +### Return type + +**LoadentitlementtaskV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Source Id +const csvFile: File = BINARY_DATA_HERE; // The CSV file containing the source entitlements to aggregate. (optional) +const result = await apiInstance.importEntitlementsBySourceV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlement-children-v1 +List of entitlements children +This API returns a list of all child entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlement-children-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Entitlement Id | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808874ff91550175097daaec161c; // Entitlement Id +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) +const result = await apiInstance.listEntitlementChildrenV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlement-parents-v1 +List of entitlements parents +This API returns a list of all parent entitlements of a given entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlement-parents-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Entitlement Id | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808c74ff913f0175097daa9d59cd; // Entitlement Id +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) +const result = await apiInstance.listEntitlementParentsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlements-by-account-v1 +Get entitlements for an account +This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlements-by-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accountId** | **string** | The account ID to get entitlements for | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const accountId: string = ef38f94347e94562b5bb8424a56397d8; // The account ID to get entitlements for +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +const result = await apiInstance.listEntitlementsByAccountV1(accountId); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlements-v1 +Gets a list of entitlements. +This API returns a list of entitlements. Any authenticated token can call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentedForIdentity** | **string** | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. | [optional] [default to undefined] +**forSegmentIds** | **string** | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. | [optional] [default to undefined] +**includeUnsegmented** | **boolean** | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. | [optional] [default to true] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**searchAfter** | **string** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const segmentedForIdentity: string = e554098913544630b5985e9042f5e44b; // If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. (optional) +const forSegmentIds: string = 041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649; // If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. (optional) +const includeUnsegmented: boolean = true; // Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional) +const sorters: string = name,id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq* (optional) +const result = await apiInstance.listEntitlementsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-entitlement-v1 +Patch an entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-entitlement-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the entitlement to patch | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | [optional] + +### Return type + +**Entitlementv2V1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the entitlement to patch +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/segments/-","value":"f7b1b8a3-5fed-4fd4-ad29-82014e137e19"}]; // (optional) +const result = await apiInstance.patchEntitlementV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## put-entitlement-request-config-v1 +Replace entitlement request config +This API replaces the entitlement request config for a specified entitlement. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-entitlement-request-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Entitlement ID | [default to undefined] +**entitlementrequestconfigV1** | **EntitlementrequestconfigV1** | | + +### Return type + +**EntitlementrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // Entitlement ID +const entitlementrequestconfigV1: EntitlementrequestconfigV1 = ; // +const result = await apiInstance.putEntitlementRequestConfigV1(id, entitlementrequestconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## reset-source-entitlements-v1 +Reset source entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reset-source-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of source for the entitlement reset | [default to undefined] + +### Return type + +**EntitlementsourceresetbasereferencedtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // ID of source for the entitlement reset +const result = await apiInstance.resetSourceEntitlementsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-entitlements-in-bulk-v1 +Bulk update an entitlement list +This API applies an update to every entitlement of the list. + + +The number of entitlements to update is limited to 50 items maximum. + + +The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +examples of allowed operations : +`**{ "op": "replace", "path": "/requestable","value": boolean }**` +`**{ "op": "replace", "path": "/privilegeOverride/level","value": string }**` + +A token with ORG_ADMIN or API authority is required to call this API. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-entitlements-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementbulkupdaterequestV1** | **EntitlementbulkupdaterequestV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { EntitlementsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new EntitlementsV1Api(configuration); +const entitlementbulkupdaterequestV1: EntitlementbulkupdaterequestV1 = ; // +const result = await apiInstance.updateEntitlementsInBulkV1(entitlementbulkupdaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/entitlements/docs/Methods/Index.md b/sdk-output/entitlements/docs/Methods/Index.md new file mode 100644 index 00000000..b2de32d1 --- /dev/null +++ b/sdk-output/entitlements/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: entitlements-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: entitlements-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'entitlements', 'methods'] +slug: /tools/sdk/typescript/entitlements/methods +tags: ['SDK', 'Software Development Kit', 'entitlements', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/entitlements/docs/Models/Accessmodelmetadata.md b/sdk-output/entitlements/docs/Models/Accessmodelmetadata.md new file mode 100644 index 00000000..7b3f7dba --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Accessmodelmetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-accessmodelmetadata-v1 +title: AccessmodelmetadataV1 +pagination_label: AccessmodelmetadataV1 +sidebar_label: AccessmodelmetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +slug: /tools/sdk/typescript/entitlements/models/accessmodelmetadata-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +--- + +# AccessmodelmetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Unique identifier for the metadata type | [default to undefined] +**name** | **(optional)** **string** | Human readable name of the metadata type | [default to undefined] +**multiselect** | **(optional)** **boolean** | Allows selecting multiple values | [default to false] +**status** | **(optional)** **string** | The state of the metadata item | [default to undefined] +**type** | **(optional)** **string** | The type of the metadata item | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | The types of objects | [default to undefined] +**description** | **(optional)** **string** | Describes the metadata item | [default to undefined] +**values** | **(optional)** **Array<AccessmodelmetadataValuesInnerV1>** | The value to assign to the metadata item | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/AccessmodelmetadataValuesInner.md b/sdk-output/entitlements/docs/Models/AccessmodelmetadataValuesInner.md new file mode 100644 index 00000000..7ab365be --- /dev/null +++ b/sdk-output/entitlements/docs/Models/AccessmodelmetadataValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessmodelmetadata-values-inner-v1 +title: AccessmodelmetadataValuesInnerV1 +pagination_label: AccessmodelmetadataValuesInnerV1 +sidebar_label: AccessmodelmetadataValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +slug: /tools/sdk/typescript/entitlements/models/accessmodelmetadata-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +--- + +# AccessmodelmetadataValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The value to assign to the metdata item | [default to undefined] +**name** | **(optional)** **string** | Display name of the value | [default to undefined] +**status** | **(optional)** **string** | The status of the individual value | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Additionalownerref.md b/sdk-output/entitlements/docs/Models/Additionalownerref.md new file mode 100644 index 00000000..8375fe36 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Additionalownerref.md @@ -0,0 +1,21 @@ +--- +id: v1-additionalownerref-v1 +title: AdditionalownerrefV1 +pagination_label: AdditionalownerrefV1 +sidebar_label: AdditionalownerrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +slug: /tools/sdk/typescript/entitlements/models/additionalownerref-v1 +tags: ['SDK', 'Software Development Kit', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +--- + +# AdditionalownerrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity or governance group. | [default to undefined] +**name** | **(optional)** **string** | Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/ArrayInner.md b/sdk-output/entitlements/docs/Models/ArrayInner.md new file mode 100644 index 00000000..ce67341c --- /dev/null +++ b/sdk-output/entitlements/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/entitlements/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/entitlements/docs/Models/Entitlement.md b/sdk-output/entitlements/docs/Models/Entitlement.md new file mode 100644 index 00000000..835835df --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlement.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlement-v1 +title: EntitlementV1 +pagination_label: EntitlementV1 +sidebar_label: EntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementV1', 'v1EntitlementV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementV1', 'v1EntitlementV1'] +--- + +# EntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | True if the entitlement is privileged | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **Entitlementv2OwnerV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **Entitlementv2AccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **EntitlementSourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/EntitlementSource.md b/sdk-output/entitlements/docs/Models/EntitlementSource.md new file mode 100644 index 00000000..e25416f0 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/EntitlementSource.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-source-v1 +title: EntitlementSourceV1 +pagination_label: EntitlementSourceV1 +sidebar_label: EntitlementSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlement-source-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +--- + +# EntitlementSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementaccessrequestconfig.md b/sdk-output/entitlements/docs/Models/Entitlementaccessrequestconfig.md new file mode 100644 index 00000000..e0ed5ce9 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementaccessrequestconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-entitlementaccessrequestconfig-v1 +title: EntitlementaccessrequestconfigV1 +pagination_label: EntitlementaccessrequestconfigV1 +sidebar_label: EntitlementaccessrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementaccessrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +--- + +# EntitlementaccessrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] +**requestCommentRequired** | **(optional)** **boolean** | If the requester must provide a comment during access request. | [default to false] +**denialCommentRequired** | **(optional)** **boolean** | If the reviewer must provide a comment when denying the access request. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Is Reauthorization Required | [default to false] +**requireEndDate** | **(optional)** **boolean** | If true, then remove date or sunset date is required in access request of the entitlement. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **EntitlementaccessrequestconfigMaxPermittedAccessDurationV1** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md b/sdk-output/entitlements/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md new file mode 100644 index 00000000..ef21702d --- /dev/null +++ b/sdk-output/entitlements/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementaccessrequestconfig-max-permitted-access-duration-v1 +title: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +pagination_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementaccessrequestconfig-max-permitted-access-duration-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +--- + +# EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value of the duration. | [default to undefined] +**timeUnit** | **(optional)** **string** | The time unit for the duration. | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementapprovalscheme.md b/sdk-output/entitlements/docs/Models/Entitlementapprovalscheme.md new file mode 100644 index 00000000..6bb36a7e --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementapprovalscheme.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementapprovalscheme-v1 +title: EntitlementapprovalschemeV1 +pagination_label: EntitlementapprovalschemeV1 +sidebar_label: EntitlementapprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementapprovalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +--- + +# EntitlementapprovalschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementbulkupdaterequest.md b/sdk-output/entitlements/docs/Models/Entitlementbulkupdaterequest.md new file mode 100644 index 00000000..01f9f52f --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementbulkupdaterequest.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementbulkupdaterequest-v1 +title: EntitlementbulkupdaterequestV1 +pagination_label: EntitlementbulkupdaterequestV1 +sidebar_label: EntitlementbulkupdaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementbulkupdaterequestV1', 'v1EntitlementbulkupdaterequestV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementbulkupdaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementbulkupdaterequestV1', 'v1EntitlementbulkupdaterequestV1'] +--- + +# EntitlementbulkupdaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementIds** | **Array<string>** | List of entitlement ids to update | [default to undefined] +**jsonPatch** | **Array<JsonpatchoperationV1>** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementprivilegelevel.md b/sdk-output/entitlements/docs/Models/Entitlementprivilegelevel.md new file mode 100644 index 00000000..2abe3aeb --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementprivilegelevel.md @@ -0,0 +1,23 @@ +--- +id: v1-entitlementprivilegelevel-v1 +title: EntitlementprivilegelevelV1 +pagination_label: EntitlementprivilegelevelV1 +sidebar_label: EntitlementprivilegelevelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementprivilegelevelV1', 'v1EntitlementprivilegelevelV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementprivilegelevel-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementprivilegelevelV1', 'v1EntitlementprivilegelevelV1'] +--- + +# EntitlementprivilegelevelV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**direct** | **(optional)** **string** | Direct privilege level assigned to the entitlement | [default to undefined] +**setBy** | **(optional)** **string** | User or process that set the privilege level | [default to undefined] +**setByType** | **(optional)** **string** | Method by which the privilege level was set | [default to undefined] +**inherited** | **(optional)** **string** | Inherited privilege level on the entitlement, if any | [default to undefined] +**effective** | **(optional)** **string** | Effective privilege level assigned to the entitlement | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementrequestconfig.md b/sdk-output/entitlements/docs/Models/Entitlementrequestconfig.md new file mode 100644 index 00000000..65710815 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementrequestconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrequestconfig-v1 +title: EntitlementrequestconfigV1 +pagination_label: EntitlementrequestconfigV1 +sidebar_label: EntitlementrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrequestconfigV1', 'v1EntitlementrequestconfigV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrequestconfigV1', 'v1EntitlementrequestconfigV1'] +--- + +# EntitlementrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestConfig** | **(optional)** **EntitlementaccessrequestconfigV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **EntitlementrevocationrequestconfigV1** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementrevocationrequestconfig.md b/sdk-output/entitlements/docs/Models/Entitlementrevocationrequestconfig.md new file mode 100644 index 00000000..04618a81 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementrevocationrequestconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementrevocationrequestconfig-v1 +title: EntitlementrevocationrequestconfigV1 +pagination_label: EntitlementrevocationrequestconfigV1 +sidebar_label: EntitlementrevocationrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementrevocationrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +--- + +# EntitlementrevocationrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementsourceresetbasereferencedto.md b/sdk-output/entitlements/docs/Models/Entitlementsourceresetbasereferencedto.md new file mode 100644 index 00000000..78d69659 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementsourceresetbasereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementsourceresetbasereferencedto-v1 +title: EntitlementsourceresetbasereferencedtoV1 +pagination_label: EntitlementsourceresetbasereferencedtoV1 +sidebar_label: EntitlementsourceresetbasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementsourceresetbasereferencedtoV1', 'v1EntitlementsourceresetbasereferencedtoV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementsourceresetbasereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementsourceresetbasereferencedtoV1', 'v1EntitlementsourceresetbasereferencedtoV1'] +--- + +# EntitlementsourceresetbasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The DTO type | [default to undefined] +**id** | **(optional)** **string** | The task ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementv2.md b/sdk-output/entitlements/docs/Models/Entitlementv2.md new file mode 100644 index 00000000..34453bad --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementv2.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlementv2-v1 +title: Entitlementv2V1 +pagination_label: Entitlementv2V1 +sidebar_label: Entitlementv2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementv2V1', 'v1Entitlementv2V1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementv2-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementv2V1', 'v1Entitlementv2V1'] +--- + +# Entitlementv2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privilegeLevel** | **(optional)** **Entitlementv2PrivilegeLevelV1** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | List of tags assigned to the entitlement | [default to undefined] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **Entitlementv2OwnerV1** | | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **Entitlementv2AccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **Entitlementv2SourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementv2AccessModelMetadata.md b/sdk-output/entitlements/docs/Models/Entitlementv2AccessModelMetadata.md new file mode 100644 index 00000000..b906ccf5 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementv2AccessModelMetadata.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementv2-access-model-metadata-v1 +title: Entitlementv2AccessModelMetadataV1 +pagination_label: Entitlementv2AccessModelMetadataV1 +sidebar_label: Entitlementv2AccessModelMetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementv2AccessModelMetadataV1', 'v1Entitlementv2AccessModelMetadataV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementv2-access-model-metadata-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementv2AccessModelMetadataV1', 'v1Entitlementv2AccessModelMetadataV1'] +--- + +# Entitlementv2AccessModelMetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AccessmodelmetadataV1>** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementv2Owner.md b/sdk-output/entitlements/docs/Models/Entitlementv2Owner.md new file mode 100644 index 00000000..8ca5271c --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementv2Owner.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementv2-owner-v1 +title: Entitlementv2OwnerV1 +pagination_label: Entitlementv2OwnerV1 +sidebar_label: Entitlementv2OwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementv2OwnerV1', 'v1Entitlementv2OwnerV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementv2-owner-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementv2OwnerV1', 'v1Entitlementv2OwnerV1'] +--- + +# Entitlementv2OwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | The type of object | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementv2PrivilegeLevel.md b/sdk-output/entitlements/docs/Models/Entitlementv2PrivilegeLevel.md new file mode 100644 index 00000000..5e1a8d81 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementv2PrivilegeLevel.md @@ -0,0 +1,23 @@ +--- +id: v1-entitlementv2-privilege-level-v1 +title: Entitlementv2PrivilegeLevelV1 +pagination_label: Entitlementv2PrivilegeLevelV1 +sidebar_label: Entitlementv2PrivilegeLevelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementv2PrivilegeLevelV1', 'v1Entitlementv2PrivilegeLevelV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementv2-privilege-level-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementv2PrivilegeLevelV1', 'v1Entitlementv2PrivilegeLevelV1'] +--- + +# Entitlementv2PrivilegeLevelV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**direct** | **(optional)** **string** | Direct privilege level assigned to the entitlement | [default to undefined] +**setBy** | **(optional)** **string** | User or process that set the privilege level | [default to undefined] +**setByType** | **(optional)** **string** | Method by which the privilege level was set | [default to undefined] +**inherited** | **(optional)** **string** | Inherited privilege level on the entitlement, if any | [default to undefined] +**effective** | **(optional)** **string** | Effective privilege level assigned to the entitlement | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Entitlementv2Source.md b/sdk-output/entitlements/docs/Models/Entitlementv2Source.md new file mode 100644 index 00000000..8b07d9a0 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Entitlementv2Source.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementv2-source-v1 +title: Entitlementv2SourceV1 +pagination_label: Entitlementv2SourceV1 +sidebar_label: Entitlementv2SourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Entitlementv2SourceV1', 'v1Entitlementv2SourceV1'] +slug: /tools/sdk/typescript/entitlements/models/entitlementv2-source-v1 +tags: ['SDK', 'Software Development Kit', 'Entitlementv2SourceV1', 'v1Entitlementv2SourceV1'] +--- + +# Entitlementv2SourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Errormessagedto.md b/sdk-output/entitlements/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..d248fc25 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/entitlements/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Errorresponsedto.md b/sdk-output/entitlements/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..3c90433c --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/entitlements/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/ImportEntitlementsBySourceV1Request.md b/sdk-output/entitlements/docs/Models/ImportEntitlementsBySourceV1Request.md new file mode 100644 index 00000000..5ff2c9a6 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/ImportEntitlementsBySourceV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-import-entitlements-by-source-v1-request-v1 +title: ImportEntitlementsBySourceV1RequestV1 +pagination_label: ImportEntitlementsBySourceV1RequestV1 +sidebar_label: ImportEntitlementsBySourceV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportEntitlementsBySourceV1RequestV1', 'v1ImportEntitlementsBySourceV1RequestV1'] +slug: /tools/sdk/typescript/entitlements/models/import-entitlements-by-source-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceV1RequestV1', 'v1ImportEntitlementsBySourceV1RequestV1'] +--- + +# ImportEntitlementsBySourceV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**csvFile** | **(optional)** **File** | The CSV file containing the source entitlements to aggregate. | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Index.md b/sdk-output/entitlements/docs/Models/Index.md new file mode 100644 index 00000000..0d4ef01e --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: entitlements-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: entitlements-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'entitlements', 'models'] +slug: /tools/sdk/typescript/entitlements/models +tags: ['SDK', 'Software Development Kit', 'entitlements', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/entitlements/docs/Models/Jsonpatchoperation.md b/sdk-output/entitlements/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..9ee3c071 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/entitlements/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/JsonpatchoperationValue.md b/sdk-output/entitlements/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..25d180e7 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/entitlements/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/entitlements/docs/Models/ListEntitlementsV1401Response.md b/sdk-output/entitlements/docs/Models/ListEntitlementsV1401Response.md new file mode 100644 index 00000000..4dcfd179 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/ListEntitlementsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-entitlements-v1401-response-v1 +title: ListEntitlementsV1401ResponseV1 +pagination_label: ListEntitlementsV1401ResponseV1 +sidebar_label: ListEntitlementsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListEntitlementsV1401ResponseV1', 'v1ListEntitlementsV1401ResponseV1'] +slug: /tools/sdk/typescript/entitlements/models/list-entitlements-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListEntitlementsV1401ResponseV1', 'v1ListEntitlementsV1401ResponseV1'] +--- + +# ListEntitlementsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/ListEntitlementsV1429Response.md b/sdk-output/entitlements/docs/Models/ListEntitlementsV1429Response.md new file mode 100644 index 00000000..bcdb1c39 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/ListEntitlementsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-entitlements-v1429-response-v1 +title: ListEntitlementsV1429ResponseV1 +pagination_label: ListEntitlementsV1429ResponseV1 +sidebar_label: ListEntitlementsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListEntitlementsV1429ResponseV1', 'v1ListEntitlementsV1429ResponseV1'] +slug: /tools/sdk/typescript/entitlements/models/list-entitlements-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListEntitlementsV1429ResponseV1', 'v1ListEntitlementsV1429ResponseV1'] +--- + +# ListEntitlementsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Loadentitlementtask.md b/sdk-output/entitlements/docs/Models/Loadentitlementtask.md new file mode 100644 index 00000000..47aac196 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Loadentitlementtask.md @@ -0,0 +1,25 @@ +--- +id: v1-loadentitlementtask-v1 +title: LoadentitlementtaskV1 +pagination_label: LoadentitlementtaskV1 +sidebar_label: LoadentitlementtaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadentitlementtaskV1', 'v1LoadentitlementtaskV1'] +slug: /tools/sdk/typescript/entitlements/models/loadentitlementtask-v1 +tags: ['SDK', 'Software Development Kit', 'LoadentitlementtaskV1', 'v1LoadentitlementtaskV1'] +--- + +# LoadentitlementtaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the task this taskStatus represents | [default to undefined] +**type** | **(optional)** **string** | Type of task this task represents | [default to undefined] +**uniqueName** | **(optional)** **string** | The name of the task | [default to undefined] +**description** | **(optional)** **string** | The description of the task | [default to undefined] +**launcher** | **(optional)** **string** | The user who initiated the task | [default to undefined] +**created** | **(optional)** **string** | The creation date of the task | [default to undefined] +**returns** | **(optional)** **Array<LoadentitlementtaskReturnsInnerV1>** | Return values from the task | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/LoadentitlementtaskReturnsInner.md b/sdk-output/entitlements/docs/Models/LoadentitlementtaskReturnsInner.md new file mode 100644 index 00000000..4e08e992 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/LoadentitlementtaskReturnsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-loadentitlementtask-returns-inner-v1 +title: LoadentitlementtaskReturnsInnerV1 +pagination_label: LoadentitlementtaskReturnsInnerV1 +sidebar_label: LoadentitlementtaskReturnsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadentitlementtaskReturnsInnerV1', 'v1LoadentitlementtaskReturnsInnerV1'] +slug: /tools/sdk/typescript/entitlements/models/loadentitlementtask-returns-inner-v1 +tags: ['SDK', 'Software Development Kit', 'LoadentitlementtaskReturnsInnerV1', 'v1LoadentitlementtaskReturnsInnerV1'] +--- + +# LoadentitlementtaskReturnsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayLabel** | **(optional)** **string** | The display label for the return value | [default to undefined] +**attributeName** | **(optional)** **string** | The attribute name for the return value | [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/Localeorigin.md b/sdk-output/entitlements/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dc7256db --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/entitlements/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/entitlements/docs/Models/Permissiondto.md b/sdk-output/entitlements/docs/Models/Permissiondto.md new file mode 100644 index 00000000..f66ba3e9 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/entitlements/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/entitlements/docs/Models/README.md b/sdk-output/entitlements/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/entitlements/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/global_tenant_security_settings/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/global_tenant_security_settings/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..b7e1508b --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,131 @@ +- path: /auth-org/v1/network-config + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#create-auth-org-network-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const networkconfigurationV1: NetworkconfigurationV1 = ; // NetworkconfigurationV1 | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + const result = await apiInstance.createAuthOrgNetworkConfigV1(networkconfigurationV1); + console.log(result); +- path: /auth-org/v1/lockout-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#get-auth-org-lockout-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const result = await apiInstance.getAuthOrgLockoutConfigV1(); + console.log(result); +- path: /auth-org/v1/network-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#get-auth-org-network-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const result = await apiInstance.getAuthOrgNetworkConfigV1(); + console.log(result); +- path: /auth-org/v1/service-provider-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#get-auth-org-service-provider-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const result = await apiInstance.getAuthOrgServiceProviderConfigV1(); + console.log(result); +- path: /auth-org/v1/session-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#get-auth-org-session-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const result = await apiInstance.getAuthOrgSessionConfigV1(); + console.log(result); +- path: /auth-org/v1/lockout-config + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#patch-auth-org-lockout-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/maximumAttempts","value":"7,"},{"op":"add","path":"/lockoutDuration","value":35}]; // Array | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + const result = await apiInstance.patchAuthOrgLockoutConfigV1(jsonpatchoperationV1); + console.log(result); +- path: /auth-org/v1/network-config + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#patch-auth-org-network-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/whitelisted","value":"false,"},{"op":"add","path":"/geolocation","value":["AF","HN","ES"]}]; // Array | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + const result = await apiInstance.patchAuthOrgNetworkConfigV1(jsonpatchoperationV1); + console.log(result); +- path: /auth-org/v1/service-provider-config + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#patch-auth-org-service-provider-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/enabled","value":"true,"},{"op":"add","path":"/federationProtocolDetails/0/jitConfiguration","value":{"enabled":true,"sourceId":"2c9180857377ed2901739c12a2da5ac8","sourceAttributeMappings":{"firstName":"okta.firstName","lastName":"okta.lastName","email":"okta.email","employeeNumber":"okta.employeeNumber"}}}]; // Array | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + const result = await apiInstance.patchAuthOrgServiceProviderConfigV1(jsonpatchoperationV1); + console.log(result); +- path: /auth-org/v1/session-config + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings#patch-auth-org-session-config-v1 + source: | + import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/rememberMe","value":"true,"},{"op":"add","path":"/maxSessionTime","value":480}]; // Array | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + const result = await apiInstance.patchAuthOrgSessionConfigV1(jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsV1Api.md b/sdk-output/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsV1Api.md new file mode 100644 index 00000000..2ef7b55a --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsV1Api.md @@ -0,0 +1,359 @@ +--- +id: v1-global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GlobalTenantSecuritySettings', 'v1GlobalTenantSecuritySettings'] +slug: /tools/sdk/typescript/global_tenant_security_settings/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'v1GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettingsV1Api + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-auth-org-network-config-v1**](#create-auth-org-network-config-v1) | **POST** `/auth-org/v1/network-config` | Create security network configuration. +[**get-auth-org-lockout-config-v1**](#get-auth-org-lockout-config-v1) | **GET** `/auth-org/v1/lockout-config` | Get auth org lockout configuration. +[**get-auth-org-network-config-v1**](#get-auth-org-network-config-v1) | **GET** `/auth-org/v1/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config-v1**](#get-auth-org-service-provider-config-v1) | **GET** `/auth-org/v1/service-provider-config` | Get service provider configuration. +[**get-auth-org-session-config-v1**](#get-auth-org-session-config-v1) | **GET** `/auth-org/v1/session-config` | Get auth org session configuration. +[**patch-auth-org-lockout-config-v1**](#patch-auth-org-lockout-config-v1) | **PATCH** `/auth-org/v1/lockout-config` | Update auth org lockout configuration +[**patch-auth-org-network-config-v1**](#patch-auth-org-network-config-v1) | **PATCH** `/auth-org/v1/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config-v1**](#patch-auth-org-service-provider-config-v1) | **PATCH** `/auth-org/v1/service-provider-config` | Update service provider configuration +[**patch-auth-org-session-config-v1**](#patch-auth-org-session-config-v1) | **PATCH** `/auth-org/v1/session-config` | Update auth org session configuration + + +## create-auth-org-network-config-v1 +Create security network configuration. +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-auth-org-network-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**networkconfigurationV1** | **NetworkconfigurationV1** | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +**NetworkconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const networkconfigurationV1: NetworkconfigurationV1 = ; // Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. +const result = await apiInstance.createAuthOrgNetworkConfigV1(networkconfigurationV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-auth-org-lockout-config-v1 +Get auth org lockout configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auth-org-lockout-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**LockoutconfigurationV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const result = await apiInstance.getAuthOrgLockoutConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-auth-org-network-config-v1 +Get security network configuration. +This API returns the details of an org's network auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auth-org-network-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**NetworkconfigurationV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const result = await apiInstance.getAuthOrgNetworkConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-auth-org-service-provider-config-v1 +Get service provider configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auth-org-service-provider-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**ServiceproviderconfigurationV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const result = await apiInstance.getAuthOrgServiceProviderConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-auth-org-session-config-v1 +Get auth org session configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auth-org-session-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**SessionconfigurationV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const result = await apiInstance.getAuthOrgSessionConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-auth-org-lockout-config-v1 +Update auth org lockout configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-auth-org-lockout-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` | + +### Return type + +**LockoutconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/maximumAttempts","value":"7,"},{"op":"add","path":"/lockoutDuration","value":35}]; // A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` +const result = await apiInstance.patchAuthOrgLockoutConfigV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-auth-org-network-config-v1 +Update security network configuration. +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-auth-org-network-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. | + +### Return type + +**NetworkconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/whitelisted","value":"false,"},{"op":"add","path":"/geolocation","value":["AF","HN","ES"]}]; // A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. +const result = await apiInstance.patchAuthOrgNetworkConfigV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-auth-org-service-provider-config-v1 +Update service provider configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-auth-org-service-provider-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) | + +### Return type + +**ServiceproviderconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/enabled","value":"true,"},{"op":"add","path":"/federationProtocolDetails/0/jitConfiguration","value":{"enabled":true,"sourceId":"2c9180857377ed2901739c12a2da5ac8","sourceAttributeMappings":{"firstName":"okta.firstName","lastName":"okta.lastName","email":"okta.email","employeeNumber":"okta.employeeNumber"}}}]; // A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) +const result = await apiInstance.patchAuthOrgServiceProviderConfigV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-auth-org-session-config-v1 +Update auth org session configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-auth-org-session-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` | + +### Return type + +**SessionconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { GlobalTenantSecuritySettingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GlobalTenantSecuritySettingsV1Api(configuration); +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/rememberMe","value":"true,"},{"op":"add","path":"/maxSessionTime","value":480}]; // A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` +const result = await apiInstance.patchAuthOrgSessionConfigV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/global_tenant_security_settings/docs/Methods/Index.md b/sdk-output/global_tenant_security_settings/docs/Methods/Index.md new file mode 100644 index 00000000..77248200 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: global_tenant_security_settings-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: global_tenant_security_settings-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'global_tenant_security_settings', 'methods'] +slug: /tools/sdk/typescript/global_tenant_security_settings/methods +tags: ['SDK', 'Software Development Kit', 'global_tenant_security_settings', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/global_tenant_security_settings/docs/Models/ArrayInner.md b/sdk-output/global_tenant_security_settings/docs/Models/ArrayInner.md new file mode 100644 index 00000000..fc05c167 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Errormessagedto.md b/sdk-output/global_tenant_security_settings/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b138d19a --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Errorresponsedto.md b/sdk-output/global_tenant_security_settings/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..318c5a6b --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Federationprotocoldetails.md b/sdk-output/global_tenant_security_settings/docs/Models/Federationprotocoldetails.md new file mode 100644 index 00000000..8c3fe7d4 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Federationprotocoldetails.md @@ -0,0 +1,20 @@ +--- +id: v1-federationprotocoldetails-v1 +title: FederationprotocoldetailsV1 +pagination_label: FederationprotocoldetailsV1 +sidebar_label: FederationprotocoldetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FederationprotocoldetailsV1', 'v1FederationprotocoldetailsV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/federationprotocoldetails-v1 +tags: ['SDK', 'Software Development Kit', 'FederationprotocoldetailsV1', 'v1FederationprotocoldetailsV1'] +--- + +# FederationprotocoldetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **(optional)** **string** | Federation protocol role | [default to undefined] +**entityId** | **(optional)** **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1401Response.md b/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1401Response.md new file mode 100644 index 00000000..bca16b61 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auth-org-network-config-v1401-response-v1 +title: GetAuthOrgNetworkConfigV1401ResponseV1 +pagination_label: GetAuthOrgNetworkConfigV1401ResponseV1 +sidebar_label: GetAuthOrgNetworkConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAuthOrgNetworkConfigV1401ResponseV1', 'v1GetAuthOrgNetworkConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/get-auth-org-network-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAuthOrgNetworkConfigV1401ResponseV1', 'v1GetAuthOrgNetworkConfigV1401ResponseV1'] +--- + +# GetAuthOrgNetworkConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1429Response.md b/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1429Response.md new file mode 100644 index 00000000..9c9dd2fa --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/GetAuthOrgNetworkConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auth-org-network-config-v1429-response-v1 +title: GetAuthOrgNetworkConfigV1429ResponseV1 +pagination_label: GetAuthOrgNetworkConfigV1429ResponseV1 +sidebar_label: GetAuthOrgNetworkConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAuthOrgNetworkConfigV1429ResponseV1', 'v1GetAuthOrgNetworkConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/get-auth-org-network-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAuthOrgNetworkConfigV1429ResponseV1', 'v1GetAuthOrgNetworkConfigV1429ResponseV1'] +--- + +# GetAuthOrgNetworkConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Idpdetails.md b/sdk-output/global_tenant_security_settings/docs/Models/Idpdetails.md new file mode 100644 index 00000000..92da326d --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Idpdetails.md @@ -0,0 +1,32 @@ +--- +id: v1-idpdetails-v1 +title: IdpdetailsV1 +pagination_label: IdpdetailsV1 +sidebar_label: IdpdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdpdetailsV1', 'v1IdpdetailsV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/idpdetails-v1 +tags: ['SDK', 'Software Development Kit', 'IdpdetailsV1', 'v1IdpdetailsV1'] +--- + +# IdpdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **(optional)** **string** | Federation protocol role | [default to undefined] +**entityId** | **(optional)** **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [default to undefined] +**binding** | **(optional)** **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [default to undefined] +**authnContext** | **(optional)** **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [default to undefined] +**logoutUrl** | **(optional)** **string** | The IDP logout URL. Used with IDP configurations. | [default to undefined] +**includeAuthnContext** | **(optional)** **boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [default to false] +**nameId** | **(optional)** **string** | The name id format to use. Used with IDP configurations. | [default to undefined] +**jitConfiguration** | **(optional)** **JitconfigurationV1** | | [default to undefined] +**cert** | **(optional)** **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [default to undefined] +**loginUrlPost** | **(optional)** **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [default to undefined] +**loginUrlRedirect** | **(optional)** **string** | The IDP Redirect URL. Used with IDP configurations. | [default to undefined] +**mappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [default to undefined] +**certificateExpirationDate** | **(optional)** **string** | The expiration date extracted from the certificate. | [default to undefined] +**certificateName** | **(optional)** **string** | The name extracted from the certificate. | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Index.md b/sdk-output/global_tenant_security_settings/docs/Models/Index.md new file mode 100644 index 00000000..46f5e44f --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: global_tenant_security_settings-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: global_tenant_security_settings-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'global_tenant_security_settings', 'models'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models +tags: ['SDK', 'Software Development Kit', 'global_tenant_security_settings', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Jitconfiguration.md b/sdk-output/global_tenant_security_settings/docs/Models/Jitconfiguration.md new file mode 100644 index 00000000..bc655334 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Jitconfiguration.md @@ -0,0 +1,21 @@ +--- +id: v1-jitconfiguration-v1 +title: JitconfigurationV1 +pagination_label: JitconfigurationV1 +sidebar_label: JitconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitconfigurationV1', 'v1JitconfigurationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/jitconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'JitconfigurationV1', 'v1JitconfigurationV1'] +--- + +# JitconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | The indicator for just-in-time provisioning enabled | [default to false] +**sourceId** | **(optional)** **string** | the sourceId that mapped to just-in-time provisioning configuration | [default to undefined] +**sourceAttributeMappings** | **(optional)** | A mapping of identity profile attribute names to SAML assertion attribute names | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Jsonpatchoperation.md b/sdk-output/global_tenant_security_settings/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..22ebd31f --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/JsonpatchoperationValue.md b/sdk-output/global_tenant_security_settings/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..61481c7e --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Localeorigin.md b/sdk-output/global_tenant_security_settings/docs/Models/Localeorigin.md new file mode 100644 index 00000000..96b2fe27 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Lockoutconfiguration.md b/sdk-output/global_tenant_security_settings/docs/Models/Lockoutconfiguration.md new file mode 100644 index 00000000..ee0ca1f8 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Lockoutconfiguration.md @@ -0,0 +1,21 @@ +--- +id: v1-lockoutconfiguration-v1 +title: LockoutconfigurationV1 +pagination_label: LockoutconfigurationV1 +sidebar_label: LockoutconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LockoutconfigurationV1', 'v1LockoutconfigurationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/lockoutconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'LockoutconfigurationV1', 'v1LockoutconfigurationV1'] +--- + +# LockoutconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximumAttempts** | **(optional)** **number** | The maximum attempts allowed before lockout occurs. | [default to undefined] +**lockoutDuration** | **(optional)** **number** | The total time in minutes a user will be locked out. | [default to undefined] +**lockoutWindow** | **(optional)** **number** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Networkconfiguration.md b/sdk-output/global_tenant_security_settings/docs/Models/Networkconfiguration.md new file mode 100644 index 00000000..585a81ac --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Networkconfiguration.md @@ -0,0 +1,21 @@ +--- +id: v1-networkconfiguration-v1 +title: NetworkconfigurationV1 +pagination_label: NetworkconfigurationV1 +sidebar_label: NetworkconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NetworkconfigurationV1', 'v1NetworkconfigurationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/networkconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'NetworkconfigurationV1', 'v1NetworkconfigurationV1'] +--- + +# NetworkconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**range** | **(optional)** **Array<string>** | The collection of ip ranges. | [default to undefined] +**geolocation** | **(optional)** **Array<string>** | The collection of country codes. | [default to undefined] +**whitelisted** | **(optional)** **boolean** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [default to false] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/README.md b/sdk-output/global_tenant_security_settings/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Serviceproviderconfiguration.md b/sdk-output/global_tenant_security_settings/docs/Models/Serviceproviderconfiguration.md new file mode 100644 index 00000000..adbcf31a --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Serviceproviderconfiguration.md @@ -0,0 +1,22 @@ +--- +id: v1-serviceproviderconfiguration-v1 +title: ServiceproviderconfigurationV1 +pagination_label: ServiceproviderconfigurationV1 +sidebar_label: ServiceproviderconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServiceproviderconfigurationV1', 'v1ServiceproviderconfigurationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/serviceproviderconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'ServiceproviderconfigurationV1', 'v1ServiceproviderconfigurationV1'] +--- + +# ServiceproviderconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [default to false] +**bypassIdp** | **(optional)** **boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [default to false] +**samlConfigurationValid** | **(optional)** **boolean** | This indicates whether or not the SAML configuration is valid. | [default to false] +**federationProtocolDetails** | **(optional)** **Array<ServiceproviderconfigurationFederationProtocolDetailsInnerV1>** | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider). | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/ServiceproviderconfigurationFederationProtocolDetailsInner.md b/sdk-output/global_tenant_security_settings/docs/Models/ServiceproviderconfigurationFederationProtocolDetailsInner.md new file mode 100644 index 00000000..230dc549 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/ServiceproviderconfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,35 @@ +--- +id: v1-serviceproviderconfiguration-federation-protocol-details-inner-v1 +title: ServiceproviderconfigurationFederationProtocolDetailsInnerV1 +pagination_label: ServiceproviderconfigurationFederationProtocolDetailsInnerV1 +sidebar_label: ServiceproviderconfigurationFederationProtocolDetailsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServiceproviderconfigurationFederationProtocolDetailsInnerV1', 'v1ServiceproviderconfigurationFederationProtocolDetailsInnerV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/serviceproviderconfiguration-federation-protocol-details-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ServiceproviderconfigurationFederationProtocolDetailsInnerV1', 'v1ServiceproviderconfigurationFederationProtocolDetailsInnerV1'] +--- + +# ServiceproviderconfigurationFederationProtocolDetailsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **(optional)** **string** | Federation protocol role | [default to undefined] +**entityId** | **(optional)** **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [default to undefined] +**binding** | **(optional)** **string** | Defines the binding used for the SAML flow. Used with IDP configurations. | [default to undefined] +**authnContext** | **(optional)** **string** | Specifies the SAML authentication method to use. Used with IDP configurations. | [default to undefined] +**logoutUrl** | **(optional)** **string** | The IDP logout URL. Used with IDP configurations. | [default to undefined] +**includeAuthnContext** | **(optional)** **boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [default to false] +**nameId** | **(optional)** **string** | The name id format to use. Used with IDP configurations. | [default to undefined] +**jitConfiguration** | **(optional)** **JitconfigurationV1** | | [default to undefined] +**cert** | **(optional)** **string** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [default to undefined] +**loginUrlPost** | **(optional)** **string** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [default to undefined] +**loginUrlRedirect** | **(optional)** **string** | The IDP Redirect URL. Used with IDP configurations. | [default to undefined] +**mappingAttribute** | **string** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [default to undefined] +**certificateExpirationDate** | **(optional)** **string** | The expiration date extracted from the certificate. | [default to undefined] +**certificateName** | **(optional)** **string** | The name extracted from the certificate. | [default to undefined] +**alias** | **(optional)** **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [default to undefined] +**callbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [default to undefined] +**legacyAcsUrl** | **(optional)** **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Sessionconfiguration.md b/sdk-output/global_tenant_security_settings/docs/Models/Sessionconfiguration.md new file mode 100644 index 00000000..577573d5 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Sessionconfiguration.md @@ -0,0 +1,21 @@ +--- +id: v1-sessionconfiguration-v1 +title: SessionconfigurationV1 +pagination_label: SessionconfigurationV1 +sidebar_label: SessionconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SessionconfigurationV1', 'v1SessionconfigurationV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/sessionconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'SessionconfigurationV1', 'v1SessionconfigurationV1'] +--- + +# SessionconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maxIdleTime** | **(optional)** **number** | The maximum time in minutes a session can be idle. | [default to undefined] +**rememberMe** | **(optional)** **boolean** | Denotes if \'remember me\' is enabled. | [default to false] +**maxSessionTime** | **(optional)** **number** | The maximum allowable session time in minutes. | [default to undefined] + diff --git a/sdk-output/global_tenant_security_settings/docs/Models/Spdetails.md b/sdk-output/global_tenant_security_settings/docs/Models/Spdetails.md new file mode 100644 index 00000000..0ab68ab9 --- /dev/null +++ b/sdk-output/global_tenant_security_settings/docs/Models/Spdetails.md @@ -0,0 +1,23 @@ +--- +id: v1-spdetails-v1 +title: SpdetailsV1 +pagination_label: SpdetailsV1 +sidebar_label: SpdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpdetailsV1', 'v1SpdetailsV1'] +slug: /tools/sdk/typescript/global_tenant_security_settings/models/spdetails-v1 +tags: ['SDK', 'Software Development Kit', 'SpdetailsV1', 'v1SpdetailsV1'] +--- + +# SpdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **(optional)** **string** | Federation protocol role | [default to undefined] +**entityId** | **(optional)** **string** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [default to undefined] +**alias** | **(optional)** **string** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [default to undefined] +**callbackUrl** | **string** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [default to undefined] +**legacyAcsUrl** | **(optional)** **string** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/governance_groups/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f33699db --- /dev/null +++ b/sdk-output/governance_groups/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,165 @@ +- path: /workgroups/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#create-workgroup-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupdtoV1: WorkgroupdtoV1 = ; // WorkgroupdtoV1 | + const result = await apiInstance.createWorkgroupV1(workgroupdtoV1); + console.log(result); +- path: /workgroups/v1/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#delete-workgroup-members-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupId: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Governance Group. (default to undefined) + const bulkworkgroupmembersrequestInnerV1: Array<BulkworkgroupmembersrequestInnerV1> = ; // Array | List of identities to be removed from a Governance Group members list. + const result = await apiInstance.deleteWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1); + console.log(result); +- path: /workgroups/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#delete-workgroup-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const id: string = '2c9180837ca6693d017ca8d097500149'; // string | ID of the Governance Group (default to undefined) + const result = await apiInstance.deleteWorkgroupV1(id); + console.log(result); +- path: /workgroups/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#delete-workgroups-in-bulk-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupbulkdeleterequestV1: WorkgroupbulkdeleterequestV1 = {"ids":["567a697e-885b-495a-afc5-d55e1c23a302","c7b0f7b2-1e78-4063-b294-a555333dacd2"]}; // WorkgroupbulkdeleterequestV1 | + const result = await apiInstance.deleteWorkgroupsInBulkV1(workgroupbulkdeleterequestV1); + console.log(result); +- path: /workgroups/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#get-workgroup-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const id: string = '2c9180837ca6693d017ca8d097500149'; // string | ID of the Governance Group (default to undefined) + const result = await apiInstance.getWorkgroupV1(id); + console.log(result); +- path: /workgroups/v1/{workgroupId}/connections + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#list-connections-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupId: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Governance Group. (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const result = await apiInstance.listConnectionsV1(workgroupId); + console.log(result); +- path: /workgroups/v1/{workgroupId}/members + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#list-workgroup-members-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupId: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Governance Group. (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const result = await apiInstance.listWorkgroupMembersV1(workgroupId); + console.log(result); +- path: /workgroups/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#list-workgroups-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name sw "Test"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) (default to undefined) + const result = await apiInstance.listWorkgroupsV1(); + console.log(result); +- path: /workgroups/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#patch-workgroup-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const id: string = '2c9180837ca6693d017ca8d097500149'; // string | ID of the Governance Group (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Governance Group new description."}]; // Array | (optional) + const result = await apiInstance.patchWorkgroupV1(id); + console.log(result); +- path: /workgroups/v1/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/governance_groups/methods/governance-groups#update-workgroup-members-v1 + source: | + import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new GovernanceGroupsV1Api(configuration); + const workgroupId: string = '2c91808a7813090a017814121919ecca'; // string | ID of the Governance Group. (default to undefined) + const bulkworkgroupmembersrequestInnerV1: Array<BulkworkgroupmembersrequestInnerV1> = ; // Array | List of identities to be added to a Governance Group members list. + const result = await apiInstance.updateWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1); + console.log(result); diff --git a/sdk-output/governance_groups/docs/Methods/GovernanceGroupsV1Api.md b/sdk-output/governance_groups/docs/Methods/GovernanceGroupsV1Api.md new file mode 100644 index 00000000..f30421e9 --- /dev/null +++ b/sdk-output/governance_groups/docs/Methods/GovernanceGroupsV1Api.md @@ -0,0 +1,465 @@ +--- +id: v1-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GovernanceGroups', 'v1GovernanceGroups'] +slug: /tools/sdk/typescript/governance_groups/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'v1GovernanceGroups'] +--- + +# GovernanceGroupsV1Api + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-workgroup-v1**](#create-workgroup-v1) | **POST** `/workgroups/v1` | Create a new governance group. +[**delete-workgroup-members-v1**](#delete-workgroup-members-v1) | **POST** `/workgroups/v1/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**delete-workgroup-v1**](#delete-workgroup-v1) | **DELETE** `/workgroups/v1/{id}` | Delete a governance group +[**delete-workgroups-in-bulk-v1**](#delete-workgroups-in-bulk-v1) | **POST** `/workgroups/v1/bulk-delete` | Delete governance group(s) +[**get-workgroup-v1**](#get-workgroup-v1) | **GET** `/workgroups/v1/{id}` | Get governance group by id +[**list-connections-v1**](#list-connections-v1) | **GET** `/workgroups/v1/{workgroupId}/connections` | List connections for governance group +[**list-workgroup-members-v1**](#list-workgroup-members-v1) | **GET** `/workgroups/v1/{workgroupId}/members` | List governance group members +[**list-workgroups-v1**](#list-workgroups-v1) | **GET** `/workgroups/v1` | List governance groups +[**patch-workgroup-v1**](#patch-workgroup-v1) | **PATCH** `/workgroups/v1/{id}` | Patch a governance group +[**update-workgroup-members-v1**](#update-workgroup-members-v1) | **POST** `/workgroups/v1/{workgroupId}/members/bulk-add` | Add members to governance group + + +## create-workgroup-v1 +Create a new governance group. +This API creates a new Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-workgroup-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupdtoV1** | **WorkgroupdtoV1** | | + +### Return type + +**WorkgroupdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupdtoV1: WorkgroupdtoV1 = ; // +const result = await apiInstance.createWorkgroupV1(workgroupdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-workgroup-members-v1 +Remove members from governance group +This API removes one or more members from a Governance Group. A +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-workgroup-members-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupId** | **string** | ID of the Governance Group. | [default to undefined] +**bulkworkgroupmembersrequestInnerV1** | **Array<BulkworkgroupmembersrequestInnerV1>** | List of identities to be removed from a Governance Group members list. | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group. +const bulkworkgroupmembersrequestInnerV1: Array<BulkworkgroupmembersrequestInnerV1> = ; // List of identities to be removed from a Governance Group members list. +const result = await apiInstance.deleteWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-workgroup-v1 +Delete a governance group +This API deletes a Governance Group by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-workgroup-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Governance Group | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group +const result = await apiInstance.deleteWorkgroupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-workgroups-in-bulk-v1 +Delete governance group(s) + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-workgroups-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupbulkdeleterequestV1** | **WorkgroupbulkdeleterequestV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupbulkdeleterequestV1: WorkgroupbulkdeleterequestV1 = {"ids":["567a697e-885b-495a-afc5-d55e1c23a302","c7b0f7b2-1e78-4063-b294-a555333dacd2"]}; // +const result = await apiInstance.deleteWorkgroupsInBulkV1(workgroupbulkdeleterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-workgroup-v1 +Get governance group by id +This API returns a Governance Groups by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workgroup-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Governance Group | [default to undefined] + +### Return type + +**WorkgroupdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group +const result = await apiInstance.getWorkgroupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-connections-v1 +List connections for governance group +This API returns list of connections associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-connections-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupId** | **string** | ID of the Governance Group. | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group. +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const result = await apiInstance.listConnectionsV1(workgroupId); +console.log(result); +``` + +[[Back to top]](#) + +## list-workgroup-members-v1 +List governance group members +This API returns list of members associated with a Governance Group. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workgroup-members-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupId** | **string** | ID of the Governance Group. | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group. +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const result = await apiInstance.listWorkgroupMembersV1(workgroupId); +console.log(result); +``` + +[[Back to top]](#) + +## list-workgroups-v1 +List governance groups +This API returns list of Governance Groups + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workgroups-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name sw "Test"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) +const result = await apiInstance.listWorkgroupsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-workgroup-v1 +Patch a governance group +This API updates an existing governance group by ID. The following fields and objects are patchable: +* name +* description +* owner + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-workgroup-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Governance Group | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | [optional] + +### Return type + +**WorkgroupdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const id: string = 2c9180837ca6693d017ca8d097500149; // ID of the Governance Group +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Governance Group new description."}]; // (optional) +const result = await apiInstance.patchWorkgroupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-workgroup-members-v1 +Add members to governance group +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-workgroup-members-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**workgroupId** | **string** | ID of the Governance Group. | [default to undefined] +**bulkworkgroupmembersrequestInnerV1** | **Array<BulkworkgroupmembersrequestInnerV1>** | List of identities to be added to a Governance Group members list. | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { GovernanceGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new GovernanceGroupsV1Api(configuration); +const workgroupId: string = 2c91808a7813090a017814121919ecca; // ID of the Governance Group. +const bulkworkgroupmembersrequestInnerV1: Array<BulkworkgroupmembersrequestInnerV1> = ; // List of identities to be added to a Governance Group members list. +const result = await apiInstance.updateWorkgroupMembersV1(workgroupId, bulkworkgroupmembersrequestInnerV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/governance_groups/docs/Methods/Index.md b/sdk-output/governance_groups/docs/Methods/Index.md new file mode 100644 index 00000000..d6d0b718 --- /dev/null +++ b/sdk-output/governance_groups/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: governance_groups-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: governance_groups-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'governance_groups', 'methods'] +slug: /tools/sdk/typescript/governance_groups/methods +tags: ['SDK', 'Software Development Kit', 'governance_groups', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/governance_groups/docs/Models/ArrayInner.md b/sdk-output/governance_groups/docs/Models/ArrayInner.md new file mode 100644 index 00000000..f62265f1 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/governance_groups/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/governance_groups/docs/Models/BulkworkgroupmembersrequestInner.md b/sdk-output/governance_groups/docs/Models/BulkworkgroupmembersrequestInner.md new file mode 100644 index 00000000..0c2016d5 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/BulkworkgroupmembersrequestInner.md @@ -0,0 +1,21 @@ +--- +id: v1-bulkworkgroupmembersrequest-inner-v1 +title: BulkworkgroupmembersrequestInnerV1 +pagination_label: BulkworkgroupmembersrequestInnerV1 +sidebar_label: BulkworkgroupmembersrequestInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkworkgroupmembersrequestInnerV1', 'v1BulkworkgroupmembersrequestInnerV1'] +slug: /tools/sdk/typescript/governance_groups/models/bulkworkgroupmembersrequest-inner-v1 +tags: ['SDK', 'Software Development Kit', 'BulkworkgroupmembersrequestInnerV1', 'v1BulkworkgroupmembersrequestInnerV1'] +--- + +# BulkworkgroupmembersrequestInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Identity\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s display name. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Connectedobject.md b/sdk-output/governance_groups/docs/Models/Connectedobject.md new file mode 100644 index 00000000..2071c8e8 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Connectedobject.md @@ -0,0 +1,22 @@ +--- +id: v1-connectedobject-v1 +title: ConnectedobjectV1 +pagination_label: ConnectedobjectV1 +sidebar_label: ConnectedobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectedobjectV1', 'v1ConnectedobjectV1'] +slug: /tools/sdk/typescript/governance_groups/models/connectedobject-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectedobjectV1', 'v1ConnectedobjectV1'] +--- + +# ConnectedobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **ConnectedobjecttypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of Connected object | [default to undefined] +**description** | **(optional)** **string** | Description of the Connected object. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Connectedobjecttype.md b/sdk-output/governance_groups/docs/Models/Connectedobjecttype.md new file mode 100644 index 00000000..5ea9b5d1 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Connectedobjecttype.md @@ -0,0 +1,25 @@ +--- +id: v1-connectedobjecttype-v1 +title: ConnectedobjecttypeV1 +pagination_label: ConnectedobjecttypeV1 +sidebar_label: ConnectedobjecttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectedobjecttypeV1', 'v1ConnectedobjecttypeV1'] +slug: /tools/sdk/typescript/governance_groups/models/connectedobjecttype-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectedobjecttypeV1', 'v1ConnectedobjecttypeV1'] +--- + +# ConnectedobjecttypeV1 + +## Enum + + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Role` (value: `'ROLE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + + diff --git a/sdk-output/governance_groups/docs/Models/Errormessagedto.md b/sdk-output/governance_groups/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..63b07330 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/governance_groups/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Errorresponsedto.md b/sdk-output/governance_groups/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..56ac1e74 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/governance_groups/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Index.md b/sdk-output/governance_groups/docs/Models/Index.md new file mode 100644 index 00000000..96ccb6ff --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: governance_groups-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: governance_groups-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'governance_groups', 'models'] +slug: /tools/sdk/typescript/governance_groups/models +tags: ['SDK', 'Software Development Kit', 'governance_groups', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/governance_groups/docs/Models/Jsonpatchoperation.md b/sdk-output/governance_groups/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..6da9b1d0 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/governance_groups/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/JsonpatchoperationValue.md b/sdk-output/governance_groups/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..5eaf0bcc --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/governance_groups/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/governance_groups/docs/Models/ListWorkgroupMembersV1200ResponseInner.md b/sdk-output/governance_groups/docs/Models/ListWorkgroupMembersV1200ResponseInner.md new file mode 100644 index 00000000..08dd15b7 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/ListWorkgroupMembersV1200ResponseInner.md @@ -0,0 +1,22 @@ +--- +id: v1-list-workgroup-members-v1200-response-inner-v1 +title: ListWorkgroupMembersV1200ResponseInnerV1 +pagination_label: ListWorkgroupMembersV1200ResponseInnerV1 +sidebar_label: ListWorkgroupMembersV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkgroupMembersV1200ResponseInnerV1', 'v1ListWorkgroupMembersV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/governance_groups/models/list-workgroup-members-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembersV1200ResponseInnerV1', 'v1ListWorkgroupMembersV1200ResponseInnerV1'] +--- + +# ListWorkgroupMembersV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Workgroup member identity DTO type. | [default to undefined] +**id** | **(optional)** **string** | Workgroup member identity ID. | [default to undefined] +**name** | **(optional)** **string** | Workgroup member identity display name. | [default to undefined] +**email** | **(optional)** **string** | Workgroup member identity email. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1401Response.md b/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1401Response.md new file mode 100644 index 00000000..fede78e4 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-workgroups-v1401-response-v1 +title: ListWorkgroupsV1401ResponseV1 +pagination_label: ListWorkgroupsV1401ResponseV1 +sidebar_label: ListWorkgroupsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkgroupsV1401ResponseV1', 'v1ListWorkgroupsV1401ResponseV1'] +slug: /tools/sdk/typescript/governance_groups/models/list-workgroups-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupsV1401ResponseV1', 'v1ListWorkgroupsV1401ResponseV1'] +--- + +# ListWorkgroupsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1429Response.md b/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1429Response.md new file mode 100644 index 00000000..fd5d31e8 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/ListWorkgroupsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-workgroups-v1429-response-v1 +title: ListWorkgroupsV1429ResponseV1 +pagination_label: ListWorkgroupsV1429ResponseV1 +sidebar_label: ListWorkgroupsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkgroupsV1429ResponseV1', 'v1ListWorkgroupsV1429ResponseV1'] +slug: /tools/sdk/typescript/governance_groups/models/list-workgroups-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupsV1429ResponseV1', 'v1ListWorkgroupsV1429ResponseV1'] +--- + +# ListWorkgroupsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Localeorigin.md b/sdk-output/governance_groups/docs/Models/Localeorigin.md new file mode 100644 index 00000000..33aa19d7 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/governance_groups/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/governance_groups/docs/Models/Ownerdto.md b/sdk-output/governance_groups/docs/Models/Ownerdto.md new file mode 100644 index 00000000..8e2dd8a9 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Ownerdto.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerdto-v1 +title: OwnerdtoV1 +pagination_label: OwnerdtoV1 +sidebar_label: OwnerdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerdtoV1', 'v1OwnerdtoV1'] +slug: /tools/sdk/typescript/governance_groups/models/ownerdto-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerdtoV1', 'v1OwnerdtoV1'] +--- + +# OwnerdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/README.md b/sdk-output/governance_groups/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/governance_groups/docs/Models/Workgroupbulkdeleterequest.md b/sdk-output/governance_groups/docs/Models/Workgroupbulkdeleterequest.md new file mode 100644 index 00000000..d7082663 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupbulkdeleterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-workgroupbulkdeleterequest-v1 +title: WorkgroupbulkdeleterequestV1 +pagination_label: WorkgroupbulkdeleterequestV1 +sidebar_label: WorkgroupbulkdeleterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupbulkdeleterequestV1', 'v1WorkgroupbulkdeleterequestV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupbulkdeleterequest-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupbulkdeleterequestV1', 'v1WorkgroupbulkdeleterequestV1'] +--- + +# WorkgroupbulkdeleterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **(optional)** **Array<string>** | List of IDs of Governance Groups to be deleted. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Workgroupconnectiondto.md b/sdk-output/governance_groups/docs/Models/Workgroupconnectiondto.md new file mode 100644 index 00000000..1eae3ea7 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupconnectiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-workgroupconnectiondto-v1 +title: WorkgroupconnectiondtoV1 +pagination_label: WorkgroupconnectiondtoV1 +sidebar_label: WorkgroupconnectiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupconnectiondtoV1', 'v1WorkgroupconnectiondtoV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupconnectiondto-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupconnectiondtoV1', 'v1WorkgroupconnectiondtoV1'] +--- + +# WorkgroupconnectiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**object** | **(optional)** **WorkgroupconnectiondtoObjectV1** | | [default to undefined] +**connectionType** | **(optional)** **string** | Connection Type. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/WorkgroupconnectiondtoObject.md b/sdk-output/governance_groups/docs/Models/WorkgroupconnectiondtoObject.md new file mode 100644 index 00000000..a9eb244f --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/WorkgroupconnectiondtoObject.md @@ -0,0 +1,22 @@ +--- +id: v1-workgroupconnectiondto-object-v1 +title: WorkgroupconnectiondtoObjectV1 +pagination_label: WorkgroupconnectiondtoObjectV1 +sidebar_label: WorkgroupconnectiondtoObjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupconnectiondtoObjectV1', 'v1WorkgroupconnectiondtoObjectV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupconnectiondto-object-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupconnectiondtoObjectV1', 'v1WorkgroupconnectiondtoObjectV1'] +--- + +# WorkgroupconnectiondtoObjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **ConnectedobjecttypeV1 & object** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of Connected object | [default to undefined] +**description** | **(optional)** **string** | Description of the Connected object. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Workgroupdeleteitem.md b/sdk-output/governance_groups/docs/Models/Workgroupdeleteitem.md new file mode 100644 index 00000000..60558e0e --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupdeleteitem.md @@ -0,0 +1,21 @@ +--- +id: v1-workgroupdeleteitem-v1 +title: WorkgroupdeleteitemV1 +pagination_label: WorkgroupdeleteitemV1 +sidebar_label: WorkgroupdeleteitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupdeleteitemV1', 'v1WorkgroupdeleteitemV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupdeleteitem-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupdeleteitemV1', 'v1WorkgroupdeleteitemV1'] +--- + +# WorkgroupdeleteitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Id of the Governance Group. | [default to undefined] +**status** | **number** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [default to undefined] +**description** | **(optional)** **string** | Human readable status description and containing additional context information about success or failures etc. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Workgroupdto.md b/sdk-output/governance_groups/docs/Models/Workgroupdto.md new file mode 100644 index 00000000..9cb64cb1 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupdto.md @@ -0,0 +1,26 @@ +--- +id: v1-workgroupdto-v1 +title: WorkgroupdtoV1 +pagination_label: WorkgroupdtoV1 +sidebar_label: WorkgroupdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupdtoV1', 'v1WorkgroupdtoV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupdto-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupdtoV1', 'v1WorkgroupdtoV1'] +--- + +# WorkgroupdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**owner** | **(optional)** **WorkgroupdtoOwnerV1** | | [default to undefined] +**id** | **(optional)** **string** | Governance group ID. | [readonly] [default to undefined] +**name** | **(optional)** **string** | Governance group name. | [default to undefined] +**description** | **(optional)** **string** | Governance group description. | [default to undefined] +**memberCount** | **(optional)** **number** | Number of members in the governance group. | [readonly] [default to undefined] +**connectionCount** | **(optional)** **number** | Number of connections in the governance group. | [readonly] [default to undefined] +**created** | **(optional)** **string** | | [default to undefined] +**modified** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/WorkgroupdtoOwner.md b/sdk-output/governance_groups/docs/Models/WorkgroupdtoOwner.md new file mode 100644 index 00000000..427e52fa --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/WorkgroupdtoOwner.md @@ -0,0 +1,23 @@ +--- +id: v1-workgroupdto-owner-v1 +title: WorkgroupdtoOwnerV1 +pagination_label: WorkgroupdtoOwnerV1 +sidebar_label: WorkgroupdtoOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupdtoOwnerV1', 'v1WorkgroupdtoOwnerV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupdto-owner-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupdtoOwnerV1', 'v1WorkgroupdtoOwnerV1'] +--- + +# WorkgroupdtoOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the identity | [readonly] [default to undefined] +**emailAddress** | **(optional)** **string** | The primary email address of the identity | [readonly] [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Workgroupmemberadditem.md b/sdk-output/governance_groups/docs/Models/Workgroupmemberadditem.md new file mode 100644 index 00000000..c0868ba1 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupmemberadditem.md @@ -0,0 +1,21 @@ +--- +id: v1-workgroupmemberadditem-v1 +title: WorkgroupmemberadditemV1 +pagination_label: WorkgroupmemberadditemV1 +sidebar_label: WorkgroupmemberadditemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupmemberadditemV1', 'v1WorkgroupmemberadditemV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupmemberadditem-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupmemberadditemV1', 'v1WorkgroupmemberadditemV1'] +--- + +# WorkgroupmemberadditemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Identifier of identity in bulk member add request. | [default to undefined] +**status** | **number** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [default to undefined] +**description** | **(optional)** **string** | Human readable status description and containing additional context information about success or failures etc. | [default to undefined] + diff --git a/sdk-output/governance_groups/docs/Models/Workgroupmemberdeleteitem.md b/sdk-output/governance_groups/docs/Models/Workgroupmemberdeleteitem.md new file mode 100644 index 00000000..342d2401 --- /dev/null +++ b/sdk-output/governance_groups/docs/Models/Workgroupmemberdeleteitem.md @@ -0,0 +1,21 @@ +--- +id: v1-workgroupmemberdeleteitem-v1 +title: WorkgroupmemberdeleteitemV1 +pagination_label: WorkgroupmemberdeleteitemV1 +sidebar_label: WorkgroupmemberdeleteitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkgroupmemberdeleteitemV1', 'v1WorkgroupmemberdeleteitemV1'] +slug: /tools/sdk/typescript/governance_groups/models/workgroupmemberdeleteitem-v1 +tags: ['SDK', 'Software Development Kit', 'WorkgroupmemberdeleteitemV1', 'v1WorkgroupmemberdeleteitemV1'] +--- + +# WorkgroupmemberdeleteitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Identifier of identity in bulk member add /remove request. | [default to undefined] +**status** | **number** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [default to undefined] +**description** | **(optional)** **string** | Human readable status description and containing additional context information about success or failures etc. | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_access_request_recommendations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..b031c42a --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,177 @@ +- path: /ai-access-request-recommendations/v1/ignored-items + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // AccessrequestrecommendationactionitemdtoV1 | The recommended access item to ignore for an identity. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.addAccessRequestRecommendationsIgnoredItemV1(accessrequestrecommendationactionitemdtoV1); + console.log(result); +- path: /ai-access-request-recommendations/v1/requested-items + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // AccessrequestrecommendationactionitemdtoV1 | The recommended access item that was requested for an identity. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.addAccessRequestRecommendationsRequestedItemV1(accessrequestrecommendationactionitemdtoV1); + console.log(result); +- path: /ai-access-request-recommendations/v1/viewed-items + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // AccessrequestrecommendationactionitemdtoV1 | The recommended access that was viewed for an identity. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.addAccessRequestRecommendationsViewedItemV1(accessrequestrecommendationactionitemdtoV1); + console.log(result); +- path: /ai-access-request-recommendations/v1/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const accessrequestrecommendationactionitemdtoV1: Array<AccessrequestrecommendationactionitemdtoV1> = ; // Array | The recommended access items that were viewed for an identity. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.addAccessRequestRecommendationsViewedItemsV1(accessrequestrecommendationactionitemdtoV1); + console.log(result); +- path: /ai-access-request-recommendations/v1/config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#get-access-request-recommendations-config-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAccessRequestRecommendationsConfigV1(); + console.log(result); +- path: /ai-access-request-recommendations/v1/ignored-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'identityId eq "2c9180846b0a0583016b299f210c1314"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) (default to undefined) + const sorters: string = 'access.id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAccessRequestRecommendationsIgnoredItemsV1(); + console.log(result); +- path: /ai-access-request-recommendations/v1/requested-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'access.id eq "2c9180846b0a0583016b299f210c1314"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) (default to undefined) + const sorters: string = 'access.id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAccessRequestRecommendationsRequestedItemsV1(); + console.log(result); +- path: /ai-access-request-recommendations/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#get-access-request-recommendations-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const identityId: string = '2c91808570313110017040b06f344ec9'; // string | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') + const limit: number = 15; // number | Max number of results to return. (optional) (default to 15) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const includeTranslationMessages: boolean = false; // boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to false) + const filters: string = 'access.name co "admin"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) (default to undefined) + const sorters: string = 'access.name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAccessRequestRecommendationsV1(); + console.log(result); +- path: /ai-access-request-recommendations/v1/viewed-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'access.id eq "2c9180846b0a0583016b299f210c1314"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) (default to undefined) + const sorters: string = 'access.id'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAccessRequestRecommendationsViewedItemsV1(); + console.log(result); +- path: /ai-access-request-recommendations/v1/config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations#set-access-request-recommendations-config-v1 + source: | + import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); + const accessrequestrecommendationconfigdtoV1: AccessrequestrecommendationconfigdtoV1 = ; // AccessrequestrecommendationconfigdtoV1 | The desired configurations for Access Request Recommender for the tenant. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.setAccessRequestRecommendationsConfigV1(accessrequestrecommendationconfigdtoV1); + console.log(result); diff --git a/sdk-output/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsV1Api.md b/sdk-output/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsV1Api.md new file mode 100644 index 00000000..581d1dff --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsV1Api.md @@ -0,0 +1,493 @@ +--- +id: v1-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAIAccessRequestRecommendations', 'v1IAIAccessRequestRecommendations'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'v1IAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendationsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add-access-request-recommendations-ignored-item-v1**](#add-access-request-recommendations-ignored-item-v1) | **POST** `/ai-access-request-recommendations/v1/ignored-items` | Ignore access request recommendation +[**add-access-request-recommendations-requested-item-v1**](#add-access-request-recommendations-requested-item-v1) | **POST** `/ai-access-request-recommendations/v1/requested-items` | Accept access request recommendation +[**add-access-request-recommendations-viewed-item-v1**](#add-access-request-recommendations-viewed-item-v1) | **POST** `/ai-access-request-recommendations/v1/viewed-items` | Mark viewed access request recommendations +[**add-access-request-recommendations-viewed-items-v1**](#add-access-request-recommendations-viewed-items-v1) | **POST** `/ai-access-request-recommendations/v1/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**get-access-request-recommendations-config-v1**](#get-access-request-recommendations-config-v1) | **GET** `/ai-access-request-recommendations/v1/config` | Get access request recommendations config +[**get-access-request-recommendations-ignored-items-v1**](#get-access-request-recommendations-ignored-items-v1) | **GET** `/ai-access-request-recommendations/v1/ignored-items` | List ignored access request recommendations +[**get-access-request-recommendations-requested-items-v1**](#get-access-request-recommendations-requested-items-v1) | **GET** `/ai-access-request-recommendations/v1/requested-items` | List accepted access request recommendations +[**get-access-request-recommendations-v1**](#get-access-request-recommendations-v1) | **GET** `/ai-access-request-recommendations/v1` | Identity access request recommendations +[**get-access-request-recommendations-viewed-items-v1**](#get-access-request-recommendations-viewed-items-v1) | **GET** `/ai-access-request-recommendations/v1/viewed-items` | List viewed access request recommendations +[**set-access-request-recommendations-config-v1**](#set-access-request-recommendations-config-v1) | **PUT** `/ai-access-request-recommendations/v1/config` | Update access request recommendations config + + +## add-access-request-recommendations-ignored-item-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Ignore access request recommendation +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/add-access-request-recommendations-ignored-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestrecommendationactionitemdtoV1** | **AccessrequestrecommendationactionitemdtoV1** | The recommended access item to ignore for an identity. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccessrequestrecommendationactionitemresponsedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // The recommended access item to ignore for an identity. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.addAccessRequestRecommendationsIgnoredItemV1(accessrequestrecommendationactionitemdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## add-access-request-recommendations-requested-item-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Accept access request recommendation +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/add-access-request-recommendations-requested-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestrecommendationactionitemdtoV1** | **AccessrequestrecommendationactionitemdtoV1** | The recommended access item that was requested for an identity. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccessrequestrecommendationactionitemresponsedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // The recommended access item that was requested for an identity. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.addAccessRequestRecommendationsRequestedItemV1(accessrequestrecommendationactionitemdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-item-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Mark viewed access request recommendations +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/add-access-request-recommendations-viewed-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestrecommendationactionitemdtoV1** | **AccessrequestrecommendationactionitemdtoV1** | The recommended access that was viewed for an identity. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccessrequestrecommendationactionitemresponsedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const accessrequestrecommendationactionitemdtoV1: AccessrequestrecommendationactionitemdtoV1 = ; // The recommended access that was viewed for an identity. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.addAccessRequestRecommendationsViewedItemV1(accessrequestrecommendationactionitemdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## add-access-request-recommendations-viewed-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Bulk mark viewed access request recommendations +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/add-access-request-recommendations-viewed-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestrecommendationactionitemdtoV1** | **Array<AccessrequestrecommendationactionitemdtoV1>** | The recommended access items that were viewed for an identity. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const accessrequestrecommendationactionitemdtoV1: Array<AccessrequestrecommendationactionitemdtoV1> = ; // The recommended access items that were viewed for an identity. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.addAccessRequestRecommendationsViewedItemsV1(accessrequestrecommendationactionitemdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-recommendations-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get access request recommendations config +This API returns the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-recommendations-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccessrequestrecommendationconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAccessRequestRecommendationsConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-recommendations-ignored-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List ignored access request recommendations +This API returns the list of ignored access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-recommendations-ignored-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = identityId eq "2c9180846b0a0583016b299f210c1314"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +const sorters: string = access.id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAccessRequestRecommendationsIgnoredItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-recommendations-requested-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List accepted access request recommendations +This API returns a list of requested access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-recommendations-requested-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = access.id eq "2c9180846b0a0583016b299f210c1314"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +const sorters: string = access.id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAccessRequestRecommendationsRequestedItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-recommendations-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Identity access request recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-recommendations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | Get access request recommendations for an identityId. *me* indicates the current user. | [optional] [default to 'me'] +**limit** | **number** | Max number of results to return. | [optional] [default to 15] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**includeTranslationMessages** | **boolean** | If *true* it will populate a list of translation messages in the response. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const identityId: string = 2c91808570313110017040b06f344ec9; // Get access request recommendations for an identityId. *me* indicates the current user. (optional) +const limit: number = 15; // Max number of results to return. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const includeTranslationMessages: boolean = false; // If *true* it will populate a list of translation messages in the response. (optional) +const filters: string = access.name co "admin"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) +const sorters: string = access.name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAccessRequestRecommendationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-access-request-recommendations-viewed-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List viewed access request recommendations +This API returns the list of viewed access request recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-access-request-recommendations-viewed-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = access.id eq "2c9180846b0a0583016b299f210c1314"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +const sorters: string = access.id; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAccessRequestRecommendationsViewedItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## set-access-request-recommendations-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update access request recommendations config +This API updates the configurations for Access Request Recommender for the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-access-request-recommendations-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**accessrequestrecommendationconfigdtoV1** | **AccessrequestrecommendationconfigdtoV1** | The desired configurations for Access Request Recommender for the tenant. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccessrequestrecommendationconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIAccessRequestRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIAccessRequestRecommendationsV1Api(configuration); +const accessrequestrecommendationconfigdtoV1: AccessrequestrecommendationconfigdtoV1 = ; // The desired configurations for Access Request Recommender for the tenant. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.setAccessRequestRecommendationsConfigV1(accessrequestrecommendationconfigdtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_access_request_recommendations/docs/Methods/Index.md b/sdk-output/iai_access_request_recommendations/docs/Methods/Index.md new file mode 100644 index 00000000..2773dec0 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_access_request_recommendations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_access_request_recommendations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_access_request_recommendations', 'methods'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/methods +tags: ['SDK', 'Software Development Kit', 'iai_access_request_recommendations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrecommendationmessage.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrecommendationmessage.md new file mode 100644 index 00000000..3163786c --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrecommendationmessage.md @@ -0,0 +1,19 @@ +--- +id: v1-accessrecommendationmessage-v1 +title: AccessrecommendationmessageV1 +pagination_label: AccessrecommendationmessageV1 +sidebar_label: AccessrecommendationmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrecommendationmessageV1', 'v1AccessrecommendationmessageV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrecommendationmessage-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrecommendationmessageV1', 'v1AccessrecommendationmessageV1'] +--- + +# AccessrecommendationmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**interpretation** | **(optional)** **string** | Information about why the access item was recommended. | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemdto.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemdto.md new file mode 100644 index 00000000..c426e009 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemdto.md @@ -0,0 +1,20 @@ +--- +id: v1-accessrequestrecommendationactionitemdto-v1 +title: AccessrequestrecommendationactionitemdtoV1 +pagination_label: AccessrequestrecommendationactionitemdtoV1 +sidebar_label: AccessrequestrecommendationactionitemdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationactionitemdtoV1', 'v1AccessrequestrecommendationactionitemdtoV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationactionitemdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationactionitemdtoV1', 'v1AccessrequestrecommendationactionitemdtoV1'] +--- + +# AccessrequestrecommendationactionitemdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **string** | The identity ID taking the action. | [default to undefined] +**access** | **AccessrequestrecommendationitemV1** | | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemresponsedto.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemresponsedto.md new file mode 100644 index 00000000..aaecf071 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationactionitemresponsedto.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestrecommendationactionitemresponsedto-v1 +title: AccessrequestrecommendationactionitemresponsedtoV1 +pagination_label: AccessrequestrecommendationactionitemresponsedtoV1 +sidebar_label: AccessrequestrecommendationactionitemresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationactionitemresponsedtoV1', 'v1AccessrequestrecommendationactionitemresponsedtoV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationactionitemresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationactionitemresponsedtoV1', 'v1AccessrequestrecommendationactionitemresponsedtoV1'] +--- + +# AccessrequestrecommendationactionitemresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The identity ID taking the action. | [default to undefined] +**access** | **(optional)** **AccessrequestrecommendationitemV1** | | [default to undefined] +**timestamp** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationconfigdto.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationconfigdto.md new file mode 100644 index 00000000..84964ea6 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationconfigdto.md @@ -0,0 +1,24 @@ +--- +id: v1-accessrequestrecommendationconfigdto-v1 +title: AccessrequestrecommendationconfigdtoV1 +pagination_label: AccessrequestrecommendationconfigdtoV1 +sidebar_label: AccessrequestrecommendationconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationconfigdtoV1', 'v1AccessrequestrecommendationconfigdtoV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationconfigdtoV1', 'v1AccessrequestrecommendationconfigdtoV1'] +--- + +# AccessrequestrecommendationconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scoreThreshold** | **number** | The value that internal calculations need to exceed for recommendations to be made. | [default to undefined] +**startDateAttribute** | **(optional)** **string** | Use to map an attribute name for determining identities\' start date. | [default to undefined] +**restrictionAttribute** | **(optional)** **string** | Use to only give recommendations based on this attribute. | [default to undefined] +**moverAttribute** | **(optional)** **string** | Use to map an attribute name for determining whether identities are movers. | [default to undefined] +**joinerAttribute** | **(optional)** **string** | Use to map an attribute name for determining whether identities are joiners. | [default to undefined] +**useRestrictionAttribute** | **(optional)** **boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [default to false] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitem.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitem.md new file mode 100644 index 00000000..dddbe4e9 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitem.md @@ -0,0 +1,20 @@ +--- +id: v1-accessrequestrecommendationitem-v1 +title: AccessrequestrecommendationitemV1 +pagination_label: AccessrequestrecommendationitemV1 +sidebar_label: AccessrequestrecommendationitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationitemV1', 'v1AccessrequestrecommendationitemV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationitem-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationitemV1', 'v1AccessrequestrecommendationitemV1'] +--- + +# AccessrequestrecommendationitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of access item being recommended. | [default to undefined] +**type** | **(optional)** **AccessrequestrecommendationitemtypeV1** | | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemdetail.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemdetail.md new file mode 100644 index 00000000..8d79e1fd --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemdetail.md @@ -0,0 +1,25 @@ +--- +id: v1-accessrequestrecommendationitemdetail-v1 +title: AccessrequestrecommendationitemdetailV1 +pagination_label: AccessrequestrecommendationitemdetailV1 +sidebar_label: AccessrequestrecommendationitemdetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationitemdetailV1', 'v1AccessrequestrecommendationitemdetailV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationitemdetail-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationitemdetailV1', 'v1AccessrequestrecommendationitemdetailV1'] +--- + +# AccessrequestrecommendationitemdetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | Identity ID for the recommendation | [default to undefined] +**access** | **(optional)** **AccessrequestrecommendationitemdetailAccessV1** | | [default to undefined] +**ignored** | **(optional)** **boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [default to undefined] +**requested** | **(optional)** **boolean** | Whether or not the identity has already chosen to request this recommendation. | [default to undefined] +**viewed** | **(optional)** **boolean** | Whether or not the identity reportedly viewed this recommendation. | [default to undefined] +**messages** | **(optional)** **Array<AccessrecommendationmessageV1>** | | [default to undefined] +**translationMessages** | **(optional)** **Array<TranslationmessageV1>** | The list of translation messages | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/AccessrequestrecommendationitemdetailAccess.md b/sdk-output/iai_access_request_recommendations/docs/Models/AccessrequestrecommendationitemdetailAccess.md new file mode 100644 index 00000000..6ccdff2d --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/AccessrequestrecommendationitemdetailAccess.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequestrecommendationitemdetail-access-v1 +title: AccessrequestrecommendationitemdetailAccessV1 +pagination_label: AccessrequestrecommendationitemdetailAccessV1 +sidebar_label: AccessrequestrecommendationitemdetailAccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationitemdetailAccessV1', 'v1AccessrequestrecommendationitemdetailAccessV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationitemdetail-access-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationitemdetailAccessV1', 'v1AccessrequestrecommendationitemdetailAccessV1'] +--- + +# AccessrequestrecommendationitemdetailAccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of access item being recommended. | [default to undefined] +**type** | **(optional)** **AccessrequestrecommendationitemtypeV1** | | [default to undefined] +**name** | **(optional)** **string** | Name of the access item | [default to undefined] +**description** | **(optional)** **string** | Description of the access item | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemtype.md b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemtype.md new file mode 100644 index 00000000..ad6895b7 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Accessrequestrecommendationitemtype.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestrecommendationitemtype-v1 +title: AccessrequestrecommendationitemtypeV1 +pagination_label: AccessrequestrecommendationitemtypeV1 +sidebar_label: AccessrequestrecommendationitemtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestrecommendationitemtypeV1', 'v1AccessrequestrecommendationitemtypeV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/accessrequestrecommendationitemtype-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestrecommendationitemtypeV1', 'v1AccessrequestrecommendationitemtypeV1'] +--- + +# AccessrequestrecommendationitemtypeV1 + +## Enum + + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Role` (value: `'ROLE'`) + + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Errormessagedto.md b/sdk-output/iai_access_request_recommendations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..9391156f --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Errorresponsedto.md b/sdk-output/iai_access_request_recommendations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..47b608e7 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1401Response.md b/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1401Response.md new file mode 100644 index 00000000..fef1ea2c --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-recommendations-v1401-response-v1 +title: GetAccessRequestRecommendationsV1401ResponseV1 +pagination_label: GetAccessRequestRecommendationsV1401ResponseV1 +sidebar_label: GetAccessRequestRecommendationsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestRecommendationsV1401ResponseV1', 'v1GetAccessRequestRecommendationsV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/get-access-request-recommendations-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestRecommendationsV1401ResponseV1', 'v1GetAccessRequestRecommendationsV1401ResponseV1'] +--- + +# GetAccessRequestRecommendationsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1429Response.md b/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1429Response.md new file mode 100644 index 00000000..56b82d2f --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/GetAccessRequestRecommendationsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-access-request-recommendations-v1429-response-v1 +title: GetAccessRequestRecommendationsV1429ResponseV1 +pagination_label: GetAccessRequestRecommendationsV1429ResponseV1 +sidebar_label: GetAccessRequestRecommendationsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAccessRequestRecommendationsV1429ResponseV1', 'v1GetAccessRequestRecommendationsV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/get-access-request-recommendations-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAccessRequestRecommendationsV1429ResponseV1', 'v1GetAccessRequestRecommendationsV1429ResponseV1'] +--- + +# GetAccessRequestRecommendationsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Index.md b/sdk-output/iai_access_request_recommendations/docs/Models/Index.md new file mode 100644 index 00000000..2a494c71 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_access_request_recommendations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_access_request_recommendations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_access_request_recommendations', 'models'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models +tags: ['SDK', 'Software Development Kit', 'iai_access_request_recommendations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Localeorigin.md b/sdk-output/iai_access_request_recommendations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e8711b34 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/README.md b/sdk-output/iai_access_request_recommendations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_access_request_recommendations/docs/Models/Translationmessage.md b/sdk-output/iai_access_request_recommendations/docs/Models/Translationmessage.md new file mode 100644 index 00000000..98a044aa --- /dev/null +++ b/sdk-output/iai_access_request_recommendations/docs/Models/Translationmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-translationmessage-v1 +title: TranslationmessageV1 +pagination_label: TranslationmessageV1 +sidebar_label: TranslationmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TranslationmessageV1', 'v1TranslationmessageV1'] +slug: /tools/sdk/typescript/iai_access_request_recommendations/models/translationmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TranslationmessageV1', 'v1TranslationmessageV1'] +--- + +# TranslationmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The key of the translation message | [default to undefined] +**values** | **(optional)** **Array<string>** | The values corresponding to the translation messages | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_common_access/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..c65e7912 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,52 @@ +- path: /common-access/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_common_access/methods/iai-common-access#create-common-access-v1 + source: | + import { IAICommonAccessV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAICommonAccessV1Api(configuration); + const commonaccessitemrequestV1: CommonaccessitemrequestV1 = ; // CommonaccessitemrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createCommonAccessV1(commonaccessitemrequestV1); + console.log(result); +- path: /common-access/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_common_access/methods/iai-common-access#get-common-access-v1 + source: | + import { IAICommonAccessV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAICommonAccessV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'access.type eq "ROLE"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) (default to undefined) + const sorters: string = 'access.name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getCommonAccessV1(); + console.log(result); +- path: /common-access/v1/update-status + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_common_access/methods/iai-common-access#update-common-access-status-in-bulk-v1 + source: | + import { IAICommonAccessV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAICommonAccessV1Api(configuration); + const commonaccessidstatusV1: Array<CommonaccessidstatusV1> = ; // Array | Confirm or deny in bulk the common access ids that are (or aren\'t) common access + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateCommonAccessStatusInBulkV1(commonaccessidstatusV1); + console.log(result); diff --git a/sdk-output/iai_common_access/docs/Methods/IAICommonAccessV1Api.md b/sdk-output/iai_common_access/docs/Methods/IAICommonAccessV1Api.md new file mode 100644 index 00000000..8b1da839 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Methods/IAICommonAccessV1Api.md @@ -0,0 +1,159 @@ +--- +id: v1-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAICommonAccess', 'v1IAICommonAccess'] +slug: /tools/sdk/typescript/iai_common_access/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'v1IAICommonAccess'] +--- + +# IAICommonAccessV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-common-access-v1**](#create-common-access-v1) | **POST** `/common-access/v1` | Create common access items +[**get-common-access-v1**](#get-common-access-v1) | **GET** `/common-access/v1` | Get a paginated list of common access +[**update-common-access-status-in-bulk-v1**](#update-common-access-status-in-bulk-v1) | **POST** `/common-access/v1/update-status` | Bulk update common access status + + +## create-common-access-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create common access items +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-common-access-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**commonaccessitemrequestV1** | **CommonaccessitemrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**CommonaccessitemresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAICommonAccessV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAICommonAccessV1Api(configuration); +const commonaccessitemrequestV1: CommonaccessitemrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createCommonAccessV1(commonaccessitemrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-common-access-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get a paginated list of common access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-common-access-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAICommonAccessV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAICommonAccessV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = access.type eq "ROLE"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) +const sorters: string = access.name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getCommonAccessV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-common-access-status-in-bulk-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Bulk update common access status +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-common-access-status-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**commonaccessidstatusV1** | **Array<CommonaccessidstatusV1>** | Confirm or deny in bulk the common access ids that are (or aren\'t) common access | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAICommonAccessV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAICommonAccessV1Api(configuration); +const commonaccessidstatusV1: Array<CommonaccessidstatusV1> = ; // Confirm or deny in bulk the common access ids that are (or aren\'t) common access +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateCommonAccessStatusInBulkV1(commonaccessidstatusV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_common_access/docs/Methods/Index.md b/sdk-output/iai_common_access/docs/Methods/Index.md new file mode 100644 index 00000000..44f41284 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_common_access-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_common_access-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_common_access', 'methods'] +slug: /tools/sdk/typescript/iai_common_access/methods +tags: ['SDK', 'Software Development Kit', 'iai_common_access', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessidstatus.md b/sdk-output/iai_common_access/docs/Models/Commonaccessidstatus.md new file mode 100644 index 00000000..6613510a --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessidstatus.md @@ -0,0 +1,20 @@ +--- +id: v1-commonaccessidstatus-v1 +title: CommonaccessidstatusV1 +pagination_label: CommonaccessidstatusV1 +sidebar_label: CommonaccessidstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessidstatusV1', 'v1CommonaccessidstatusV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessidstatus-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessidstatusV1', 'v1CommonaccessidstatusV1'] +--- + +# CommonaccessidstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**confirmedIds** | **(optional)** **Array<string>** | List of confirmed common access ids. | [default to undefined] +**deniedIds** | **(optional)** **Array<string>** | List of denied common access ids. | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessitemaccess.md b/sdk-output/iai_common_access/docs/Models/Commonaccessitemaccess.md new file mode 100644 index 00000000..b0da788a --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessitemaccess.md @@ -0,0 +1,24 @@ +--- +id: v1-commonaccessitemaccess-v1 +title: CommonaccessitemaccessV1 +pagination_label: CommonaccessitemaccessV1 +sidebar_label: CommonaccessitemaccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessitemaccessV1', 'v1CommonaccessitemaccessV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessitemaccess-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessitemaccessV1', 'v1CommonaccessitemaccessV1'] +--- + +# CommonaccessitemaccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Common access ID | [default to undefined] +**type** | **(optional)** **CommonaccesstypeV1** | | [default to undefined] +**name** | **(optional)** **string** | Common access name | [default to undefined] +**description** | **(optional)** **string** | Common access description | [default to undefined] +**ownerName** | **(optional)** **string** | Common access owner name | [default to undefined] +**ownerId** | **(optional)** **string** | Common access owner ID | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessitemrequest.md b/sdk-output/iai_common_access/docs/Models/Commonaccessitemrequest.md new file mode 100644 index 00000000..dc4ed131 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessitemrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-commonaccessitemrequest-v1 +title: CommonaccessitemrequestV1 +pagination_label: CommonaccessitemrequestV1 +sidebar_label: CommonaccessitemrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessitemrequestV1', 'v1CommonaccessitemrequestV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessitemrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessitemrequestV1', 'v1CommonaccessitemrequestV1'] +--- + +# CommonaccessitemrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**access** | **(optional)** **CommonaccessitemaccessV1** | | [default to undefined] +**status** | **(optional)** **CommonaccessitemstateV1** | | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessitemresponse.md b/sdk-output/iai_common_access/docs/Models/Commonaccessitemresponse.md new file mode 100644 index 00000000..612ef2a0 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessitemresponse.md @@ -0,0 +1,25 @@ +--- +id: v1-commonaccessitemresponse-v1 +title: CommonaccessitemresponseV1 +pagination_label: CommonaccessitemresponseV1 +sidebar_label: CommonaccessitemresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessitemresponseV1', 'v1CommonaccessitemresponseV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessitemresponse-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessitemresponseV1', 'v1CommonaccessitemresponseV1'] +--- + +# CommonaccessitemresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Common Access Item ID | [default to undefined] +**access** | **(optional)** **CommonaccessitemaccessV1** | | [default to undefined] +**status** | **(optional)** **CommonaccessitemstateV1** | | [default to undefined] +**lastUpdated** | **(optional)** **string** | | [default to undefined] +**reviewedByUser** | **(optional)** **boolean** | | [default to undefined] +**lastReviewed** | **(optional)** **string** | | [default to undefined] +**createdByUser** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessitemstate.md b/sdk-output/iai_common_access/docs/Models/Commonaccessitemstate.md new file mode 100644 index 00000000..ecfecaff --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessitemstate.md @@ -0,0 +1,21 @@ +--- +id: v1-commonaccessitemstate-v1 +title: CommonaccessitemstateV1 +pagination_label: CommonaccessitemstateV1 +sidebar_label: CommonaccessitemstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessitemstateV1', 'v1CommonaccessitemstateV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessitemstate-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessitemstateV1', 'v1CommonaccessitemstateV1'] +--- + +# CommonaccessitemstateV1 + +## Enum + + +* `Confirmed` (value: `'CONFIRMED'`) + +* `Denied` (value: `'DENIED'`) + + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccessresponse.md b/sdk-output/iai_common_access/docs/Models/Commonaccessresponse.md new file mode 100644 index 00000000..5cb07073 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccessresponse.md @@ -0,0 +1,26 @@ +--- +id: v1-commonaccessresponse-v1 +title: CommonaccessresponseV1 +pagination_label: CommonaccessresponseV1 +sidebar_label: CommonaccessresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccessresponseV1', 'v1CommonaccessresponseV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccessresponse-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccessresponseV1', 'v1CommonaccessresponseV1'] +--- + +# CommonaccessresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique ID of the common access item | [default to undefined] +**access** | **(optional)** **CommonaccessitemaccessV1** | | [default to undefined] +**status** | **(optional)** **string** | CONFIRMED or DENIED | [default to undefined] +**commonAccessType** | **(optional)** **string** | | [default to undefined] +**lastUpdated** | **(optional)** **string** | | [readonly] [default to undefined] +**reviewedByUser** | **(optional)** **boolean** | true if user has confirmed or denied status | [default to undefined] +**lastReviewed** | **(optional)** **string** | | [readonly] [default to undefined] +**createdByUser** | **(optional)** **boolean** | | [default to false] + diff --git a/sdk-output/iai_common_access/docs/Models/Commonaccesstype.md b/sdk-output/iai_common_access/docs/Models/Commonaccesstype.md new file mode 100644 index 00000000..7be7779a --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Commonaccesstype.md @@ -0,0 +1,21 @@ +--- +id: v1-commonaccesstype-v1 +title: CommonaccesstypeV1 +pagination_label: CommonaccesstypeV1 +sidebar_label: CommonaccesstypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CommonaccesstypeV1', 'v1CommonaccesstypeV1'] +slug: /tools/sdk/typescript/iai_common_access/models/commonaccesstype-v1 +tags: ['SDK', 'Software Development Kit', 'CommonaccesstypeV1', 'v1CommonaccesstypeV1'] +--- + +# CommonaccesstypeV1 + +## Enum + + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Role` (value: `'ROLE'`) + + diff --git a/sdk-output/iai_common_access/docs/Models/CreateCommonAccessV1429Response.md b/sdk-output/iai_common_access/docs/Models/CreateCommonAccessV1429Response.md new file mode 100644 index 00000000..a8ed8525 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/CreateCommonAccessV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-create-common-access-v1429-response-v1 +title: CreateCommonAccessV1429ResponseV1 +pagination_label: CreateCommonAccessV1429ResponseV1 +sidebar_label: CreateCommonAccessV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateCommonAccessV1429ResponseV1', 'v1CreateCommonAccessV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_common_access/models/create-common-access-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateCommonAccessV1429ResponseV1', 'v1CreateCommonAccessV1429ResponseV1'] +--- + +# CreateCommonAccessV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Errormessagedto.md b/sdk-output/iai_common_access/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..4361e6a1 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_common_access/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Errorresponsedto.md b/sdk-output/iai_common_access/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..8c2e320a --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_common_access/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/GetCommonAccessV1401Response.md b/sdk-output/iai_common_access/docs/Models/GetCommonAccessV1401Response.md new file mode 100644 index 00000000..3c545d73 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/GetCommonAccessV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-common-access-v1401-response-v1 +title: GetCommonAccessV1401ResponseV1 +pagination_label: GetCommonAccessV1401ResponseV1 +sidebar_label: GetCommonAccessV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetCommonAccessV1401ResponseV1', 'v1GetCommonAccessV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_common_access/models/get-common-access-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetCommonAccessV1401ResponseV1', 'v1GetCommonAccessV1401ResponseV1'] +--- + +# GetCommonAccessV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_common_access/docs/Models/Index.md b/sdk-output/iai_common_access/docs/Models/Index.md new file mode 100644 index 00000000..41e0f8c8 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_common_access-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_common_access-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_common_access', 'models'] +slug: /tools/sdk/typescript/iai_common_access/models +tags: ['SDK', 'Software Development Kit', 'iai_common_access', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_common_access/docs/Models/Localeorigin.md b/sdk-output/iai_common_access/docs/Models/Localeorigin.md new file mode 100644 index 00000000..23739832 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_common_access/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_common_access/docs/Models/README.md b/sdk-output/iai_common_access/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_common_access/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_outliers/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_outliers/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..b374ca13 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,164 @@ +- path: /outliers/v1/export + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#export-outliers-zip-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const type: string = 'LOW_SIMILARITY'; // 'LOW_SIMILARITY' | 'STRUCTURAL' | Type of the identity outliers snapshot to filter on (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.exportOutliersZipV1(); + console.log(result); +- path: /outlier-summaries/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#get-identity-outlier-snapshots-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const type: string = 'LOW_SIMILARITY'; // 'LOW_SIMILARITY' | 'STRUCTURAL' | Type of the identity outliers snapshot to filter on (optional) (default to undefined) + const filters: string = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) (default to undefined) + const sorters: string = 'snapshotDate'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentityOutlierSnapshotsV1(); + console.log(result); +- path: /outliers/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#get-identity-outliers-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const type: string = 'LOW_SIMILARITY'; // 'LOW_SIMILARITY' | 'STRUCTURAL' | Type of the identity outliers snapshot to filter on (optional) (default to undefined) + const filters: string = 'attributes.displayName sw "John" and certStatus eq "false"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) (default to undefined) + const sorters: string = 'attributes.displayName,firstDetectionDate,-score'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentityOutliersV1(); + console.log(result); +- path: /outlier-summaries/v1/latest + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#get-latest-identity-outlier-snapshots-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const type: string = 'LOW_SIMILARITY'; // 'LOW_SIMILARITY' | 'STRUCTURAL' | Type of the identity outliers snapshot to filter on (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getLatestIdentityOutlierSnapshotsV1(); + console.log(result); +- path: /outlier-feature-summaries/v1/{outlierFeatureId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#get-outlier-contributing-feature-summary-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const outlierFeatureId: string = '04654b66-7561-4090-94f9-abee0722a1af'; // string | Contributing feature id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getOutlierContributingFeatureSummaryV1(outlierFeatureId); + console.log(result); +- path: /outliers/v1/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#get-peer-group-outliers-contributing-features-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const outlierId: string = '2c918085842e69ae018432d22ccb212f'; // string | The outlier id (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const includeTranslationMessages: string = 'include-translation-messages='; // string | Whether or not to include translation messages object in returned response (optional) (default to undefined) + const sorters: string = 'importance'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPeerGroupOutliersContributingFeaturesV1(outlierId); + console.log(result); +- path: /outliers/v1/ignore + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#ignore-identity-outliers-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const requestBody: Array<string> = ; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.ignoreIdentityOutliersV1(requestBody); + console.log(result); +- path: /outliers/v1/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#list-outliers-contributing-feature-access-items-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const outlierId: string = '2c918085842e69ae018432d22ccb212f'; // string | The outlier id (default to undefined) + const contributingFeatureName: string = 'entitlement_count'; // 'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score' | The name of contributing feature (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const accessType: string = 'ENTITLEMENT'; // string | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) (default to undefined) + const sorters: string = 'displayName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listOutliersContributingFeatureAccessItemsV1(outlierId, contributingFeatureName); + console.log(result); +- path: /outliers/v1/unignore + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_outliers/methods/iai-outliers#un-ignore-identity-outliers-v1 + source: | + import { IAIOutliersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIOutliersV1Api(configuration); + const requestBody: Array<string> = ; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.unIgnoreIdentityOutliersV1(requestBody); + console.log(result); diff --git a/sdk-output/iai_outliers/docs/Methods/IAIOutliersV1Api.md b/sdk-output/iai_outliers/docs/Methods/IAIOutliersV1Api.md new file mode 100644 index 00000000..a1a8a977 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Methods/IAIOutliersV1Api.md @@ -0,0 +1,467 @@ +--- +id: v1-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAIOutliers', 'v1IAIOutliers'] +slug: /tools/sdk/typescript/iai_outliers/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'v1IAIOutliers'] +--- + +# IAIOutliersV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-outliers-zip-v1**](#export-outliers-zip-v1) | **GET** `/outliers/v1/export` | Iai identity outliers export +[**get-identity-outlier-snapshots-v1**](#get-identity-outlier-snapshots-v1) | **GET** `/outlier-summaries/v1` | Iai identity outliers summary +[**get-identity-outliers-v1**](#get-identity-outliers-v1) | **GET** `/outliers/v1` | Iai get identity outliers +[**get-latest-identity-outlier-snapshots-v1**](#get-latest-identity-outlier-snapshots-v1) | **GET** `/outlier-summaries/v1/latest` | Iai identity outliers latest summary +[**get-outlier-contributing-feature-summary-v1**](#get-outlier-contributing-feature-summary-v1) | **GET** `/outlier-feature-summaries/v1/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**get-peer-group-outliers-contributing-features-v1**](#get-peer-group-outliers-contributing-features-v1) | **GET** `/outliers/v1/{outlierId}/contributing-features` | Get identity outlier\'s contibuting features +[**ignore-identity-outliers-v1**](#ignore-identity-outliers-v1) | **POST** `/outliers/v1/ignore` | Iai identity outliers ignore +[**list-outliers-contributing-feature-access-items-v1**](#list-outliers-contributing-feature-access-items-v1) | **GET** `/outliers/v1/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**un-ignore-identity-outliers-v1**](#un-ignore-identity-outliers-v1) | **POST** `/outliers/v1/unignore` | Iai identity outliers unignore + + +## export-outliers-zip-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai identity outliers export +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-outliers-zip-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'LOW_SIMILARITY' | 'STRUCTURAL'** | Type of the identity outliers snapshot to filter on | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.exportOutliersZipV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-outlier-snapshots-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai identity outliers summary +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-outlier-snapshots-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**type** | **'LOW_SIMILARITY' | 'STRUCTURAL'** | Type of the identity outliers snapshot to filter on | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional) +const filters: string = snapshotDate ge "2022-02-07T20:13:29.356648026Z"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) +const sorters: string = snapshotDate; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentityOutlierSnapshotsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-outliers-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai get identity outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-outliers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**type** | **'LOW_SIMILARITY' | 'STRUCTURAL'** | Type of the identity outliers snapshot to filter on | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional) +const filters: string = attributes.displayName sw "John" and certStatus eq "false"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) +const sorters: string = attributes.displayName,firstDetectionDate,-score; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentityOutliersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-latest-identity-outlier-snapshots-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai identity outliers latest summary +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-latest-identity-outlier-snapshots-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'LOW_SIMILARITY' | 'STRUCTURAL'** | Type of the identity outliers snapshot to filter on | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const type: string = LOW_SIMILARITY; // Type of the identity outliers snapshot to filter on (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getLatestIdentityOutlierSnapshotsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-outlier-contributing-feature-summary-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get identity outlier contibuting feature summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-outlier-contributing-feature-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**outlierFeatureId** | **string** | Contributing feature id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**OutlierfeaturesummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const outlierFeatureId: string = 04654b66-7561-4090-94f9-abee0722a1af; // Contributing feature id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getOutlierContributingFeatureSummaryV1(outlierFeatureId); +console.log(result); +``` + +[[Back to top]](#) + +## get-peer-group-outliers-contributing-features-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get identity outlier\'s contibuting features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-peer-group-outliers-contributing-features-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**outlierId** | **string** | The outlier id | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**includeTranslationMessages** | **string** | Whether or not to include translation messages object in returned response | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const outlierId: string = 2c918085842e69ae018432d22ccb212f; // The outlier id +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const includeTranslationMessages: string = include-translation-messages=; // Whether or not to include translation messages object in returned response (optional) +const sorters: string = importance; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPeerGroupOutliersContributingFeaturesV1(outlierId); +console.log(result); +``` + +[[Back to top]](#) + +## ignore-identity-outliers-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai identity outliers ignore +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/ignore-identity-outliers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestBody** | **Array<string>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const requestBody: Array<string> = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.ignoreIdentityOutliersV1(requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## list-outliers-contributing-feature-access-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets a list of access items associated with each identity outlier contributing feature +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-outliers-contributing-feature-access-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**outlierId** | **string** | The outlier id | [default to undefined] +**contributingFeatureName** | **'radical_entitlement_count' | 'entitlement_count' | 'max_jaccard_similarity' | 'mean_max_bundle_concurrency' | 'single_entitlement_bundle_count' | 'peerless_score'** | The name of contributing feature | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**accessType** | **string** | The type of access item for the identity outlier contributing feature. If not provided, it returns all. | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const outlierId: string = 2c918085842e69ae018432d22ccb212f; // The outlier id +const contributingFeatureName: string = entitlement_count; // The name of contributing feature +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const accessType: string = ENTITLEMENT; // The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) +const sorters: string = displayName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listOutliersContributingFeatureAccessItemsV1(outlierId, contributingFeatureName); +console.log(result); +``` + +[[Back to top]](#) + +## un-ignore-identity-outliers-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Iai identity outliers unignore +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/un-ignore-identity-outliers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestBody** | **Array<string>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIOutliersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIOutliersV1Api(configuration); +const requestBody: Array<string> = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.unIgnoreIdentityOutliersV1(requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_outliers/docs/Methods/Index.md b/sdk-output/iai_outliers/docs/Methods/Index.md new file mode 100644 index 00000000..a54795b2 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_outliers-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_outliers-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_outliers', 'methods'] +slug: /tools/sdk/typescript/iai_outliers/methods +tags: ['SDK', 'Software Development Kit', 'iai_outliers', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_outliers/docs/Models/Errormessagedto.md b/sdk-output/iai_outliers/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..2004360e --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_outliers/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Errorresponsedto.md b/sdk-output/iai_outliers/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..c3d607c6 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_outliers/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1401Response.md b/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1401Response.md new file mode 100644 index 00000000..1a66f79b --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-identity-outlier-snapshots-v1401-response-v1 +title: GetIdentityOutlierSnapshotsV1401ResponseV1 +pagination_label: GetIdentityOutlierSnapshotsV1401ResponseV1 +sidebar_label: GetIdentityOutlierSnapshotsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityOutlierSnapshotsV1401ResponseV1', 'v1GetIdentityOutlierSnapshotsV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_outliers/models/get-identity-outlier-snapshots-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetIdentityOutlierSnapshotsV1401ResponseV1', 'v1GetIdentityOutlierSnapshotsV1401ResponseV1'] +--- + +# GetIdentityOutlierSnapshotsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1429Response.md b/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1429Response.md new file mode 100644 index 00000000..a53636f5 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/GetIdentityOutlierSnapshotsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-identity-outlier-snapshots-v1429-response-v1 +title: GetIdentityOutlierSnapshotsV1429ResponseV1 +pagination_label: GetIdentityOutlierSnapshotsV1429ResponseV1 +sidebar_label: GetIdentityOutlierSnapshotsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetIdentityOutlierSnapshotsV1429ResponseV1', 'v1GetIdentityOutlierSnapshotsV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_outliers/models/get-identity-outlier-snapshots-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetIdentityOutlierSnapshotsV1429ResponseV1', 'v1GetIdentityOutlierSnapshotsV1429ResponseV1'] +--- + +# GetIdentityOutlierSnapshotsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Index.md b/sdk-output/iai_outliers/docs/Models/Index.md new file mode 100644 index 00000000..39a11275 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_outliers-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_outliers-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_outliers', 'models'] +slug: /tools/sdk/typescript/iai_outliers/models +tags: ['SDK', 'Software Development Kit', 'iai_outliers', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_outliers/docs/Models/Latestoutliersummary.md b/sdk-output/iai_outliers/docs/Models/Latestoutliersummary.md new file mode 100644 index 00000000..7bd24044 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Latestoutliersummary.md @@ -0,0 +1,23 @@ +--- +id: v1-latestoutliersummary-v1 +title: LatestoutliersummaryV1 +pagination_label: LatestoutliersummaryV1 +sidebar_label: LatestoutliersummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LatestoutliersummaryV1', 'v1LatestoutliersummaryV1'] +slug: /tools/sdk/typescript/iai_outliers/models/latestoutliersummary-v1 +tags: ['SDK', 'Software Development Kit', 'LatestoutliersummaryV1', 'v1LatestoutliersummaryV1'] +--- + +# LatestoutliersummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of outlier summary | [default to undefined] +**snapshotDate** | **(optional)** **string** | The date the bulk outlier detection ran/snapshot was created | [default to undefined] +**totalOutliers** | **(optional)** **number** | Total number of outliers for the customer making the request | [default to undefined] +**totalIdentities** | **(optional)** **number** | Total number of identities for the customer making the request | [default to undefined] +**totalIgnored** | **(optional)** **number** | Total number of ignored outliers | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Localeorigin.md b/sdk-output/iai_outliers/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dd68759c --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_outliers/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_outliers/docs/Models/Outlier.md b/sdk-output/iai_outliers/docs/Models/Outlier.md new file mode 100644 index 00000000..7532fe1e --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outlier.md @@ -0,0 +1,29 @@ +--- +id: v1-outlier-v1 +title: OutlierV1 +pagination_label: OutlierV1 +sidebar_label: OutlierV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutlierV1', 'v1OutlierV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outlier-v1 +tags: ['SDK', 'Software Development Kit', 'OutlierV1', 'v1OutlierV1'] +--- + +# OutlierV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity\'s unique identifier for the outlier record | [default to undefined] +**identityId** | **(optional)** **string** | The ID of the identity that is detected as an outlier | [default to undefined] +**type** | **(optional)** **string** | The type of outlier summary | [default to undefined] +**firstDetectionDate** | **(optional)** **string** | The first date the outlier was detected | [default to undefined] +**latestDetectionDate** | **(optional)** **string** | The most recent date the outlier was detected | [default to undefined] +**ignored** | **(optional)** **boolean** | Flag whether or not the outlier has been ignored | [default to undefined] +**attributes** | **(optional)** **object** | Object containing mapped identity attributes | [default to undefined] +**score** | **(optional)** **number** | The outlier score determined by the detection engine ranging from 0..1 | [default to undefined] +**unignoreType** | **(optional)** **string** | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [default to undefined] +**unignoreDate** | **(optional)** **string** | shows date when last time has been unignored outlier | [default to undefined] +**ignoreDate** | **(optional)** **string** | shows date when last time has been ignored outlier | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Outliercontributingfeature.md b/sdk-output/iai_outliers/docs/Models/Outliercontributingfeature.md new file mode 100644 index 00000000..17b739d0 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outliercontributingfeature.md @@ -0,0 +1,26 @@ +--- +id: v1-outliercontributingfeature-v1 +title: OutliercontributingfeatureV1 +pagination_label: OutliercontributingfeatureV1 +sidebar_label: OutliercontributingfeatureV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutliercontributingfeatureV1', 'v1OutliercontributingfeatureV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outliercontributingfeature-v1 +tags: ['SDK', 'Software Development Kit', 'OutliercontributingfeatureV1', 'v1OutliercontributingfeatureV1'] +--- + +# OutliercontributingfeatureV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Contributing feature id | [default to undefined] +**name** | **(optional)** **string** | The name of the feature | [default to undefined] +**valueType** | **(optional)** **OutliervaluetypeV1** | | [default to undefined] +**value** | **(optional)** **number** | The feature value | [default to undefined] +**importance** | **(optional)** **number** | The importance of the feature. This can also be a negative value | [default to undefined] +**displayName** | **(optional)** **string** | The (translated if header is passed) displayName for the feature | [default to undefined] +**description** | **(optional)** **string** | The (translated if header is passed) description for the feature | [default to undefined] +**translationMessages** | **(optional)** **OutlierfeaturetranslationV1** | | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Outlierfeaturesummary.md b/sdk-output/iai_outliers/docs/Models/Outlierfeaturesummary.md new file mode 100644 index 00000000..ab4c7f1d --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outlierfeaturesummary.md @@ -0,0 +1,26 @@ +--- +id: v1-outlierfeaturesummary-v1 +title: OutlierfeaturesummaryV1 +pagination_label: OutlierfeaturesummaryV1 +sidebar_label: OutlierfeaturesummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutlierfeaturesummaryV1', 'v1OutlierfeaturesummaryV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outlierfeaturesummary-v1 +tags: ['SDK', 'Software Development Kit', 'OutlierfeaturesummaryV1', 'v1OutlierfeaturesummaryV1'] +--- + +# OutlierfeaturesummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contributingFeatureName** | **(optional)** **string** | Contributing feature name | [default to undefined] +**identityOutlierDisplayName** | **(optional)** **string** | Identity display name | [default to undefined] +**outlierFeatureDisplayValues** | **(optional)** **Array<OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1>** | | [default to undefined] +**featureDefinition** | **(optional)** **string** | Definition of the feature | [default to undefined] +**featureExplanation** | **(optional)** **string** | Detailed explanation of the feature | [default to undefined] +**peerDisplayName** | **(optional)** **string** | outlier\'s peer identity display name | [default to undefined] +**peerIdentityId** | **(optional)** **string** | outlier\'s peer identity id | [default to undefined] +**accessItemReference** | **(optional)** **object** | Access Item reference | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/OutlierfeaturesummaryOutlierFeatureDisplayValuesInner.md b/sdk-output/iai_outliers/docs/Models/OutlierfeaturesummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 00000000..f3673aa8 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/OutlierfeaturesummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-outlierfeaturesummary-outlier-feature-display-values-inner-v1 +title: OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 +pagination_label: OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 +sidebar_label: OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1', 'v1OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outlierfeaturesummary-outlier-feature-display-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1', 'v1OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1'] +--- + +# OutlierfeaturesummaryOutlierFeatureDisplayValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayName** | **(optional)** **string** | display name | [default to undefined] +**value** | **(optional)** **string** | value | [default to undefined] +**valueType** | **(optional)** **OutliervaluetypeV1** | | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Outlierfeaturetranslation.md b/sdk-output/iai_outliers/docs/Models/Outlierfeaturetranslation.md new file mode 100644 index 00000000..fa595a8b --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outlierfeaturetranslation.md @@ -0,0 +1,20 @@ +--- +id: v1-outlierfeaturetranslation-v1 +title: OutlierfeaturetranslationV1 +pagination_label: OutlierfeaturetranslationV1 +sidebar_label: OutlierfeaturetranslationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutlierfeaturetranslationV1', 'v1OutlierfeaturetranslationV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outlierfeaturetranslation-v1 +tags: ['SDK', 'Software Development Kit', 'OutlierfeaturetranslationV1', 'v1OutlierfeaturetranslationV1'] +--- + +# OutlierfeaturetranslationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayName** | **(optional)** **TranslationmessageV1** | | [default to undefined] +**description** | **(optional)** **TranslationmessageV1** | | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/Outlierscontributingfeatureaccessitems.md b/sdk-output/iai_outliers/docs/Models/Outlierscontributingfeatureaccessitems.md new file mode 100644 index 00000000..35e2baf3 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outlierscontributingfeatureaccessitems.md @@ -0,0 +1,24 @@ +--- +id: v1-outlierscontributingfeatureaccessitems-v1 +title: OutlierscontributingfeatureaccessitemsV1 +pagination_label: OutlierscontributingfeatureaccessitemsV1 +sidebar_label: OutlierscontributingfeatureaccessitemsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutlierscontributingfeatureaccessitemsV1', 'v1OutlierscontributingfeatureaccessitemsV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outlierscontributingfeatureaccessitems-v1 +tags: ['SDK', 'Software Development Kit', 'OutlierscontributingfeatureaccessitemsV1', 'v1OutlierscontributingfeatureaccessitemsV1'] +--- + +# OutlierscontributingfeatureaccessitemsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the access item | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the access item | [default to undefined] +**description** | **(optional)** **string** | Description of the access item. | [default to undefined] +**accessType** | **(optional)** **string** | The type of the access item. | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**extremelyRare** | **(optional)** **boolean** | rarest access | [default to false] + diff --git a/sdk-output/iai_outliers/docs/Models/Outliersummary.md b/sdk-output/iai_outliers/docs/Models/Outliersummary.md new file mode 100644 index 00000000..b3739ac5 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outliersummary.md @@ -0,0 +1,23 @@ +--- +id: v1-outliersummary-v1 +title: OutliersummaryV1 +pagination_label: OutliersummaryV1 +sidebar_label: OutliersummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutliersummaryV1', 'v1OutliersummaryV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outliersummary-v1 +tags: ['SDK', 'Software Development Kit', 'OutliersummaryV1', 'v1OutliersummaryV1'] +--- + +# OutliersummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of outlier summary | [default to undefined] +**snapshotDate** | **(optional)** **string** | The date the bulk outlier detection ran/snapshot was created | [default to undefined] +**totalOutliers** | **(optional)** **number** | Total number of outliers for the customer making the request | [default to undefined] +**totalIdentities** | **(optional)** **number** | Total number of identities for the customer making the request | [default to undefined] +**totalIgnored** | **(optional)** **number** | | [default to 0] + diff --git a/sdk-output/iai_outliers/docs/Models/Outliervaluetype.md b/sdk-output/iai_outliers/docs/Models/Outliervaluetype.md new file mode 100644 index 00000000..a5827943 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Outliervaluetype.md @@ -0,0 +1,20 @@ +--- +id: v1-outliervaluetype-v1 +title: OutliervaluetypeV1 +pagination_label: OutliervaluetypeV1 +sidebar_label: OutliervaluetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OutliervaluetypeV1', 'v1OutliervaluetypeV1'] +slug: /tools/sdk/typescript/iai_outliers/models/outliervaluetype-v1 +tags: ['SDK', 'Software Development Kit', 'OutliervaluetypeV1', 'v1OutliervaluetypeV1'] +--- + +# OutliervaluetypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The data type of the value field | [default to undefined] +**ordinal** | **(optional)** **number** | The position of the value type | [default to undefined] + diff --git a/sdk-output/iai_outliers/docs/Models/README.md b/sdk-output/iai_outliers/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_outliers/docs/Models/Translationmessage.md b/sdk-output/iai_outliers/docs/Models/Translationmessage.md new file mode 100644 index 00000000..8c5469bd --- /dev/null +++ b/sdk-output/iai_outliers/docs/Models/Translationmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-translationmessage-v1 +title: TranslationmessageV1 +pagination_label: TranslationmessageV1 +sidebar_label: TranslationmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TranslationmessageV1', 'v1TranslationmessageV1'] +slug: /tools/sdk/typescript/iai_outliers/models/translationmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TranslationmessageV1', 'v1TranslationmessageV1'] +--- + +# TranslationmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The key of the translation message | [default to undefined] +**values** | **(optional)** **Array<string>** | The values corresponding to the translation messages | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_peer_group_strategies/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e6340085 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,19 @@ +- path: /peer-group-strategies/v1/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_peer_group_strategies/methods/iai-peer-group-strategies#get-peer-group-outliers-v1 + source: | + import { IAIPeerGroupStrategiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIPeerGroupStrategiesV1Api(configuration); + const strategy: string = 'entitlement'; // 'entitlement' | The strategy used to create peer groups. Currently, \'entitlement\' is supported. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPeerGroupOutliersV1(strategy); + console.log(result); diff --git a/sdk-output/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesV1Api.md b/sdk-output/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesV1Api.md new file mode 100644 index 00000000..5be159a6 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesV1Api.md @@ -0,0 +1,72 @@ +--- +id: v1-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAIPeerGroupStrategies', 'v1IAIPeerGroupStrategies'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'v1IAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategiesV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-peer-group-outliers-v1**](#get-peer-group-outliers-v1) | **GET** `/peer-group-strategies/v1/{strategy}/identity-outliers` | Identity outliers list + + +## get-peer-group-outliers-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Identity outliers list +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-peer-group-outliers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**strategy** | **'entitlement'** | The strategy used to create peer groups. Currently, \'entitlement\' is supported. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIPeerGroupStrategiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIPeerGroupStrategiesV1Api(configuration); +const strategy: string = entitlement; // The strategy used to create peer groups. Currently, \'entitlement\' is supported. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPeerGroupOutliersV1(strategy); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_peer_group_strategies/docs/Methods/Index.md b/sdk-output/iai_peer_group_strategies/docs/Methods/Index.md new file mode 100644 index 00000000..e37f455a --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_peer_group_strategies-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_peer_group_strategies-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_peer_group_strategies', 'methods'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/methods +tags: ['SDK', 'Software Development Kit', 'iai_peer_group_strategies', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/Errormessagedto.md b/sdk-output/iai_peer_group_strategies/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..caaf71ec --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/Errorresponsedto.md b/sdk-output/iai_peer_group_strategies/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..224998cb --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1401Response.md b/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1401Response.md new file mode 100644 index 00000000..729002a5 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-peer-group-outliers-v1401-response-v1 +title: GetPeerGroupOutliersV1401ResponseV1 +pagination_label: GetPeerGroupOutliersV1401ResponseV1 +sidebar_label: GetPeerGroupOutliersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPeerGroupOutliersV1401ResponseV1', 'v1GetPeerGroupOutliersV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/get-peer-group-outliers-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPeerGroupOutliersV1401ResponseV1', 'v1GetPeerGroupOutliersV1401ResponseV1'] +--- + +# GetPeerGroupOutliersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1429Response.md b/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1429Response.md new file mode 100644 index 00000000..ac4c50a7 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/GetPeerGroupOutliersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-peer-group-outliers-v1429-response-v1 +title: GetPeerGroupOutliersV1429ResponseV1 +pagination_label: GetPeerGroupOutliersV1429ResponseV1 +sidebar_label: GetPeerGroupOutliersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPeerGroupOutliersV1429ResponseV1', 'v1GetPeerGroupOutliersV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/get-peer-group-outliers-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPeerGroupOutliersV1429ResponseV1', 'v1GetPeerGroupOutliersV1429ResponseV1'] +--- + +# GetPeerGroupOutliersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/Index.md b/sdk-output/iai_peer_group_strategies/docs/Models/Index.md new file mode 100644 index 00000000..8efeff47 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_peer_group_strategies-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_peer_group_strategies-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_peer_group_strategies', 'models'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models +tags: ['SDK', 'Software Development Kit', 'iai_peer_group_strategies', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/Localeorigin.md b/sdk-output/iai_peer_group_strategies/docs/Models/Localeorigin.md new file mode 100644 index 00000000..db1d717e --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/Peergroupmember.md b/sdk-output/iai_peer_group_strategies/docs/Models/Peergroupmember.md new file mode 100644 index 00000000..6bcb487e --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/Peergroupmember.md @@ -0,0 +1,22 @@ +--- +id: v1-peergroupmember-v1 +title: PeergroupmemberV1 +pagination_label: PeergroupmemberV1 +sidebar_label: PeergroupmemberV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PeergroupmemberV1', 'v1PeergroupmemberV1'] +slug: /tools/sdk/typescript/iai_peer_group_strategies/models/peergroupmember-v1 +tags: ['SDK', 'Software Development Kit', 'PeergroupmemberV1', 'v1PeergroupmemberV1'] +--- + +# PeergroupmemberV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | A unique identifier for the peer group member. | [default to undefined] +**type** | **(optional)** **string** | The type of the peer group member. | [default to undefined] +**peer_group_id** | **(optional)** **string** | The ID of the peer group. | [default to undefined] +**attributes** | **(optional)** | Arbitrary key-value pairs, belonging to the peer group member. | [default to undefined] + diff --git a/sdk-output/iai_peer_group_strategies/docs/Models/README.md b/sdk-output/iai_peer_group_strategies/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_peer_group_strategies/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_recommendations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_recommendations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..50d9770c --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,47 @@ +- path: /recommendations/v1/config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_recommendations/methods/iai-recommendations#get-recommendations-config-v1 + source: | + import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRecommendationsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRecommendationsConfigV1(); + console.log(result); +- path: /recommendations/v1/request + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_recommendations/methods/iai-recommendations#get-recommendations-v1 + source: | + import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRecommendationsV1Api(configuration); + const recommendationrequestdtoV1: RecommendationrequestdtoV1 = ; // RecommendationrequestdtoV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRecommendationsV1(recommendationrequestdtoV1); + console.log(result); +- path: /recommendations/v1/config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_recommendations/methods/iai-recommendations#update-recommendations-config-v1 + source: | + import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRecommendationsV1Api(configuration); + const recommendationconfigdtoV1: RecommendationconfigdtoV1 = ; // RecommendationconfigdtoV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateRecommendationsConfigV1(recommendationconfigdtoV1); + console.log(result); diff --git a/sdk-output/iai_recommendations/docs/Methods/IAIRecommendationsV1Api.md b/sdk-output/iai_recommendations/docs/Methods/IAIRecommendationsV1Api.md new file mode 100644 index 00000000..55beeee9 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Methods/IAIRecommendationsV1Api.md @@ -0,0 +1,149 @@ +--- +id: v1-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAIRecommendations', 'v1IAIRecommendations'] +slug: /tools/sdk/typescript/iai_recommendations/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'v1IAIRecommendations'] +--- + +# IAIRecommendationsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-recommendations-config-v1**](#get-recommendations-config-v1) | **GET** `/recommendations/v1/config` | Get certification recommendation config values +[**get-recommendations-v1**](#get-recommendations-v1) | **POST** `/recommendations/v1/request` | Returns recommendation based on object +[**update-recommendations-config-v1**](#update-recommendations-config-v1) | **PUT** `/recommendations/v1/config` | Update certification recommendation config values + + +## get-recommendations-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get certification recommendation config values +Retrieves configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-recommendations-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RecommendationconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRecommendationsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRecommendationsConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-recommendations-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Returns recommendation based on object +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-recommendations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**recommendationrequestdtoV1** | **RecommendationrequestdtoV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RecommendationresponsedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRecommendationsV1Api(configuration); +const recommendationrequestdtoV1: RecommendationrequestdtoV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRecommendationsV1(recommendationrequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-recommendations-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update certification recommendation config values +Updates configuration attributes used by certification recommendations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-recommendations-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**recommendationconfigdtoV1** | **RecommendationconfigdtoV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RecommendationconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRecommendationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRecommendationsV1Api(configuration); +const recommendationconfigdtoV1: RecommendationconfigdtoV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateRecommendationsConfigV1(recommendationconfigdtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_recommendations/docs/Methods/Index.md b/sdk-output/iai_recommendations/docs/Methods/Index.md new file mode 100644 index 00000000..35f962b3 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_recommendations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_recommendations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_recommendations', 'methods'] +slug: /tools/sdk/typescript/iai_recommendations/methods +tags: ['SDK', 'Software Development Kit', 'iai_recommendations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_recommendations/docs/Models/Accessitemref.md b/sdk-output/iai_recommendations/docs/Models/Accessitemref.md new file mode 100644 index 00000000..443bfd64 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Accessitemref.md @@ -0,0 +1,20 @@ +--- +id: v1-accessitemref-v1 +title: AccessitemrefV1 +pagination_label: AccessitemrefV1 +sidebar_label: AccessitemrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrefV1', 'v1AccessitemrefV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/accessitemref-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrefV1', 'v1AccessitemrefV1'] +--- + +# AccessitemrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the access item to retrieve the recommendation for. | [default to undefined] +**type** | **(optional)** **string** | Access item\'s type. | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Errormessagedto.md b/sdk-output/iai_recommendations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..29419945 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Errorresponsedto.md b/sdk-output/iai_recommendations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..0ee775ef --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Featurevaluedto.md b/sdk-output/iai_recommendations/docs/Models/Featurevaluedto.md new file mode 100644 index 00000000..1f1573ef --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Featurevaluedto.md @@ -0,0 +1,21 @@ +--- +id: v1-featurevaluedto-v1 +title: FeaturevaluedtoV1 +pagination_label: FeaturevaluedtoV1 +sidebar_label: FeaturevaluedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FeaturevaluedtoV1', 'v1FeaturevaluedtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/featurevaluedto-v1 +tags: ['SDK', 'Software Development Kit', 'FeaturevaluedtoV1', 'v1FeaturevaluedtoV1'] +--- + +# FeaturevaluedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**feature** | **(optional)** **string** | The type of feature | [default to undefined] +**numerator** | **(optional)** **number** | The number of identities that have access to the feature | [default to undefined] +**denominator** | **(optional)** **number** | The number of identities with the corresponding feature | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1401Response.md b/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1401Response.md new file mode 100644 index 00000000..f01a0e8f --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-recommendations-v1401-response-v1 +title: GetRecommendationsV1401ResponseV1 +pagination_label: GetRecommendationsV1401ResponseV1 +sidebar_label: GetRecommendationsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetRecommendationsV1401ResponseV1', 'v1GetRecommendationsV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/get-recommendations-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetRecommendationsV1401ResponseV1', 'v1GetRecommendationsV1401ResponseV1'] +--- + +# GetRecommendationsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1429Response.md b/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1429Response.md new file mode 100644 index 00000000..f0600aff --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/GetRecommendationsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-recommendations-v1429-response-v1 +title: GetRecommendationsV1429ResponseV1 +pagination_label: GetRecommendationsV1429ResponseV1 +sidebar_label: GetRecommendationsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetRecommendationsV1429ResponseV1', 'v1GetRecommendationsV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/get-recommendations-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetRecommendationsV1429ResponseV1', 'v1GetRecommendationsV1429ResponseV1'] +--- + +# GetRecommendationsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Index.md b/sdk-output/iai_recommendations/docs/Models/Index.md new file mode 100644 index 00000000..4bbe744b --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_recommendations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_recommendations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_recommendations', 'models'] +slug: /tools/sdk/typescript/iai_recommendations/models +tags: ['SDK', 'Software Development Kit', 'iai_recommendations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_recommendations/docs/Models/Localeorigin.md b/sdk-output/iai_recommendations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..5da81a7d --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_recommendations/docs/Models/README.md b/sdk-output/iai_recommendations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendationconfigdto.md b/sdk-output/iai_recommendations/docs/Models/Recommendationconfigdto.md new file mode 100644 index 00000000..b83d88d1 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendationconfigdto.md @@ -0,0 +1,22 @@ +--- +id: v1-recommendationconfigdto-v1 +title: RecommendationconfigdtoV1 +pagination_label: RecommendationconfigdtoV1 +sidebar_label: RecommendationconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationconfigdtoV1', 'v1RecommendationconfigdtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendationconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationconfigdtoV1', 'v1RecommendationconfigdtoV1'] +--- + +# RecommendationconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommenderFeatures** | **(optional)** **Array<string>** | List of identity attributes to use for calculating certification recommendations | [default to undefined] +**peerGroupPercentageThreshold** | **(optional)** **number** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [default to undefined] +**runAutoSelectOnce** | **(optional)** **boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [default to false] +**onlyTuneThreshold** | **(optional)** **boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [default to false] + diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendationrequest.md b/sdk-output/iai_recommendations/docs/Models/Recommendationrequest.md new file mode 100644 index 00000000..50c34459 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendationrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-recommendationrequest-v1 +title: RecommendationrequestV1 +pagination_label: RecommendationrequestV1 +sidebar_label: RecommendationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationrequestV1', 'v1RecommendationrequestV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationrequestV1', 'v1RecommendationrequestV1'] +--- + +# RecommendationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The identity ID | [default to undefined] +**item** | **(optional)** **AccessitemrefV1** | | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendationrequestdto.md b/sdk-output/iai_recommendations/docs/Models/Recommendationrequestdto.md new file mode 100644 index 00000000..46010c70 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendationrequestdto.md @@ -0,0 +1,23 @@ +--- +id: v1-recommendationrequestdto-v1 +title: RecommendationrequestdtoV1 +pagination_label: RecommendationrequestdtoV1 +sidebar_label: RecommendationrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationrequestdtoV1', 'v1RecommendationrequestdtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendationrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationrequestdtoV1', 'v1RecommendationrequestdtoV1'] +--- + +# RecommendationrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requests** | **(optional)** **Array<RecommendationrequestV1>** | | [default to undefined] +**excludeInterpretations** | **(optional)** **boolean** | Exclude interpretations in the response if \"true\". Return interpretations in the response if this attribute is not specified. | [default to false] +**includeTranslationMessages** | **(optional)** **boolean** | When set to true, the calling system uses the translated messages for the specified language | [default to false] +**includeDebugInformation** | **(optional)** **boolean** | Returns the recommender calculations if set to true | [default to false] +**prescribeMode** | **(optional)** **boolean** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [default to false] + diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendationresponse.md b/sdk-output/iai_recommendations/docs/Models/Recommendationresponse.md new file mode 100644 index 00000000..ac04a79d --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendationresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-recommendationresponse-v1 +title: RecommendationresponseV1 +pagination_label: RecommendationresponseV1 +sidebar_label: RecommendationresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationresponseV1', 'v1RecommendationresponseV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendationresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationresponseV1', 'v1RecommendationresponseV1'] +--- + +# RecommendationresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**request** | **(optional)** **RecommendationrequestV1** | | [default to undefined] +**recommendation** | **(optional)** **string** | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [default to undefined] +**interpretations** | **(optional)** **Array<string>** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ \"Not approved in the last 6 months.\" ]. Interpretations will be translated using the client\'s locale as found in the Accept-Language header. If a translation for the client\'s locale cannot be found, the US English translation will be returned. | [default to undefined] +**translationMessages** | **(optional)** **Array<TranslationmessageV1>** | The list of translation messages, if they have been requested. | [default to undefined] +**recommenderCalculations** | **(optional)** **RecommendercalculationsV1** | | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendationresponsedto.md b/sdk-output/iai_recommendations/docs/Models/Recommendationresponsedto.md new file mode 100644 index 00000000..82acad32 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendationresponsedto.md @@ -0,0 +1,19 @@ +--- +id: v1-recommendationresponsedto-v1 +title: RecommendationresponsedtoV1 +pagination_label: RecommendationresponsedtoV1 +sidebar_label: RecommendationresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendationresponsedtoV1', 'v1RecommendationresponsedtoV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendationresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendationresponsedtoV1', 'v1RecommendationresponsedtoV1'] +--- + +# RecommendationresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**response** | **(optional)** **Array<RecommendationresponseV1>** | | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Recommendercalculations.md b/sdk-output/iai_recommendations/docs/Models/Recommendercalculations.md new file mode 100644 index 00000000..e0b7c0a7 --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Recommendercalculations.md @@ -0,0 +1,26 @@ +--- +id: v1-recommendercalculations-v1 +title: RecommendercalculationsV1 +pagination_label: RecommendercalculationsV1 +sidebar_label: RecommendercalculationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendercalculationsV1', 'v1RecommendercalculationsV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendercalculations-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendercalculationsV1', 'v1RecommendercalculationsV1'] +--- + +# RecommendercalculationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The ID of the identity | [default to undefined] +**entitlementId** | **(optional)** **string** | The entitlement ID | [default to undefined] +**recommendation** | **(optional)** **string** | The actual recommendation | [default to undefined] +**overallWeightedScore** | **(optional)** **number** | The overall weighted score | [default to undefined] +**featureWeightedScores** | **(optional)** | The weighted score of each individual feature | [default to undefined] +**threshold** | **(optional)** **number** | The configured value against which the overallWeightedScore is compared | [default to undefined] +**identityAttributes** | **(optional)** | The values for your configured features | [default to undefined] +**featureValues** | **(optional)** **FeaturevaluedtoV1** | | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/RecommendercalculationsIdentityAttributesValue.md b/sdk-output/iai_recommendations/docs/Models/RecommendercalculationsIdentityAttributesValue.md new file mode 100644 index 00000000..c61c93cf --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/RecommendercalculationsIdentityAttributesValue.md @@ -0,0 +1,19 @@ +--- +id: v1-recommendercalculations-identity-attributes-value-v1 +title: RecommendercalculationsIdentityAttributesValueV1 +pagination_label: RecommendercalculationsIdentityAttributesValueV1 +sidebar_label: RecommendercalculationsIdentityAttributesValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RecommendercalculationsIdentityAttributesValueV1', 'v1RecommendercalculationsIdentityAttributesValueV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/recommendercalculations-identity-attributes-value-v1 +tags: ['SDK', 'Software Development Kit', 'RecommendercalculationsIdentityAttributesValueV1', 'v1RecommendercalculationsIdentityAttributesValueV1'] +--- + +# RecommendercalculationsIdentityAttributesValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/iai_recommendations/docs/Models/Translationmessage.md b/sdk-output/iai_recommendations/docs/Models/Translationmessage.md new file mode 100644 index 00000000..8481758e --- /dev/null +++ b/sdk-output/iai_recommendations/docs/Models/Translationmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-translationmessage-v1 +title: TranslationmessageV1 +pagination_label: TranslationmessageV1 +sidebar_label: TranslationmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TranslationmessageV1', 'v1TranslationmessageV1'] +slug: /tools/sdk/typescript/iai_recommendations/models/translationmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TranslationmessageV1', 'v1TranslationmessageV1'] +--- + +# TranslationmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The key of the translation message | [default to undefined] +**values** | **(optional)** **Array<string>** | The values corresponding to the translation messages | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/iai_role_mining/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..c3686738 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,471 @@ +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#create-potential-role-provision-request-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const minEntitlementPopularity: number = 56; // number | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + const includeCommonAccess: boolean = true; // boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to true) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const roleminingpotentialroleprovisionrequestV1: RoleminingpotentialroleprovisionrequestV1 = ; // RoleminingpotentialroleprovisionrequestV1 | Required information to create a new role (optional) + const result = await apiInstance.createPotentialRoleProvisionRequestV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#create-role-mining-sessions-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const roleminingsessiondtoV1: RoleminingsessiondtoV1 = ; // RoleminingsessiondtoV1 | Role mining session parameters + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createRoleMiningSessionsV1(roleminingsessiondtoV1); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#download-role-mining-potential-role-zip-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '278359a6-04b7-4669-9468-924cf580964a'; // string | A potential role id in a role mining session (default to undefined) + const exportId: string = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40'; // string | The id of a previously run export job for this potential role (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.downloadRoleMiningPotentialRoleZipV1(sessionId, potentialRoleId, exportId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#export-role-mining-potential-role-async-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '278359a6-04b7-4669-9468-924cf580964a'; // string | A potential role id in a role mining session (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const roleminingpotentialroleexportrequestV1: RoleminingpotentialroleexportrequestV1 = ; // RoleminingpotentialroleexportrequestV1 | (optional) + const result = await apiInstance.exportRoleMiningPotentialRoleAsyncV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#export-role-mining-potential-role-status-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '278359a6-04b7-4669-9468-924cf580964a'; // string | A potential role id in a role mining session (default to undefined) + const exportId: string = '4940ffd4-836f-48a3-b2b0-6d498c3fdf40'; // string | The id of a previously run export job for this potential role (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.exportRoleMiningPotentialRoleStatusV1(sessionId, potentialRoleId, exportId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#export-role-mining-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.exportRoleMiningPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-potential-roles/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-all-potential-role-summaries-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sorters: string = 'createdDate'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) (default to undefined) + const filters: string = '(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getAllPotentialRoleSummariesV1(); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-entitlement-distribution-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const includeCommonAccess: boolean = true; // boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getEntitlementDistributionPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-entitlements-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const includeCommonAccess: boolean = true; // boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to true) + const sorters: string = 'popularity'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) (default to undefined) + const filters: string = 'applicationName sw "AD"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getEntitlementsPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-excluded-entitlements-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const sorters: string = 'populariity'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) (default to undefined) + const filters: string = 'applicationName sw "AD"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getExcludedEntitlementsPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-identities-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const filters: string = 'filters_example'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentitiesPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-potential-role-applications-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '62f28d91-7d9f-4d17-be15-666d5b41d77f'; // string | A potential role id in a role mining session (default to undefined) + const filters: string = 'applicationName sw "test"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPotentialRoleApplicationsV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-potential-role-entitlements-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '62f28d91-7d9f-4d17-be15-666d5b41d77f'; // string | A potential role id in a role mining session (default to undefined) + const filters: string = 'entitlementRef.name sw "test"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPotentialRoleEntitlementsV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-potential-roles/v1/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-potential-role-source-identity-usage-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const potentialRoleId: string = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923'; // string | A potential role id (default to undefined) + const sourceId: string = '2c9180877620c1460176267f336a106f'; // string | A source id (default to undefined) + const sorters: string = '-usageCount'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPotentialRoleSourceIdentityUsageV1(potentialRoleId, sourceId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-potential-role-summaries-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const sorters: string = 'createdDate'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) (default to undefined) + const filters: string = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPotentialRoleSummariesV1(sessionId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPotentialRoleV1(sessionId, potentialRoleId); + console.log(result); +- path: /role-mining-potential-roles/v1/{potentialRoleId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-role-mining-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleMiningPotentialRoleV1(potentialRoleId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-role-mining-session-status-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleMiningSessionStatusV1(sessionId); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-role-mining-session-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id to be retrieved. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleMiningSessionV1(sessionId); + console.log(result); +- path: /role-mining-sessions/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-role-mining-sessions-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const filters: string = 'saved eq "true" and name sw "RM Session"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'createdBy,createdDate'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleMiningSessionsV1(); + console.log(result); +- path: /role-mining-potential-roles/v1/saved + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#get-saved-potential-roles-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sorters: string = 'modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSavedPotentialRolesV1(); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#patch-potential-role-session-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The potential role summary id (default to undefined) + const jsonpatchoperationroleminingV1: Array<JsonpatchoperationroleminingV1> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchPotentialRoleSessionV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1); + console.log(result); +- path: /role-mining-potential-roles/v1/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#patch-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The potential role summary id (default to undefined) + const jsonpatchoperationroleminingV1: Array<JsonpatchoperationroleminingV1> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchPotentialRoleV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#patch-role-mining-session-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id to be patched (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/pruneThreshold","value":"83"},{"op":"replace","path":"/minNumIdentitiesInPotentialRole","value":"10"},{"op":"replace","path":"/saved","value":"false"},{"op":"replace","path":"/name","value":"RM Session - 07/10/22"},{"op":"add","path":"/name","value":"RM Session - 07/10/22"}]; // Array | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchRoleMiningSessionV1(sessionId, jsonpatchoperationV1); + console.log(result); +- path: /role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/iai_role_mining/methods/iai-role-mining#update-entitlements-potential-role-v1 + source: | + import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IAIRoleMiningV1Api(configuration); + const sessionId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role mining session id (default to undefined) + const potentialRoleId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | A potential role id in a role mining session (default to undefined) + const roleminingpotentialroleeditentitlementsV1: RoleminingpotentialroleeditentitlementsV1 = ; // RoleminingpotentialroleeditentitlementsV1 | Role mining session parameters + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateEntitlementsPotentialRoleV1(sessionId, potentialRoleId, roleminingpotentialroleeditentitlementsV1); + console.log(result); diff --git a/sdk-output/iai_role_mining/docs/Methods/IAIRoleMiningV1Api.md b/sdk-output/iai_role_mining/docs/Methods/IAIRoleMiningV1Api.md new file mode 100644 index 00000000..28568053 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Methods/IAIRoleMiningV1Api.md @@ -0,0 +1,1285 @@ +--- +id: v1-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IAIRoleMining', 'v1IAIRoleMining'] +slug: /tools/sdk/typescript/iai_role_mining/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'v1IAIRoleMining'] +--- + +# IAIRoleMiningV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-potential-role-provision-request-v1**](#create-potential-role-provision-request-v1) | **POST** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**create-role-mining-sessions-v1**](#create-role-mining-sessions-v1) | **POST** `/role-mining-sessions/v1` | Create a role mining session +[**download-role-mining-potential-role-zip-v1**](#download-role-mining-potential-role-zip-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**export-role-mining-potential-role-async-v1**](#export-role-mining-potential-role-async-v1) | **POST** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**export-role-mining-potential-role-status-v1**](#export-role-mining-potential-role-status-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**export-role-mining-potential-role-v1**](#export-role-mining-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**get-all-potential-role-summaries-v1**](#get-all-potential-role-summaries-v1) | **GET** `/role-mining-potential-roles/v1` | Retrieves all potential role summaries +[**get-entitlement-distribution-potential-role-v1**](#get-entitlement-distribution-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**get-entitlements-potential-role-v1**](#get-entitlements-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**get-excluded-entitlements-potential-role-v1**](#get-excluded-entitlements-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**get-identities-potential-role-v1**](#get-identities-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**get-potential-role-applications-v1**](#get-potential-role-applications-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**get-potential-role-entitlements-v1**](#get-potential-role-entitlements-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**get-potential-role-source-identity-usage-v1**](#get-potential-role-source-identity-usage-v1) | **GET** `/role-mining-potential-roles/v1/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**get-potential-role-summaries-v1**](#get-potential-role-summaries-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries +[**get-potential-role-v1**](#get-potential-role-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-potential-role-v1**](#get-role-mining-potential-role-v1) | **GET** `/role-mining-potential-roles/v1/{potentialRoleId}` | Retrieves a specific potential role +[**get-role-mining-session-status-v1**](#get-role-mining-session-status-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/status` | Get role mining session status state +[**get-role-mining-session-v1**](#get-role-mining-session-v1) | **GET** `/role-mining-sessions/v1/{sessionId}` | Get a role mining session +[**get-role-mining-sessions-v1**](#get-role-mining-sessions-v1) | **GET** `/role-mining-sessions/v1` | Retrieves all role mining sessions +[**get-saved-potential-roles-v1**](#get-saved-potential-roles-v1) | **GET** `/role-mining-potential-roles/v1/saved` | Retrieves all saved potential roles +[**patch-potential-role-session-v1**](#patch-potential-role-session-v1) | **PATCH** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role session +[**patch-potential-role-v1**](#patch-potential-role-v1) | **PATCH** `/role-mining-potential-roles/v1/{potentialRoleId}` | Update a potential role +[**patch-role-mining-session-v1**](#patch-role-mining-session-v1) | **PATCH** `/role-mining-sessions/v1/{sessionId}` | Patch a role mining session +[**update-entitlements-potential-role-v1**](#update-entitlements-potential-role-v1) | **POST** `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + + +## create-potential-role-provision-request-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create request to provision a potential role into an actual role. +This method starts a job to provision a potential role + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-potential-role-provision-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**minEntitlementPopularity** | **number** | Minimum popularity required for an entitlement to be included in the provisioned role. | [optional] [default to 0] +**includeCommonAccess** | **boolean** | Boolean determining whether common access entitlements will be included in the provisioned role. | [optional] [default to true] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**roleminingpotentialroleprovisionrequestV1** | **RoleminingpotentialroleprovisionrequestV1** | Required information to create a new role | [optional] + +### Return type + +**RoleminingpotentialrolesummaryV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const minEntitlementPopularity: number = 56; // Minimum popularity required for an entitlement to be included in the provisioned role. (optional) +const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included in the provisioned role. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const roleminingpotentialroleprovisionrequestV1: RoleminingpotentialroleprovisionrequestV1 = ; // Required information to create a new role (optional) +const result = await apiInstance.createPotentialRoleProvisionRequestV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## create-role-mining-sessions-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create a role mining session +This submits a create role mining session request to the role mining application. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-role-mining-sessions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleminingsessiondtoV1** | **RoleminingsessiondtoV1** | Role mining session parameters | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingsessionresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const roleminingsessiondtoV1: RoleminingsessiondtoV1 = ; // Role mining session parameters +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createRoleMiningSessionsV1(roleminingsessiondtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## download-role-mining-potential-role-zip-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads a completed export of information for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/download-role-mining-potential-role-zip-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**exportId** | **string** | The id of a previously run export job for this potential role | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session +const exportId: string = 4940ffd4-836f-48a3-b2b0-6d498c3fdf40; // The id of a previously run export job for this potential role +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.downloadRoleMiningPotentialRoleZipV1(sessionId, potentialRoleId, exportId); +console.log(result); +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-async-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Asynchronously export details for a potential role in a role mining session and upload to S3 +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-role-mining-potential-role-async-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**roleminingpotentialroleexportrequestV1** | **RoleminingpotentialroleexportrequestV1** | | [optional] + +### Return type + +**RoleminingpotentialroleexportresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const roleminingpotentialroleexportrequestV1: RoleminingpotentialroleexportrequestV1 = ; // (optional) +const result = await apiInstance.exportRoleMiningPotentialRoleAsyncV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-status-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve status of a potential role export job +This endpoint retrieves information about the current status of a potential role export. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-role-mining-potential-role-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**exportId** | **string** | The id of a previously run export job for this potential role | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingpotentialroleexportresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session +const exportId: string = 4940ffd4-836f-48a3-b2b0-6d498c3fdf40; // The id of a previously run export job for this potential role +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.exportRoleMiningPotentialRoleStatusV1(sessionId, potentialRoleId, exportId); +console.log(result); +``` + +[[Back to top]](#) + +## export-role-mining-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Export (download) details for a potential role in a role mining session +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-role-mining-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.exportRoleMiningPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-all-potential-role-summaries-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves all potential role summaries +Returns all potential role summaries that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-all-potential-role-summaries-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sorters: string = createdDate; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) +const filters: string = (createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true)); // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getAllPotentialRoleSummariesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-distribution-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves entitlement popularity distribution for a potential role in a role mining session +This method returns entitlement popularity distribution for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-distribution-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**includeCommonAccess** | **boolean** | Boolean determining whether common access entitlements will be included or not | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**{ [key: string]: number; }** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included or not (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getEntitlementDistributionPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlements-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves entitlements for a potential role in a role mining session +This method returns entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlements-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**includeCommonAccess** | **boolean** | Boolean determining whether common access entitlements will be included or not | [optional] [default to true] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included or not (optional) +const sorters: string = popularity; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) +const filters: string = applicationName sw "AD"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getEntitlementsPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-excluded-entitlements-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves excluded entitlements for a potential role in a role mining session +This method returns excluded entitlements for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-excluded-entitlements-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const sorters: string = populariity; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) +const filters: string = applicationName sw "AD"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getExcludedEntitlementsPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-identities-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves identities for a potential role in a role mining session +This method returns identities for a potential role in a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identities-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const filters: string = filters_example; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentitiesPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-potential-role-applications-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves the applications of a potential role for a role mining session +This method returns the applications of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-potential-role-applications-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 62f28d91-7d9f-4d17-be15-666d5b41d77f; // A potential role id in a role mining session +const filters: string = applicationName sw "test"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPotentialRoleApplicationsV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-potential-role-entitlements-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves the entitlements of a potential role for a role mining session +This method returns the entitlements of a potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-potential-role-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 62f28d91-7d9f-4d17-be15-666d5b41d77f; // A potential role id in a role mining session +const filters: string = entitlementRef.name sw "test"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPotentialRoleEntitlementsV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-potential-role-source-identity-usage-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves potential role source usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-potential-role-source-identity-usage-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**potentialRoleId** | **string** | A potential role id | [default to undefined] +**sourceId** | **string** | A source id | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const potentialRoleId: string = e0cc5d7d-bf7f-4f81-b2af-8885b09d9923; // A potential role id +const sourceId: string = 2c9180877620c1460176267f336a106f; // A source id +const sorters: string = -usageCount; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPotentialRoleSourceIdentityUsageV1(potentialRoleId, sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-potential-role-summaries-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves all potential role summaries +This method returns the potential role summaries for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-potential-role-summaries-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const sorters: string = createdDate; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) +const filters: string = (createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true)); // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPotentialRoleSummariesV1(sessionId); +console.log(result); +``` + +[[Back to top]](#) + +## get-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves a specific potential role +This method returns a specific potential role for a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingpotentialroleV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPotentialRoleV1(sessionId, potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-mining-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves a specific potential role +This method returns a specific potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-mining-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**potentialRoleId** | **string** | A potential role id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingpotentialroleV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleMiningPotentialRoleV1(potentialRoleId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-mining-session-status-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get role mining session status state +This method returns a role mining session status for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-mining-session-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingsessionstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleMiningSessionStatusV1(sessionId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-mining-session-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get a role mining session +The method retrieves a role mining session. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-mining-session-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id to be retrieved. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingsessionresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id to be retrieved. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleMiningSessionV1(sessionId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-mining-sessions-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves all role mining sessions +Returns all role mining sessions that match the query parameters + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-mining-sessions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const filters: string = saved eq "true" and name sw "RM Session"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) +const sorters: string = createdBy,createdDate; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleMiningSessionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-saved-potential-roles-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieves all saved potential roles +This method returns all saved potential roles (draft roles). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-saved-potential-roles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sorters: string = modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSavedPotentialRolesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-potential-role-session-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update a potential role session +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-potential-role-session-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | The potential role summary id | [default to undefined] +**jsonpatchoperationroleminingV1** | **Array<JsonpatchoperationroleminingV1>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The potential role summary id +const jsonpatchoperationroleminingV1: Array<JsonpatchoperationroleminingV1> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchPotentialRoleSessionV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update a potential role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | The potential role summary id | [default to undefined] +**jsonpatchoperationroleminingV1** | **Array<JsonpatchoperationroleminingV1>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The potential role summary id +const jsonpatchoperationroleminingV1: Array<JsonpatchoperationroleminingV1> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchPotentialRoleV1(sessionId, potentialRoleId, jsonpatchoperationroleminingV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-role-mining-session-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch a role mining session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-role-mining-session-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id to be patched | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id to be patched +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/pruneThreshold","value":"83"},{"op":"replace","path":"/minNumIdentitiesInPotentialRole","value":"10"},{"op":"replace","path":"/saved","value":"false"},{"op":"replace","path":"/name","value":"RM Session - 07/10/22"},{"op":"add","path":"/name","value":"RM Session - 07/10/22"}]; // Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchRoleMiningSessionV1(sessionId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-entitlements-potential-role-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Edit entitlements for a potential role to exclude some entitlements +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-entitlements-potential-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sessionId** | **string** | The role mining session id | [default to undefined] +**potentialRoleId** | **string** | A potential role id in a role mining session | [default to undefined] +**roleminingpotentialroleeditentitlementsV1** | **RoleminingpotentialroleeditentitlementsV1** | Role mining session parameters | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleminingpotentialroleV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IAIRoleMiningV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IAIRoleMiningV1Api(configuration); +const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id +const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session +const roleminingpotentialroleeditentitlementsV1: RoleminingpotentialroleeditentitlementsV1 = ; // Role mining session parameters +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateEntitlementsPotentialRoleV1(sessionId, potentialRoleId, roleminingpotentialroleeditentitlementsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/iai_role_mining/docs/Methods/Index.md b/sdk-output/iai_role_mining/docs/Methods/Index.md new file mode 100644 index 00000000..c01282d7 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: iai_role_mining-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: iai_role_mining-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_role_mining', 'methods'] +slug: /tools/sdk/typescript/iai_role_mining/methods +tags: ['SDK', 'Software Development Kit', 'iai_role_mining', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/iai_role_mining/docs/Models/ArrayInner.md b/sdk-output/iai_role_mining/docs/Models/ArrayInner.md new file mode 100644 index 00000000..45a542c8 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/iai_role_mining/docs/Models/ArrayInner1.md b/sdk-output/iai_role_mining/docs/Models/ArrayInner1.md new file mode 100644 index 00000000..32469c1c --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/ArrayInner1.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner1-v1 +title: ArrayInner1V1 +pagination_label: ArrayInner1V1 +sidebar_label: ArrayInner1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInner1V1', 'v1ArrayInner1V1'] +slug: /tools/sdk/typescript/iai_role_mining/models/array-inner1-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInner1V1', 'v1ArrayInner1V1'] +--- + +# ArrayInner1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/iai_role_mining/docs/Models/Entitycreatedbydto.md b/sdk-output/iai_role_mining/docs/Models/Entitycreatedbydto.md new file mode 100644 index 00000000..c0e6f7e9 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Entitycreatedbydto.md @@ -0,0 +1,20 @@ +--- +id: v1-entitycreatedbydto-v1 +title: EntitycreatedbydtoV1 +pagination_label: EntitycreatedbydtoV1 +sidebar_label: EntitycreatedbydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitycreatedbydtoV1', 'v1EntitycreatedbydtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/entitycreatedbydto-v1 +tags: ['SDK', 'Software Development Kit', 'EntitycreatedbydtoV1', 'v1EntitycreatedbydtoV1'] +--- + +# EntitycreatedbydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the creator | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the creator | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Errormessagedto.md b/sdk-output/iai_role_mining/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..857269ce --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Errorresponsedto.md b/sdk-output/iai_role_mining/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..ff405730 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1401Response.md b/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1401Response.md new file mode 100644 index 00000000..cf508087 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-role-mining-sessions-v1401-response-v1 +title: GetRoleMiningSessionsV1401ResponseV1 +pagination_label: GetRoleMiningSessionsV1401ResponseV1 +sidebar_label: GetRoleMiningSessionsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetRoleMiningSessionsV1401ResponseV1', 'v1GetRoleMiningSessionsV1401ResponseV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/get-role-mining-sessions-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetRoleMiningSessionsV1401ResponseV1', 'v1GetRoleMiningSessionsV1401ResponseV1'] +--- + +# GetRoleMiningSessionsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1429Response.md b/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1429Response.md new file mode 100644 index 00000000..b700ce0c --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/GetRoleMiningSessionsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-role-mining-sessions-v1429-response-v1 +title: GetRoleMiningSessionsV1429ResponseV1 +pagination_label: GetRoleMiningSessionsV1429ResponseV1 +sidebar_label: GetRoleMiningSessionsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetRoleMiningSessionsV1429ResponseV1', 'v1GetRoleMiningSessionsV1429ResponseV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/get-role-mining-sessions-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetRoleMiningSessionsV1429ResponseV1', 'v1GetRoleMiningSessionsV1429ResponseV1'] +--- + +# GetRoleMiningSessionsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Index.md b/sdk-output/iai_role_mining/docs/Models/Index.md new file mode 100644 index 00000000..ad3d653c --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: iai_role_mining-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: iai_role_mining-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'iai_role_mining', 'models'] +slug: /tools/sdk/typescript/iai_role_mining/models +tags: ['SDK', 'Software Development Kit', 'iai_role_mining', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperation.md b/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..e33dece6 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationValue.md b/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..6deefe34 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperationrolemining.md b/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperationrolemining.md new file mode 100644 index 00000000..9e83eef2 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Jsonpatchoperationrolemining.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperationrolemining-v1 +title: JsonpatchoperationroleminingV1 +pagination_label: JsonpatchoperationroleminingV1 +sidebar_label: JsonpatchoperationroleminingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationroleminingV1', 'v1JsonpatchoperationroleminingV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/jsonpatchoperationrolemining-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationroleminingV1', 'v1JsonpatchoperationroleminingV1'] +--- + +# JsonpatchoperationroleminingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationroleminingValueV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationroleminingValue.md b/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationroleminingValue.md new file mode 100644 index 00000000..c62156ad --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/JsonpatchoperationroleminingValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperationrolemining-value-v1 +title: JsonpatchoperationroleminingValueV1 +pagination_label: JsonpatchoperationroleminingValueV1 +sidebar_label: JsonpatchoperationroleminingValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationroleminingValueV1', 'v1JsonpatchoperationroleminingValueV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/jsonpatchoperationrolemining-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationroleminingValueV1', 'v1JsonpatchoperationroleminingValueV1'] +--- + +# JsonpatchoperationroleminingValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/iai_role_mining/docs/Models/Localeorigin.md b/sdk-output/iai_role_mining/docs/Models/Localeorigin.md new file mode 100644 index 00000000..56d5223a --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/README.md b/sdk-output/iai_role_mining/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingentitlement.md b/sdk-output/iai_role_mining/docs/Models/Roleminingentitlement.md new file mode 100644 index 00000000..6e392c71 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingentitlement.md @@ -0,0 +1,27 @@ +--- +id: v1-roleminingentitlement-v1 +title: RoleminingentitlementV1 +pagination_label: RoleminingentitlementV1 +sidebar_label: RoleminingentitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingentitlementV1', 'v1RoleminingentitlementV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingentitlement-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingentitlementV1', 'v1RoleminingentitlementV1'] +--- + +# RoleminingentitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementRef** | **(optional)** **RoleminingentitlementrefV1** | | [default to undefined] +**name** | **(optional)** **string** | Name of the entitlement | [default to undefined] +**applicationName** | **(optional)** **string** | Application name of the entitlement | [default to undefined] +**identityCount** | **(optional)** **number** | The number of identities with this entitlement in a role. | [default to undefined] +**popularity** | **(optional)** **number** | The % popularity of this entitlement in a role. | [default to undefined] +**popularityInOrg** | **(optional)** **number** | The % popularity of this entitlement in the org. | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source/application. | [default to undefined] +**activitySourceState** | **(optional)** **string** | The status of activity data for the source. Value is complete or notComplete. | [default to undefined] +**sourceUsagePercent** | **(optional)** **number** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingentitlementref.md b/sdk-output/iai_role_mining/docs/Models/Roleminingentitlementref.md new file mode 100644 index 00000000..8173542a --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingentitlementref.md @@ -0,0 +1,22 @@ +--- +id: v1-roleminingentitlementref-v1 +title: RoleminingentitlementrefV1 +pagination_label: RoleminingentitlementrefV1 +sidebar_label: RoleminingentitlementrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingentitlementrefV1', 'v1RoleminingentitlementrefV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingentitlementref-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingentitlementrefV1', 'v1RoleminingentitlementrefV1'] +--- + +# RoleminingentitlementrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the entitlement | [default to undefined] +**name** | **(optional)** **string** | Name of the entitlement | [default to undefined] +**description** | **(optional)** **string** | Description forthe entitlement | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingidentity.md b/sdk-output/iai_role_mining/docs/Models/Roleminingidentity.md new file mode 100644 index 00000000..a54e6329 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingidentity.md @@ -0,0 +1,21 @@ +--- +id: v1-roleminingidentity-v1 +title: RoleminingidentityV1 +pagination_label: RoleminingidentityV1 +sidebar_label: RoleminingidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingidentityV1', 'v1RoleminingidentityV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingidentity-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingidentityV1', 'v1RoleminingidentityV1'] +--- + +# RoleminingidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the identity | [default to undefined] +**name** | **(optional)** **string** | Name of the identity | [default to undefined] +**attributes** | **(optional)** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingidentitydistribution.md b/sdk-output/iai_role_mining/docs/Models/Roleminingidentitydistribution.md new file mode 100644 index 00000000..19db3d7a --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingidentitydistribution.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingidentitydistribution-v1 +title: RoleminingidentitydistributionV1 +pagination_label: RoleminingidentitydistributionV1 +sidebar_label: RoleminingidentitydistributionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingidentitydistributionV1', 'v1RoleminingidentitydistributionV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingidentitydistribution-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingidentitydistributionV1', 'v1RoleminingidentitydistributionV1'] +--- + +# RoleminingidentitydistributionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **(optional)** **string** | Id of the potential role | [default to undefined] +**distribution** | **(optional)** **Array<RoleminingidentitydistributionDistributionInnerV1>** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/RoleminingidentitydistributionDistributionInner.md b/sdk-output/iai_role_mining/docs/Models/RoleminingidentitydistributionDistributionInner.md new file mode 100644 index 00000000..9b21c3db --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/RoleminingidentitydistributionDistributionInner.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingidentitydistribution-distribution-inner-v1 +title: RoleminingidentitydistributionDistributionInnerV1 +pagination_label: RoleminingidentitydistributionDistributionInnerV1 +sidebar_label: RoleminingidentitydistributionDistributionInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingidentitydistributionDistributionInnerV1', 'v1RoleminingidentitydistributionDistributionInnerV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingidentitydistribution-distribution-inner-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingidentitydistributionDistributionInnerV1', 'v1RoleminingidentitydistributionDistributionInnerV1'] +--- + +# RoleminingidentitydistributionDistributionInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeValue** | **(optional)** **string** | The attribute value that identities are grouped by | [default to undefined] +**count** | **(optional)** **number** | The number of identities that have this attribute value | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrole.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrole.md new file mode 100644 index 00000000..2ba4c017 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrole.md @@ -0,0 +1,39 @@ +--- +id: v1-roleminingpotentialrole-v1 +title: RoleminingpotentialroleV1 +pagination_label: RoleminingpotentialroleV1 +sidebar_label: RoleminingpotentialroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleV1', 'v1RoleminingpotentialroleV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialrole-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleV1', 'v1RoleminingpotentialroleV1'] +--- + +# RoleminingpotentialroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**createdBy** | **(optional)** **RoleminingsessionresponseCreatedByV1** | | [default to undefined] +**density** | **(optional)** **number** | The density of a potential role. | [default to undefined] +**description** | **(optional)** **string** | The description of a potential role. | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements in a potential role. | [default to undefined] +**excludedEntitlements** | **(optional)** **Array<string>** | The list of entitlement ids to be excluded. | [default to undefined] +**freshness** | **(optional)** **number** | The freshness of a potential role. | [default to undefined] +**identityCount** | **(optional)** **number** | The number of identities in a potential role. | [default to undefined] +**identityDistribution** | **(optional)** **Array<RoleminingidentitydistributionV1>** | Identity attribute distribution. | [default to undefined] +**identityIds** | **(optional)** **Array<string>** | The list of ids in a potential role. | [default to undefined] +**identityGroupStatus** | **(optional)** **string** | The status for this identity group which can be OBTAINED or COMPRESSED | [default to undefined] +**name** | **(optional)** **string** | Name of the potential role. | [default to undefined] +**potentialRoleRef** | **(optional)** **RoleminingpotentialrolePotentialRoleRefV1** | | [default to undefined] +**provisionState** | **(optional)** **RoleminingpotentialroleprovisionstateV1** | | [default to undefined] +**quality** | **(optional)** **number** | The quality of a potential role. | [default to undefined] +**roleId** | **(optional)** **string** | The roleId of a potential role. | [default to undefined] +**saved** | **(optional)** **boolean** | The potential role\'s saved status. | [default to false] +**session** | **(optional)** **RoleminingsessionparametersdtoV1** | | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Id of the potential role | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time when this potential role was created. | [default to undefined] +**modifiedDate** | **(optional)** **string** | The date-time when this potential role was modified. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolePotentialRoleRef.md b/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolePotentialRoleRef.md new file mode 100644 index 00000000..f33b32ad --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolePotentialRoleRef.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialrole-potential-role-ref-v1 +title: RoleminingpotentialrolePotentialRoleRefV1 +pagination_label: RoleminingpotentialrolePotentialRoleRefV1 +sidebar_label: RoleminingpotentialrolePotentialRoleRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialrolePotentialRoleRefV1', 'v1RoleminingpotentialrolePotentialRoleRefV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialrole-potential-role-ref-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialrolePotentialRoleRefV1', 'v1RoleminingpotentialrolePotentialRoleRefV1'] +--- + +# RoleminingpotentialrolePotentialRoleRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the potential role | [default to undefined] +**name** | **(optional)** **string** | Name of the potential role | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleapplication.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleapplication.md new file mode 100644 index 00000000..cb4ba84a --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleapplication.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialroleapplication-v1 +title: RoleminingpotentialroleapplicationV1 +pagination_label: RoleminingpotentialroleapplicationV1 +sidebar_label: RoleminingpotentialroleapplicationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleapplicationV1', 'v1RoleminingpotentialroleapplicationV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleapplication-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleapplicationV1', 'v1RoleminingpotentialroleapplicationV1'] +--- + +# RoleminingpotentialroleapplicationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the application | [default to undefined] +**name** | **(optional)** **string** | Name of the application | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleeditentitlements.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleeditentitlements.md new file mode 100644 index 00000000..2eb92e1c --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleeditentitlements.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialroleeditentitlements-v1 +title: RoleminingpotentialroleeditentitlementsV1 +pagination_label: RoleminingpotentialroleeditentitlementsV1 +sidebar_label: RoleminingpotentialroleeditentitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleeditentitlementsV1', 'v1RoleminingpotentialroleeditentitlementsV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleeditentitlements-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleeditentitlementsV1', 'v1RoleminingpotentialroleeditentitlementsV1'] +--- + +# RoleminingpotentialroleeditentitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **(optional)** **Array<string>** | The list of entitlement ids to be edited | [default to undefined] +**exclude** | **(optional)** **boolean** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleentitlements.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleentitlements.md new file mode 100644 index 00000000..87cbca57 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleentitlements.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialroleentitlements-v1 +title: RoleminingpotentialroleentitlementsV1 +pagination_label: RoleminingpotentialroleentitlementsV1 +sidebar_label: RoleminingpotentialroleentitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleentitlementsV1', 'v1RoleminingpotentialroleentitlementsV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleentitlements-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleentitlementsV1', 'v1RoleminingpotentialroleentitlementsV1'] +--- + +# RoleminingpotentialroleentitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the entitlement | [default to undefined] +**name** | **(optional)** **string** | Name of the entitlement | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportrequest.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportrequest.md new file mode 100644 index 00000000..8fc2a9d7 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialroleexportrequest-v1 +title: RoleminingpotentialroleexportrequestV1 +pagination_label: RoleminingpotentialroleexportrequestV1 +sidebar_label: RoleminingpotentialroleexportrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleexportrequestV1', 'v1RoleminingpotentialroleexportrequestV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleexportrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleexportrequestV1', 'v1RoleminingpotentialroleexportrequestV1'] +--- + +# RoleminingpotentialroleexportrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**minEntitlementPopularity** | **(optional)** **number** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [default to undefined] +**includeCommonAccess** | **(optional)** **boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportresponse.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportresponse.md new file mode 100644 index 00000000..c5563605 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-roleminingpotentialroleexportresponse-v1 +title: RoleminingpotentialroleexportresponseV1 +pagination_label: RoleminingpotentialroleexportresponseV1 +sidebar_label: RoleminingpotentialroleexportresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleexportresponseV1', 'v1RoleminingpotentialroleexportresponseV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleexportresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleexportresponseV1', 'v1RoleminingpotentialroleexportresponseV1'] +--- + +# RoleminingpotentialroleexportresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**minEntitlementPopularity** | **(optional)** **number** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [default to undefined] +**includeCommonAccess** | **(optional)** **boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [default to undefined] +**exportId** | **(optional)** **string** | ID used to reference this export | [default to undefined] +**status** | **(optional)** **RoleminingpotentialroleexportstateV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportstate.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportstate.md new file mode 100644 index 00000000..fde8b8a4 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleexportstate.md @@ -0,0 +1,25 @@ +--- +id: v1-roleminingpotentialroleexportstate-v1 +title: RoleminingpotentialroleexportstateV1 +pagination_label: RoleminingpotentialroleexportstateV1 +sidebar_label: RoleminingpotentialroleexportstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleexportstateV1', 'v1RoleminingpotentialroleexportstateV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleexportstate-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleexportstateV1', 'v1RoleminingpotentialroleexportstateV1'] +--- + +# RoleminingpotentialroleexportstateV1 + +## Enum + + +* `Queued` (value: `'QUEUED'`) + +* `InProgress` (value: `'IN_PROGRESS'`) + +* `Success` (value: `'SUCCESS'`) + +* `Error` (value: `'ERROR'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionrequest.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionrequest.md new file mode 100644 index 00000000..1fcac4f7 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionrequest.md @@ -0,0 +1,23 @@ +--- +id: v1-roleminingpotentialroleprovisionrequest-v1 +title: RoleminingpotentialroleprovisionrequestV1 +pagination_label: RoleminingpotentialroleprovisionrequestV1 +sidebar_label: RoleminingpotentialroleprovisionrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleprovisionrequestV1', 'v1RoleminingpotentialroleprovisionrequestV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleprovisionrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleprovisionrequestV1', 'v1RoleminingpotentialroleprovisionrequestV1'] +--- + +# RoleminingpotentialroleprovisionrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roleName** | **(optional)** **string** | Name of the new role being created | [default to undefined] +**roleDescription** | **(optional)** **string** | Short description of the new role being created | [default to undefined] +**ownerId** | **(optional)** **string** | ID of the identity that will own this role | [default to undefined] +**includeIdentities** | **(optional)** **boolean** | When true, create access requests for the identities associated with the potential role | [default to false] +**directlyAssignedEntitlements** | **(optional)** **boolean** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [default to false] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionstate.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionstate.md new file mode 100644 index 00000000..a83f6e7d --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleprovisionstate.md @@ -0,0 +1,25 @@ +--- +id: v1-roleminingpotentialroleprovisionstate-v1 +title: RoleminingpotentialroleprovisionstateV1 +pagination_label: RoleminingpotentialroleprovisionstateV1 +sidebar_label: RoleminingpotentialroleprovisionstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialroleprovisionstateV1', 'v1RoleminingpotentialroleprovisionstateV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleprovisionstate-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialroleprovisionstateV1', 'v1RoleminingpotentialroleprovisionstateV1'] +--- + +# RoleminingpotentialroleprovisionstateV1 + +## Enum + + +* `Potential` (value: `'POTENTIAL'`) + +* `Pending` (value: `'PENDING'`) + +* `Complete` (value: `'COMPLETE'`) + +* `Failed` (value: `'FAILED'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleref.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleref.md new file mode 100644 index 00000000..7c50a16d --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialroleref.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialroleref-v1 +title: RoleminingpotentialrolerefV1 +pagination_label: RoleminingpotentialrolerefV1 +sidebar_label: RoleminingpotentialrolerefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialrolerefV1', 'v1RoleminingpotentialrolerefV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialroleref-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialrolerefV1', 'v1RoleminingpotentialrolerefV1'] +--- + +# RoleminingpotentialrolerefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the potential role | [default to undefined] +**name** | **(optional)** **string** | Name of the potential role | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesourceusage.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesourceusage.md new file mode 100644 index 00000000..4e09f8be --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesourceusage.md @@ -0,0 +1,22 @@ +--- +id: v1-roleminingpotentialrolesourceusage-v1 +title: RoleminingpotentialrolesourceusageV1 +pagination_label: RoleminingpotentialrolesourceusageV1 +sidebar_label: RoleminingpotentialrolesourceusageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialrolesourceusageV1', 'v1RoleminingpotentialrolesourceusageV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialrolesourceusage-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialrolesourceusageV1', 'v1RoleminingpotentialrolesourceusageV1'] +--- + +# RoleminingpotentialrolesourceusageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**displayName** | **(optional)** **string** | Display name for the identity | [default to undefined] +**email** | **(optional)** **string** | Email address for the identity | [default to undefined] +**usageCount** | **(optional)** **number** | The number of days there has been usage of the source by the identity. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesummary.md b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesummary.md new file mode 100644 index 00000000..fbacbc76 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingpotentialrolesummary.md @@ -0,0 +1,35 @@ +--- +id: v1-roleminingpotentialrolesummary-v1 +title: RoleminingpotentialrolesummaryV1 +pagination_label: RoleminingpotentialrolesummaryV1 +sidebar_label: RoleminingpotentialrolesummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialrolesummaryV1', 'v1RoleminingpotentialrolesummaryV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialrolesummary-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialrolesummaryV1', 'v1RoleminingpotentialrolesummaryV1'] +--- + +# RoleminingpotentialrolesummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the potential role | [default to undefined] +**name** | **(optional)** **string** | Name of the potential role | [default to undefined] +**potentialRoleRef** | **(optional)** **RoleminingpotentialrolerefV1** | | [default to undefined] +**identityCount** | **(optional)** **number** | The number of identities in a potential role. | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements in a potential role. | [default to undefined] +**identityGroupStatus** | **(optional)** **string** | The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\" | [default to undefined] +**provisionState** | **(optional)** **RoleminingpotentialroleprovisionstateV1** | | [default to undefined] +**roleId** | **(optional)** **string** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [default to undefined] +**density** | **(optional)** **number** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [default to undefined] +**freshness** | **(optional)** **number** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [default to undefined] +**quality** | **(optional)** **number** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] +**createdBy** | **(optional)** **RoleminingpotentialrolesummaryCreatedByV1** | | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time when this potential role was created. | [default to undefined] +**saved** | **(optional)** **boolean** | The potential role\'s saved status | [default to false] +**description** | **(optional)** **string** | Description of the potential role | [default to undefined] +**session** | **(optional)** **RoleminingsessionparametersdtoV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolesummaryCreatedBy.md b/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolesummaryCreatedBy.md new file mode 100644 index 00000000..f43b0edf --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/RoleminingpotentialrolesummaryCreatedBy.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingpotentialrolesummary-created-by-v1 +title: RoleminingpotentialrolesummaryCreatedByV1 +pagination_label: RoleminingpotentialrolesummaryCreatedByV1 +sidebar_label: RoleminingpotentialrolesummaryCreatedByV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingpotentialrolesummaryCreatedByV1', 'v1RoleminingpotentialrolesummaryCreatedByV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingpotentialrolesummary-created-by-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingpotentialrolesummaryCreatedByV1', 'v1RoleminingpotentialrolesummaryCreatedByV1'] +--- + +# RoleminingpotentialrolesummaryCreatedByV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the creator | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the creator | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingroletype.md b/sdk-output/iai_role_mining/docs/Models/Roleminingroletype.md new file mode 100644 index 00000000..f3c1419d --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingroletype.md @@ -0,0 +1,21 @@ +--- +id: v1-roleminingroletype-v1 +title: RoleminingroletypeV1 +pagination_label: RoleminingroletypeV1 +sidebar_label: RoleminingroletypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingroletypeV1', 'v1RoleminingroletypeV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingroletype-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingroletypeV1', 'v1RoleminingroletypeV1'] +--- + +# RoleminingroletypeV1 + +## Enum + + +* `Specialized` (value: `'SPECIALIZED'`) + +* `Common` (value: `'COMMON'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondraftroledto.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondraftroledto.md new file mode 100644 index 00000000..197615a6 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondraftroledto.md @@ -0,0 +1,28 @@ +--- +id: v1-roleminingsessiondraftroledto-v1 +title: RoleminingsessiondraftroledtoV1 +pagination_label: RoleminingsessiondraftroledtoV1 +sidebar_label: RoleminingsessiondraftroledtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessiondraftroledtoV1', 'v1RoleminingsessiondraftroledtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessiondraftroledto-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessiondraftroledtoV1', 'v1RoleminingsessiondraftroledtoV1'] +--- + +# RoleminingsessiondraftroledtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the draft role | [default to undefined] +**description** | **(optional)** **string** | Draft role description | [default to undefined] +**identityIds** | **(optional)** **Array<string>** | The list of identities for this role mining session. | [default to undefined] +**entitlementIds** | **(optional)** **Array<string>** | The list of entitlement ids for this role mining session. | [default to undefined] +**excludedEntitlements** | **(optional)** **Array<string>** | The list of excluded entitlement ids. | [default to undefined] +**modified** | **(optional)** **string** | Last modified date | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Id of the potential draft role | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time when this potential draft role was created. | [default to undefined] +**modifiedDate** | **(optional)** **string** | The date-time when this potential draft role was modified. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondto.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondto.md new file mode 100644 index 00000000..57b39392 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessiondto.md @@ -0,0 +1,29 @@ +--- +id: v1-roleminingsessiondto-v1 +title: RoleminingsessiondtoV1 +pagination_label: RoleminingsessiondtoV1 +sidebar_label: RoleminingsessiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessiondtoV1', 'v1RoleminingsessiondtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessiondto-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessiondtoV1', 'v1RoleminingsessiondtoV1'] +--- + +# RoleminingsessiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | **(optional)** **RoleminingsessionscopeV1** | | [default to undefined] +**pruneThreshold** | **(optional)** **number** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [default to undefined] +**prescribedPruneThreshold** | **(optional)** **number** | The calculated prescribedPruneThreshold | [default to undefined] +**minNumIdentitiesInPotentialRole** | **(optional)** **number** | Minimum number of identities in a potential role | [default to undefined] +**potentialRoleCount** | **(optional)** **number** | Number of potential roles | [default to undefined] +**potentialRolesReadyCount** | **(optional)** **number** | Number of potential roles ready | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] +**emailRecipientId** | **(optional)** **string** | The id of the user who will receive an email about the role mining session | [default to undefined] +**identityCount** | **(optional)** **number** | Number of identities in the population which meet the search criteria or identity list provided | [default to undefined] +**saved** | **(optional)** **boolean** | The session\'s saved status | [default to false] +**name** | **(optional)** **string** | The session\'s saved name | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionparametersdto.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionparametersdto.md new file mode 100644 index 00000000..2a61ba1e --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionparametersdto.md @@ -0,0 +1,27 @@ +--- +id: v1-roleminingsessionparametersdto-v1 +title: RoleminingsessionparametersdtoV1 +pagination_label: RoleminingsessionparametersdtoV1 +sidebar_label: RoleminingsessionparametersdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionparametersdtoV1', 'v1RoleminingsessionparametersdtoV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionparametersdto-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionparametersdtoV1', 'v1RoleminingsessionparametersdtoV1'] +--- + +# RoleminingsessionparametersdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the role mining session | [default to undefined] +**name** | **(optional)** **string** | The session\'s saved name | [default to undefined] +**minNumIdentitiesInPotentialRole** | **(optional)** **number** | Minimum number of identities in a potential role | [default to undefined] +**pruneThreshold** | **(optional)** **number** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [default to undefined] +**saved** | **(optional)** **boolean** | The session\'s saved status | [default to true] +**scope** | **(optional)** **RoleminingsessionscopeV1** | | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] +**state** | **(optional)** **RoleminingsessionstateV1** | | [default to undefined] +**scopingMethod** | **(optional)** **RoleminingsessionscopingmethodV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionresponse.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionresponse.md new file mode 100644 index 00000000..a645b466 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionresponse.md @@ -0,0 +1,36 @@ +--- +id: v1-roleminingsessionresponse-v1 +title: RoleminingsessionresponseV1 +pagination_label: RoleminingsessionresponseV1 +sidebar_label: RoleminingsessionresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionresponseV1', 'v1RoleminingsessionresponseV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionresponseV1', 'v1RoleminingsessionresponseV1'] +--- + +# RoleminingsessionresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scope** | **(optional)** **RoleminingsessionscopeV1** | | [default to undefined] +**minNumIdentitiesInPotentialRole** | **(optional)** **number** | Minimum number of identities in a potential role | [default to undefined] +**scopingMethod** | **(optional)** **string** | The scoping method of the role mining session | [default to undefined] +**prescribedPruneThreshold** | **(optional)** **number** | The computed (or prescribed) prune threshold for this session | [default to undefined] +**pruneThreshold** | **(optional)** **number** | The prune threshold to be used for this role mining session | [default to undefined] +**potentialRoleCount** | **(optional)** **number** | The number of potential roles | [default to undefined] +**potentialRolesReadyCount** | **(optional)** **number** | The number of potential roles which have completed processing | [default to undefined] +**status** | **(optional)** **RoleminingsessionstatusV1** | | [default to undefined] +**emailRecipientId** | **(optional)** **string** | The id of the user who will receive an email about the role mining session | [default to undefined] +**createdBy** | **(optional)** **RoleminingsessionresponseCreatedByV1** | | [default to undefined] +**identityCount** | **(optional)** **number** | The number of identities | [default to undefined] +**saved** | **(optional)** **boolean** | The session\'s saved status | [default to false] +**name** | **(optional)** **string** | The session\'s saved name | [default to undefined] +**dataFilePath** | **(optional)** **string** | The data file path of the role mining session | [default to undefined] +**id** | **(optional)** **string** | Session Id for this role mining session | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time when this role mining session was created. | [default to undefined] +**modifiedDate** | **(optional)** **string** | The date-time when this role mining session was completed. | [default to undefined] +**type** | **(optional)** **RoleminingroletypeV1** | | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/RoleminingsessionresponseCreatedBy.md b/sdk-output/iai_role_mining/docs/Models/RoleminingsessionresponseCreatedBy.md new file mode 100644 index 00000000..5f8bed0e --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/RoleminingsessionresponseCreatedBy.md @@ -0,0 +1,20 @@ +--- +id: v1-roleminingsessionresponse-created-by-v1 +title: RoleminingsessionresponseCreatedByV1 +pagination_label: RoleminingsessionresponseCreatedByV1 +sidebar_label: RoleminingsessionresponseCreatedByV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionresponseCreatedByV1', 'v1RoleminingsessionresponseCreatedByV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionresponse-created-by-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionresponseCreatedByV1', 'v1RoleminingsessionresponseCreatedByV1'] +--- + +# RoleminingsessionresponseCreatedByV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the creator | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the creator | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscope.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscope.md new file mode 100644 index 00000000..2bd83b58 --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscope.md @@ -0,0 +1,21 @@ +--- +id: v1-roleminingsessionscope-v1 +title: RoleminingsessionscopeV1 +pagination_label: RoleminingsessionscopeV1 +sidebar_label: RoleminingsessionscopeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionscopeV1', 'v1RoleminingsessionscopeV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionscope-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionscopeV1', 'v1RoleminingsessionscopeV1'] +--- + +# RoleminingsessionscopeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityIds** | **(optional)** **Array<string>** | The list of identities for this role mining session. | [default to undefined] +**criteria** | **(optional)** **string** | The \"search\" criteria that produces the list of identities for this role mining session. | [default to undefined] +**attributeFilterCriteria** | **(optional)** **Array<object>** | The filter criteria for this role mining session. | [default to undefined] + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscopingmethod.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscopingmethod.md new file mode 100644 index 00000000..698b3efb --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionscopingmethod.md @@ -0,0 +1,21 @@ +--- +id: v1-roleminingsessionscopingmethod-v1 +title: RoleminingsessionscopingmethodV1 +pagination_label: RoleminingsessionscopingmethodV1 +sidebar_label: RoleminingsessionscopingmethodV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionscopingmethodV1', 'v1RoleminingsessionscopingmethodV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionscopingmethod-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionscopingmethodV1', 'v1RoleminingsessionscopingmethodV1'] +--- + +# RoleminingsessionscopingmethodV1 + +## Enum + + +* `Manual` (value: `'MANUAL'`) + +* `AutoRm` (value: `'AUTO_RM'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstate.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstate.md new file mode 100644 index 00000000..c6e7986e --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstate.md @@ -0,0 +1,29 @@ +--- +id: v1-roleminingsessionstate-v1 +title: RoleminingsessionstateV1 +pagination_label: RoleminingsessionstateV1 +sidebar_label: RoleminingsessionstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionstateV1', 'v1RoleminingsessionstateV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionstate-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionstateV1', 'v1RoleminingsessionstateV1'] +--- + +# RoleminingsessionstateV1 + +## Enum + + +* `Created` (value: `'CREATED'`) + +* `Updated` (value: `'UPDATED'`) + +* `IdentitiesObtained` (value: `'IDENTITIES_OBTAINED'`) + +* `PruneThresholdObtained` (value: `'PRUNE_THRESHOLD_OBTAINED'`) + +* `PotentialRolesProcessing` (value: `'POTENTIAL_ROLES_PROCESSING'`) + +* `PotentialRolesCreated` (value: `'POTENTIAL_ROLES_CREATED'`) + + diff --git a/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstatus.md b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstatus.md new file mode 100644 index 00000000..97721b9a --- /dev/null +++ b/sdk-output/iai_role_mining/docs/Models/Roleminingsessionstatus.md @@ -0,0 +1,19 @@ +--- +id: v1-roleminingsessionstatus-v1 +title: RoleminingsessionstatusV1 +pagination_label: RoleminingsessionstatusV1 +sidebar_label: RoleminingsessionstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleminingsessionstatusV1', 'v1RoleminingsessionstatusV1'] +slug: /tools/sdk/typescript/iai_role_mining/models/roleminingsessionstatus-v1 +tags: ['SDK', 'Software Development Kit', 'RoleminingsessionstatusV1', 'v1RoleminingsessionstatusV1'] +--- + +# RoleminingsessionstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **(optional)** **RoleminingsessionstateV1** | | [default to undefined] + diff --git a/sdk-output/icons/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/icons/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f75336f0 --- /dev/null +++ b/sdk-output/icons/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,35 @@ +- path: /icons/v1/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/icons/methods/icons#delete-icon-v1 + source: | + import { IconsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IconsV1Api(configuration); + const objectType: string = 'application'; // 'application' | Object type. Available options [\'application\'] (default to undefined) + const objectId: string = 'a291e870-48c3-4953-b656-fb5ce2a93169'; // string | Object id. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteIconV1(objectType, objectId); + console.log(result); +- path: /icons/v1/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/icons/methods/icons#set-icon-v1 + source: | + import { IconsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IconsV1Api(configuration); + const objectType: string = 'application'; // 'application' | Object type. Available options [\'application\'] (default to undefined) + const objectId: string = 'a291e870-48c3-4953-b656-fb5ce2a93169'; // string | Object id. (default to undefined) + const image: File = BINARY_DATA_HERE; // File | file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.setIconV1(objectType, objectId, image); + console.log(result); diff --git a/sdk-output/icons/docs/Methods/IconsV1Api.md b/sdk-output/icons/docs/Methods/IconsV1Api.md new file mode 100644 index 00000000..192fde6b --- /dev/null +++ b/sdk-output/icons/docs/Methods/IconsV1Api.md @@ -0,0 +1,115 @@ +--- +id: v1-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Icons', 'v1Icons'] +slug: /tools/sdk/typescript/icons/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'v1Icons'] +--- + +# IconsV1Api + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-icon-v1**](#delete-icon-v1) | **DELETE** `/icons/v1/{objectType}/{objectId}` | Delete an icon +[**set-icon-v1**](#set-icon-v1) | **PUT** `/icons/v1/{objectType}/{objectId}` | Update an icon + + +## delete-icon-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete an icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-icon-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**objectType** | **'application'** | Object type. Available options [\'application\'] | [default to undefined] +**objectId** | **string** | Object id. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IconsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IconsV1Api(configuration); +const objectType: string = application; // Object type. Available options [\'application\'] +const objectId: string = a291e870-48c3-4953-b656-fb5ce2a93169; // Object id. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteIconV1(objectType, objectId); +console.log(result); +``` + +[[Back to top]](#) + +## set-icon-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update an icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-icon-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**objectType** | **'application'** | Object type. Available options [\'application\'] | [default to undefined] +**objectId** | **string** | Object id. | [default to undefined] +**image** | **File** | file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SetIconV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { IconsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IconsV1Api(configuration); +const objectType: string = application; // Object type. Available options [\'application\'] +const objectId: string = a291e870-48c3-4953-b656-fb5ce2a93169; // Object id. +const image: File = BINARY_DATA_HERE; // file with icon. Allowed mime-types [\\\'image/png\\\', \\\'image/jpeg\\\'] +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.setIconV1(objectType, objectId, image); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/icons/docs/Methods/Index.md b/sdk-output/icons/docs/Methods/Index.md new file mode 100644 index 00000000..ecbf962c --- /dev/null +++ b/sdk-output/icons/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: icons-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: icons-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'icons', 'methods'] +slug: /tools/sdk/typescript/icons/methods +tags: ['SDK', 'Software Development Kit', 'icons', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/icons/docs/Models/Errormessagedto.md b/sdk-output/icons/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..baf7727c --- /dev/null +++ b/sdk-output/icons/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/icons/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/icons/docs/Models/Errorresponsedto.md b/sdk-output/icons/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..794efa30 --- /dev/null +++ b/sdk-output/icons/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/icons/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/icons/docs/Models/Index.md b/sdk-output/icons/docs/Models/Index.md new file mode 100644 index 00000000..9bbaacf8 --- /dev/null +++ b/sdk-output/icons/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: icons-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: icons-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'icons', 'models'] +slug: /tools/sdk/typescript/icons/models +tags: ['SDK', 'Software Development Kit', 'icons', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/icons/docs/Models/Localeorigin.md b/sdk-output/icons/docs/Models/Localeorigin.md new file mode 100644 index 00000000..fd1fad58 --- /dev/null +++ b/sdk-output/icons/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/icons/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/icons/docs/Models/README.md b/sdk-output/icons/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/icons/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/icons/docs/Models/SetIconV1200Response.md b/sdk-output/icons/docs/Models/SetIconV1200Response.md new file mode 100644 index 00000000..1e23aaef --- /dev/null +++ b/sdk-output/icons/docs/Models/SetIconV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-icon-v1200-response-v1 +title: SetIconV1200ResponseV1 +pagination_label: SetIconV1200ResponseV1 +sidebar_label: SetIconV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetIconV1200ResponseV1', 'v1SetIconV1200ResponseV1'] +slug: /tools/sdk/typescript/icons/models/set-icon-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetIconV1200ResponseV1', 'v1SetIconV1200ResponseV1'] +--- + +# SetIconV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**icon** | **(optional)** **string** | url to file with icon | [default to undefined] + diff --git a/sdk-output/icons/docs/Models/SetIconV1401Response.md b/sdk-output/icons/docs/Models/SetIconV1401Response.md new file mode 100644 index 00000000..f2ea1369 --- /dev/null +++ b/sdk-output/icons/docs/Models/SetIconV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-icon-v1401-response-v1 +title: SetIconV1401ResponseV1 +pagination_label: SetIconV1401ResponseV1 +sidebar_label: SetIconV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetIconV1401ResponseV1', 'v1SetIconV1401ResponseV1'] +slug: /tools/sdk/typescript/icons/models/set-icon-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetIconV1401ResponseV1', 'v1SetIconV1401ResponseV1'] +--- + +# SetIconV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/icons/docs/Models/SetIconV1429Response.md b/sdk-output/icons/docs/Models/SetIconV1429Response.md new file mode 100644 index 00000000..43234481 --- /dev/null +++ b/sdk-output/icons/docs/Models/SetIconV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-icon-v1429-response-v1 +title: SetIconV1429ResponseV1 +pagination_label: SetIconV1429ResponseV1 +sidebar_label: SetIconV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetIconV1429ResponseV1', 'v1SetIconV1429ResponseV1'] +slug: /tools/sdk/typescript/icons/models/set-icon-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetIconV1429ResponseV1', 'v1SetIconV1429ResponseV1'] +--- + +# SetIconV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/icons/docs/Models/SetIconV1Request.md b/sdk-output/icons/docs/Models/SetIconV1Request.md new file mode 100644 index 00000000..c0ed0b1d --- /dev/null +++ b/sdk-output/icons/docs/Models/SetIconV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-set-icon-v1-request-v1 +title: SetIconV1RequestV1 +pagination_label: SetIconV1RequestV1 +sidebar_label: SetIconV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetIconV1RequestV1', 'v1SetIconV1RequestV1'] +slug: /tools/sdk/typescript/icons/models/set-icon-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'SetIconV1RequestV1', 'v1SetIconV1RequestV1'] +--- + +# SetIconV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**image** | **File** | file with icon. Allowed mime-types [\'image/png\', \'image/jpeg\'] | [default to undefined] + diff --git a/sdk-output/identities/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/identities/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..ec2f48a7 --- /dev/null +++ b/sdk-output/identities/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,197 @@ +- path: /identities/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#delete-identity-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteIdentityV1(id); + console.log(result); +- path: /identities/v1/{identityId}/ownership + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#get-identity-ownership-details-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const identityId: string = 'ff8081814d2a8036014d701f3fbf53fa'; // string | Identity ID. (default to undefined) + const result = await apiInstance.getIdentityOwnershipDetailsV1(identityId); + console.log(result); +- path: /identities/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#get-identity-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id (default to undefined) + const result = await apiInstance.getIdentityV1(id); + console.log(result); +- path: /identities/v1/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#get-role-assignment-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const identityId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id (default to undefined) + const assignmentId: string = '1cbb0705b38c4226b1334eadd8874086'; // string | Assignment Id (default to undefined) + const result = await apiInstance.getRoleAssignmentV1(identityId, assignmentId); + console.log(result); +- path: /identities/v1/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#get-role-assignments-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const identityId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id to get the role assignments for (default to undefined) + const roleId: string = 'e7697a1e96d04db1ac7b0f4544915d2c'; // string | Role Id to filter the role assignments with (optional) (default to undefined) + const roleName: string = 'Engineer'; // string | Role name to filter the role assignments with (optional) (default to undefined) + const result = await apiInstance.getRoleAssignmentsV1(identityId); + console.log(result); +- path: /entitlements/v1/identities/{id}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#list-entitlements-by-identity-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listEntitlementsByIdentityV1(id); + console.log(result); +- path: /identities/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#list-identities-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const filters: string = 'id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) (default to undefined) + const sorters: string = 'name,-cloudStatus'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) (default to undefined) + const defaultFilter: string = 'NONE'; // 'CORRELATED_ONLY' | 'NONE' | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to 'CORRELATED_ONLY') + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listIdentitiesV1(); + console.log(result); +- path: /identities/v1/{id}/reset + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#reset-identity-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity Id (default to undefined) + const result = await apiInstance.resetIdentityV1(id); + console.log(result); +- path: /identities/v1/{id}/verification/account/send + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#send-identity-verification-account-token-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity ID (default to undefined) + const sendaccountverificationrequestV1: SendaccountverificationrequestV1 = ; // SendaccountverificationrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.sendIdentityVerificationAccountTokenV1(id, sendaccountverificationrequestV1); + console.log(result); +- path: /identities/v1/invite + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#start-identities-invite-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const inviteidentitiesrequestV1: InviteidentitiesrequestV1 = ; // InviteidentitiesrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.startIdentitiesInviteV1(inviteidentitiesrequestV1); + console.log(result); +- path: /identities/v1/process + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#start-identity-processing-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const processidentitiesrequestV1: ProcessidentitiesrequestV1 = ; // ProcessidentitiesrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.startIdentityProcessingV1(processidentitiesrequestV1); + console.log(result); +- path: /identities/v1/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identities/methods/identities#synchronize-attributes-for-identity-v1 + source: | + import { IdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentitiesV1Api(configuration); + const identityId: string = 'identityId_example'; // string | The Identity id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.synchronizeAttributesForIdentityV1(identityId); + console.log(result); diff --git a/sdk-output/identities/docs/Methods/IdentitiesV1Api.md b/sdk-output/identities/docs/Methods/IdentitiesV1Api.md new file mode 100644 index 00000000..91464ab8 --- /dev/null +++ b/sdk-output/identities/docs/Methods/IdentitiesV1Api.md @@ -0,0 +1,566 @@ +--- +id: v1-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Identities', 'v1Identities'] +slug: /tools/sdk/typescript/identities/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'v1Identities'] +--- + +# IdentitiesV1Api + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-identity-v1**](#delete-identity-v1) | **DELETE** `/identities/v1/{id}` | Delete identity +[**get-identity-ownership-details-v1**](#get-identity-ownership-details-v1) | **GET** `/identities/v1/{identityId}/ownership` | Get ownership details +[**get-identity-v1**](#get-identity-v1) | **GET** `/identities/v1/{id}` | Identity details +[**get-role-assignment-v1**](#get-role-assignment-v1) | **GET** `/identities/v1/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**get-role-assignments-v1**](#get-role-assignments-v1) | **GET** `/identities/v1/{identityId}/role-assignments` | List role assignments +[**list-entitlements-by-identity-v1**](#list-entitlements-by-identity-v1) | **GET** `/entitlements/v1/identities/{id}/entitlements` | List of entitlements by identity. +[**list-identities-v1**](#list-identities-v1) | **GET** `/identities/v1` | List identities +[**reset-identity-v1**](#reset-identity-v1) | **POST** `/identities/v1/{id}/reset` | Reset an identity +[**send-identity-verification-account-token-v1**](#send-identity-verification-account-token-v1) | **POST** `/identities/v1/{id}/verification/account/send` | Send password reset email +[**start-identities-invite-v1**](#start-identities-invite-v1) | **POST** `/identities/v1/invite` | Invite identities to register +[**start-identity-processing-v1**](#start-identity-processing-v1) | **POST** `/identities/v1/process` | Process a list of identityids +[**synchronize-attributes-for-identity-v1**](#synchronize-attributes-for-identity-v1) | **POST** `/identities/v1/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + + +## delete-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete identity +The API returns successful response if the requested identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity Id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-ownership-details-v1 +Get ownership details +Use this API to return an identity's owned objects that will cause problems for deleting the identity. +Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-ownership-details-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | Identity ID. | [default to undefined] + +### Return type + +**IdentityownershipassociationdetailsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const identityId: string = ff8081814d2a8036014d701f3fbf53fa; // Identity ID. +const result = await apiInstance.getIdentityOwnershipDetailsV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-v1 +Identity details +This API returns a single identity using the Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity Id | [default to undefined] + +### Return type + +**IdentityV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id +const result = await apiInstance.getIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-assignment-v1 +Role assignment details + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-assignment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | Identity Id | [default to undefined] +**assignmentId** | **string** | Assignment Id | [default to undefined] + +### Return type + +**RoleassignmentdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const identityId: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id +const assignmentId: string = 1cbb0705b38c4226b1334eadd8874086; // Assignment Id +const result = await apiInstance.getRoleAssignmentV1(identityId, assignmentId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-assignments-v1 +List role assignments +This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-assignments-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | Identity Id to get the role assignments for | [default to undefined] +**roleId** | **string** | Role Id to filter the role assignments with | [optional] [default to undefined] +**roleName** | **string** | Role name to filter the role assignments with | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const identityId: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id to get the role assignments for +const roleId: string = e7697a1e96d04db1ac7b0f4544915d2c; // Role Id to filter the role assignments with (optional) +const roleName: string = Engineer; // Role name to filter the role assignments with (optional) +const result = await apiInstance.getRoleAssignmentsV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + +## list-entitlements-by-identity-v1 +List of entitlements by identity. +The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-entitlements-by-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity Id | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listEntitlementsByIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-identities-v1 +List identities +This API returns a list of identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** | [optional] [default to undefined] +**defaultFilter** | **'CORRELATED_ONLY' | 'NONE'** | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. | [optional] [default to 'CORRELATED_ONLY'] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const filters: string = id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) +const sorters: string = name,-cloudStatus; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) +const defaultFilter: string = NONE; // Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listIdentitiesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## reset-identity-v1 +Reset an identity +Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reset-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity Id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity Id +const result = await apiInstance.resetIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## send-identity-verification-account-token-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Send password reset email +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-identity-verification-account-token-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Identity ID | [default to undefined] +**sendaccountverificationrequestV1** | **SendaccountverificationrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity ID +const sendaccountverificationrequestV1: SendaccountverificationrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.sendIdentityVerificationAccountTokenV1(id, sendaccountverificationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-identities-invite-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Invite identities to register +This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-identities-invite-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**inviteidentitiesrequestV1** | **InviteidentitiesrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TaskstatusV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const inviteidentitiesrequestV1: InviteidentitiesrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.startIdentitiesInviteV1(inviteidentitiesrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-identity-processing-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Process a list of identityids +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-identity-processing-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**processidentitiesrequestV1** | **ProcessidentitiesrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TaskresultresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const processidentitiesrequestV1: ProcessidentitiesrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.startIdentityProcessingV1(processidentitiesrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## synchronize-attributes-for-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Attribute synchronization for single identity. +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/synchronize-attributes-for-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | The Identity id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**IdentitysyncjobV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentitiesV1Api(configuration); +const identityId: string = identityId_example; // The Identity id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.synchronizeAttributesForIdentityV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/identities/docs/Methods/Index.md b/sdk-output/identities/docs/Methods/Index.md new file mode 100644 index 00000000..142bb236 --- /dev/null +++ b/sdk-output/identities/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: identities-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: identities-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'identities', 'methods'] +slug: /tools/sdk/typescript/identities/methods +tags: ['SDK', 'Software Development Kit', 'identities', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/identities/docs/Models/Accessrequestcontext.md b/sdk-output/identities/docs/Models/Accessrequestcontext.md new file mode 100644 index 00000000..94e336df --- /dev/null +++ b/sdk-output/identities/docs/Models/Accessrequestcontext.md @@ -0,0 +1,19 @@ +--- +id: v1-accessrequestcontext-v1 +title: AccessrequestcontextV1 +pagination_label: AccessrequestcontextV1 +sidebar_label: AccessrequestcontextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestcontextV1', 'v1AccessrequestcontextV1'] +slug: /tools/sdk/typescript/identities/models/accessrequestcontext-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestcontextV1', 'v1AccessrequestcontextV1'] +--- + +# AccessrequestcontextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**contextAttributes** | **(optional)** **Array<ContextattributedtoV1>** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Accountinfodto.md b/sdk-output/identities/docs/Models/Accountinfodto.md new file mode 100644 index 00000000..92820c81 --- /dev/null +++ b/sdk-output/identities/docs/Models/Accountinfodto.md @@ -0,0 +1,21 @@ +--- +id: v1-accountinfodto-v1 +title: AccountinfodtoV1 +pagination_label: AccountinfodtoV1 +sidebar_label: AccountinfodtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountinfodtoV1', 'v1AccountinfodtoV1'] +slug: /tools/sdk/typescript/identities/models/accountinfodto-v1 +tags: ['SDK', 'Software Development Kit', 'AccountinfodtoV1', 'v1AccountinfodtoV1'] +--- + +# AccountinfodtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nativeIdentity** | **(optional)** **string** | The unique ID of the account generated by the source system | [default to undefined] +**displayName** | **(optional)** **string** | Display name for this account | [default to undefined] +**uuid** | **(optional)** **string** | UUID associated with this account | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Assignmentcontextdto.md b/sdk-output/identities/docs/Models/Assignmentcontextdto.md new file mode 100644 index 00000000..1a130551 --- /dev/null +++ b/sdk-output/identities/docs/Models/Assignmentcontextdto.md @@ -0,0 +1,21 @@ +--- +id: v1-assignmentcontextdto-v1 +title: AssignmentcontextdtoV1 +pagination_label: AssignmentcontextdtoV1 +sidebar_label: AssignmentcontextdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AssignmentcontextdtoV1', 'v1AssignmentcontextdtoV1'] +slug: /tools/sdk/typescript/identities/models/assignmentcontextdto-v1 +tags: ['SDK', 'Software Development Kit', 'AssignmentcontextdtoV1', 'v1AssignmentcontextdtoV1'] +--- + +# AssignmentcontextdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested** | **(optional)** **AccessrequestcontextV1** | | [default to undefined] +**matched** | **(optional)** **Array<RolematchdtoV1>** | | [default to undefined] +**computedDate** | **(optional)** **string** | Date that the assignment will was evaluated | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Basereferencedto.md b/sdk-output/identities/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..f649c05d --- /dev/null +++ b/sdk-output/identities/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/identities/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Contextattributedto.md b/sdk-output/identities/docs/Models/Contextattributedto.md new file mode 100644 index 00000000..7f18484d --- /dev/null +++ b/sdk-output/identities/docs/Models/Contextattributedto.md @@ -0,0 +1,21 @@ +--- +id: v1-contextattributedto-v1 +title: ContextattributedtoV1 +pagination_label: ContextattributedtoV1 +sidebar_label: ContextattributedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ContextattributedtoV1', 'v1ContextattributedtoV1'] +slug: /tools/sdk/typescript/identities/models/contextattributedto-v1 +tags: ['SDK', 'Software Development Kit', 'ContextattributedtoV1', 'v1ContextattributedtoV1'] +--- + +# ContextattributedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **(optional)** **string** | The name of the attribute | [default to undefined] +**value** | **(optional)** **ContextattributedtoValueV1** | | [default to undefined] +**derived** | **(optional)** **boolean** | True if the attribute was derived. | [default to false] + diff --git a/sdk-output/identities/docs/Models/ContextattributedtoValue.md b/sdk-output/identities/docs/Models/ContextattributedtoValue.md new file mode 100644 index 00000000..9490c15d --- /dev/null +++ b/sdk-output/identities/docs/Models/ContextattributedtoValue.md @@ -0,0 +1,18 @@ +--- +id: v1-contextattributedto-value-v1 +title: ContextattributedtoValueV1 +pagination_label: ContextattributedtoValueV1 +sidebar_label: ContextattributedtoValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ContextattributedtoValueV1', 'v1ContextattributedtoValueV1'] +slug: /tools/sdk/typescript/identities/models/contextattributedto-value-v1 +tags: ['SDK', 'Software Development Kit', 'ContextattributedtoValueV1', 'v1ContextattributedtoValueV1'] +--- + +# ContextattributedtoValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/identities/docs/Models/Dtotype.md b/sdk-output/identities/docs/Models/Dtotype.md new file mode 100644 index 00000000..56382aab --- /dev/null +++ b/sdk-output/identities/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/identities/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/identities/docs/Models/Errormessagedto.md b/sdk-output/identities/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b8a2e599 --- /dev/null +++ b/sdk-output/identities/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/identities/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Errorresponsedto.md b/sdk-output/identities/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..8e9ff568 --- /dev/null +++ b/sdk-output/identities/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/identities/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/GetRoleAssignmentsV1200ResponseInner.md b/sdk-output/identities/docs/Models/GetRoleAssignmentsV1200ResponseInner.md new file mode 100644 index 00000000..0cfd23c1 --- /dev/null +++ b/sdk-output/identities/docs/Models/GetRoleAssignmentsV1200ResponseInner.md @@ -0,0 +1,29 @@ +--- +id: v1-get-role-assignments-v1200-response-inner-v1 +title: GetRoleAssignmentsV1200ResponseInnerV1 +pagination_label: GetRoleAssignmentsV1200ResponseInnerV1 +sidebar_label: GetRoleAssignmentsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetRoleAssignmentsV1200ResponseInnerV1', 'v1GetRoleAssignmentsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/identities/models/get-role-assignments-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignmentsV1200ResponseInnerV1', 'v1GetRoleAssignmentsV1200ResponseInnerV1'] +--- + +# GetRoleAssignmentsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Assignment Id | [default to undefined] +**role** | **(optional)** **BasereferencedtoV1** | | [default to undefined] +**addedDate** | **(optional)** **string** | Date that the assignment was added | [default to undefined] +**startDate** | **(optional)** **string** | Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately | [default to undefined] +**removeDate** | **(optional)** **string** | Date that the assignment will be removed | [default to undefined] +**comments** | **(optional)** **string** | Comments added by the user when the assignment was made | [default to undefined] +**assignmentSource** | **(optional)** **string** | Source describing how this assignment was made | [default to undefined] +**assigner** | **(optional)** **RoleassignmentdtoAssignerV1** | | [default to undefined] +**assignedDimensions** | **(optional)** **Array<BasereferencedtoV1>** | Dimensions assigned related to this role | [default to undefined] +**assignmentContext** | **(optional)** **RoleassignmentdtoAssignmentContextV1** | | [default to undefined] +**accountTargets** | **(optional)** **Array<RoletargetdtoV1>** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identity.md b/sdk-output/identities/docs/Models/Identity.md new file mode 100644 index 00000000..af6bc81a --- /dev/null +++ b/sdk-output/identities/docs/Models/Identity.md @@ -0,0 +1,31 @@ +--- +id: v1-identity-v1 +title: IdentityV1 +pagination_label: IdentityV1 +sidebar_label: IdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityV1', 'v1IdentityV1'] +slug: /tools/sdk/typescript/identities/models/identity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityV1', 'v1IdentityV1'] +--- + +# IdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the identity | [readonly] [default to undefined] +**name** | **string** | The identity\'s name is equivalent to its Display Name attribute. | [default to undefined] +**created** | **(optional)** **string** | Creation date of the identity | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the identity | [readonly] [default to undefined] +**alias** | **(optional)** **string** | The identity\'s alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [default to undefined] +**emailAddress** | **(optional)** **string** | The email address of the identity | [default to undefined] +**processingState** | **(optional)** **string** | The processing state of the identity | [default to undefined] +**identityStatus** | **(optional)** **string** | The identity\'s status in the system | [default to undefined] +**managerRef** | **(optional)** **IdentityManagerRefV1** | | [default to undefined] +**isManager** | **(optional)** **boolean** | Whether this identity is a manager of another identity | [default to false] +**lastRefresh** | **(optional)** **string** | The last time the identity was refreshed by the system | [default to undefined] +**attributes** | **(optional)** **object** | A map with the identity attributes for the identity | [default to undefined] +**lifecycleState** | **(optional)** **IdentityLifecycleStateV1** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/IdentityLifecycleState.md b/sdk-output/identities/docs/Models/IdentityLifecycleState.md new file mode 100644 index 00000000..067ba47c --- /dev/null +++ b/sdk-output/identities/docs/Models/IdentityLifecycleState.md @@ -0,0 +1,20 @@ +--- +id: v1-identity-lifecycle-state-v1 +title: IdentityLifecycleStateV1 +pagination_label: IdentityLifecycleStateV1 +sidebar_label: IdentityLifecycleStateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityLifecycleStateV1', 'v1IdentityLifecycleStateV1'] +slug: /tools/sdk/typescript/identities/models/identity-lifecycle-state-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleStateV1', 'v1IdentityLifecycleStateV1'] +--- + +# IdentityLifecycleStateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stateName** | **string** | The name of the lifecycle state | [default to undefined] +**manuallyUpdated** | **boolean** | Whether the lifecycle state has been manually or automatically set | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/IdentityManagerRef.md b/sdk-output/identities/docs/Models/IdentityManagerRef.md new file mode 100644 index 00000000..08961fa9 --- /dev/null +++ b/sdk-output/identities/docs/Models/IdentityManagerRef.md @@ -0,0 +1,21 @@ +--- +id: v1-identity-manager-ref-v1 +title: IdentityManagerRefV1 +pagination_label: IdentityManagerRefV1 +sidebar_label: IdentityManagerRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityManagerRefV1', 'v1IdentityManagerRefV1'] +slug: /tools/sdk/typescript/identities/models/identity-manager-ref-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRefV1', 'v1IdentityManagerRefV1'] +--- + +# IdentityManagerRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity\'s manager | [default to undefined] +**id** | **(optional)** **string** | ID of identity\'s manager | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity\'s manager | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identityassociationdetails.md b/sdk-output/identities/docs/Models/Identityassociationdetails.md new file mode 100644 index 00000000..84b1bc06 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identityassociationdetails.md @@ -0,0 +1,20 @@ +--- +id: v1-identityassociationdetails-v1 +title: IdentityassociationdetailsV1 +pagination_label: IdentityassociationdetailsV1 +sidebar_label: IdentityassociationdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityassociationdetailsV1', 'v1IdentityassociationdetailsV1'] +slug: /tools/sdk/typescript/identities/models/identityassociationdetails-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityassociationdetailsV1', 'v1IdentityassociationdetailsV1'] +--- + +# IdentityassociationdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **string** | any additional context information of the http call result | [default to undefined] +**associationDetails** | **(optional)** **Array<IdentityassociationdetailsAssociationDetailsInnerV1>** | list of all the resource associations for the identity | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/IdentityassociationdetailsAssociationDetailsInner.md b/sdk-output/identities/docs/Models/IdentityassociationdetailsAssociationDetailsInner.md new file mode 100644 index 00000000..4be75e2e --- /dev/null +++ b/sdk-output/identities/docs/Models/IdentityassociationdetailsAssociationDetailsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-identityassociationdetails-association-details-inner-v1 +title: IdentityassociationdetailsAssociationDetailsInnerV1 +pagination_label: IdentityassociationdetailsAssociationDetailsInnerV1 +sidebar_label: IdentityassociationdetailsAssociationDetailsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityassociationdetailsAssociationDetailsInnerV1', 'v1IdentityassociationdetailsAssociationDetailsInnerV1'] +slug: /tools/sdk/typescript/identities/models/identityassociationdetails-association-details-inner-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityassociationdetailsAssociationDetailsInnerV1', 'v1IdentityassociationdetailsAssociationDetailsInnerV1'] +--- + +# IdentityassociationdetailsAssociationDetailsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**associationType** | **(optional)** **string** | association type with the identity | [default to undefined] +**entities** | **(optional)** **Array<IdentityentitiesV1>** | the specific resource this identity has ownership on | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identityentities.md b/sdk-output/identities/docs/Models/Identityentities.md new file mode 100644 index 00000000..7ad4af12 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identityentities.md @@ -0,0 +1,19 @@ +--- +id: v1-identityentities-v1 +title: IdentityentitiesV1 +pagination_label: IdentityentitiesV1 +sidebar_label: IdentityentitiesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitiesV1', 'v1IdentityentitiesV1'] +slug: /tools/sdk/typescript/identities/models/identityentities-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitiesV1', 'v1IdentityentitiesV1'] +--- + +# IdentityentitiesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityEntity** | **(optional)** **IdentityentitiesIdentityEntityV1** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/IdentityentitiesIdentityEntity.md b/sdk-output/identities/docs/Models/IdentityentitiesIdentityEntity.md new file mode 100644 index 00000000..5b1247e5 --- /dev/null +++ b/sdk-output/identities/docs/Models/IdentityentitiesIdentityEntity.md @@ -0,0 +1,21 @@ +--- +id: v1-identityentities-identity-entity-v1 +title: IdentityentitiesIdentityEntityV1 +pagination_label: IdentityentitiesIdentityEntityV1 +sidebar_label: IdentityentitiesIdentityEntityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitiesIdentityEntityV1', 'v1IdentityentitiesIdentityEntityV1'] +slug: /tools/sdk/typescript/identities/models/identityentities-identity-entity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitiesIdentityEntityV1', 'v1IdentityentitiesIdentityEntityV1'] +--- + +# IdentityentitiesIdentityEntityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | id of the resource to which the identity is associated | [default to undefined] +**name** | **(optional)** **string** | name of the resource to which the identity is associated | [default to undefined] +**type** | **(optional)** **string** | type of the resource to which the identity is associated | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identityentitlements.md b/sdk-output/identities/docs/Models/Identityentitlements.md new file mode 100644 index 00000000..3a7f9ce8 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identityentitlements.md @@ -0,0 +1,20 @@ +--- +id: v1-identityentitlements-v1 +title: IdentityentitlementsV1 +pagination_label: IdentityentitlementsV1 +sidebar_label: IdentityentitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityentitlementsV1', 'v1IdentityentitlementsV1'] +slug: /tools/sdk/typescript/identities/models/identityentitlements-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityentitlementsV1', 'v1IdentityentitlementsV1'] +--- + +# IdentityentitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectRef** | **(optional)** **TaggedobjectdtoV1** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | Labels to be applied to object. | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identityownershipassociationdetails.md b/sdk-output/identities/docs/Models/Identityownershipassociationdetails.md new file mode 100644 index 00000000..93ef6417 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identityownershipassociationdetails.md @@ -0,0 +1,19 @@ +--- +id: v1-identityownershipassociationdetails-v1 +title: IdentityownershipassociationdetailsV1 +pagination_label: IdentityownershipassociationdetailsV1 +sidebar_label: IdentityownershipassociationdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityownershipassociationdetailsV1', 'v1IdentityownershipassociationdetailsV1'] +slug: /tools/sdk/typescript/identities/models/identityownershipassociationdetails-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityownershipassociationdetailsV1', 'v1IdentityownershipassociationdetailsV1'] +--- + +# IdentityownershipassociationdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**associationDetails** | **(optional)** **Array<IdentityownershipassociationdetailsAssociationDetailsInnerV1>** | list of all the resource associations for the identity | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/IdentityownershipassociationdetailsAssociationDetailsInner.md b/sdk-output/identities/docs/Models/IdentityownershipassociationdetailsAssociationDetailsInner.md new file mode 100644 index 00000000..bdb845c0 --- /dev/null +++ b/sdk-output/identities/docs/Models/IdentityownershipassociationdetailsAssociationDetailsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-identityownershipassociationdetails-association-details-inner-v1 +title: IdentityownershipassociationdetailsAssociationDetailsInnerV1 +pagination_label: IdentityownershipassociationdetailsAssociationDetailsInnerV1 +sidebar_label: IdentityownershipassociationdetailsAssociationDetailsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityownershipassociationdetailsAssociationDetailsInnerV1', 'v1IdentityownershipassociationdetailsAssociationDetailsInnerV1'] +slug: /tools/sdk/typescript/identities/models/identityownershipassociationdetails-association-details-inner-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityownershipassociationdetailsAssociationDetailsInnerV1', 'v1IdentityownershipassociationdetailsAssociationDetailsInnerV1'] +--- + +# IdentityownershipassociationdetailsAssociationDetailsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**associationType** | **(optional)** **string** | association type with the identity | [default to undefined] +**entities** | **(optional)** **Array<IdentityentitiesV1>** | the specific resource this identity has ownership on | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identitysyncjob.md b/sdk-output/identities/docs/Models/Identitysyncjob.md new file mode 100644 index 00000000..d51b3842 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identitysyncjob.md @@ -0,0 +1,21 @@ +--- +id: v1-identitysyncjob-v1 +title: IdentitysyncjobV1 +pagination_label: IdentitysyncjobV1 +sidebar_label: IdentitysyncjobV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitysyncjobV1', 'v1IdentitysyncjobV1'] +slug: /tools/sdk/typescript/identities/models/identitysyncjob-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitysyncjobV1', 'v1IdentitysyncjobV1'] +--- + +# IdentitysyncjobV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Job ID. | [default to undefined] +**status** | **string** | The job status. | [default to undefined] +**payload** | **IdentitysyncpayloadV1** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Identitysyncpayload.md b/sdk-output/identities/docs/Models/Identitysyncpayload.md new file mode 100644 index 00000000..72487788 --- /dev/null +++ b/sdk-output/identities/docs/Models/Identitysyncpayload.md @@ -0,0 +1,20 @@ +--- +id: v1-identitysyncpayload-v1 +title: IdentitysyncpayloadV1 +pagination_label: IdentitysyncpayloadV1 +sidebar_label: IdentitysyncpayloadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitysyncpayloadV1', 'v1IdentitysyncpayloadV1'] +slug: /tools/sdk/typescript/identities/models/identitysyncpayload-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitysyncpayloadV1', 'v1IdentitysyncpayloadV1'] +--- + +# IdentitysyncpayloadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Payload type. | [default to undefined] +**dataJson** | **string** | Payload type. | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Index.md b/sdk-output/identities/docs/Models/Index.md new file mode 100644 index 00000000..1b1b762b --- /dev/null +++ b/sdk-output/identities/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: identities-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: identities-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'identities', 'models'] +slug: /tools/sdk/typescript/identities/models +tags: ['SDK', 'Software Development Kit', 'identities', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/identities/docs/Models/Inviteidentitiesrequest.md b/sdk-output/identities/docs/Models/Inviteidentitiesrequest.md new file mode 100644 index 00000000..ebda1570 --- /dev/null +++ b/sdk-output/identities/docs/Models/Inviteidentitiesrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-inviteidentitiesrequest-v1 +title: InviteidentitiesrequestV1 +pagination_label: InviteidentitiesrequestV1 +sidebar_label: InviteidentitiesrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InviteidentitiesrequestV1', 'v1InviteidentitiesrequestV1'] +slug: /tools/sdk/typescript/identities/models/inviteidentitiesrequest-v1 +tags: ['SDK', 'Software Development Kit', 'InviteidentitiesrequestV1', 'v1InviteidentitiesrequestV1'] +--- + +# InviteidentitiesrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **(optional)** **Array<string>** | The list of Identities IDs to invite - required when \'uninvited\' is false | [default to undefined] +**uninvited** | **(optional)** **boolean** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when \'ids\' is empty. | [default to false] + diff --git a/sdk-output/identities/docs/Models/Lifecyclestatedto.md b/sdk-output/identities/docs/Models/Lifecyclestatedto.md new file mode 100644 index 00000000..cd623ca5 --- /dev/null +++ b/sdk-output/identities/docs/Models/Lifecyclestatedto.md @@ -0,0 +1,20 @@ +--- +id: v1-lifecyclestatedto-v1 +title: LifecyclestatedtoV1 +pagination_label: LifecyclestatedtoV1 +sidebar_label: LifecyclestatedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LifecyclestatedtoV1', 'v1LifecyclestatedtoV1'] +slug: /tools/sdk/typescript/identities/models/lifecyclestatedto-v1 +tags: ['SDK', 'Software Development Kit', 'LifecyclestatedtoV1', 'v1LifecyclestatedtoV1'] +--- + +# LifecyclestatedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stateName** | **string** | The name of the lifecycle state | [default to undefined] +**manuallyUpdated** | **boolean** | Whether the lifecycle state has been manually or automatically set | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/ListIdentitiesV1401Response.md b/sdk-output/identities/docs/Models/ListIdentitiesV1401Response.md new file mode 100644 index 00000000..f5ada317 --- /dev/null +++ b/sdk-output/identities/docs/Models/ListIdentitiesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identities-v1401-response-v1 +title: ListIdentitiesV1401ResponseV1 +pagination_label: ListIdentitiesV1401ResponseV1 +sidebar_label: ListIdentitiesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentitiesV1401ResponseV1', 'v1ListIdentitiesV1401ResponseV1'] +slug: /tools/sdk/typescript/identities/models/list-identities-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentitiesV1401ResponseV1', 'v1ListIdentitiesV1401ResponseV1'] +--- + +# ListIdentitiesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/ListIdentitiesV1429Response.md b/sdk-output/identities/docs/Models/ListIdentitiesV1429Response.md new file mode 100644 index 00000000..b3bd7307 --- /dev/null +++ b/sdk-output/identities/docs/Models/ListIdentitiesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identities-v1429-response-v1 +title: ListIdentitiesV1429ResponseV1 +pagination_label: ListIdentitiesV1429ResponseV1 +sidebar_label: ListIdentitiesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentitiesV1429ResponseV1', 'v1ListIdentitiesV1429ResponseV1'] +slug: /tools/sdk/typescript/identities/models/list-identities-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentitiesV1429ResponseV1', 'v1ListIdentitiesV1429ResponseV1'] +--- + +# ListIdentitiesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Localeorigin.md b/sdk-output/identities/docs/Models/Localeorigin.md new file mode 100644 index 00000000..ba882a69 --- /dev/null +++ b/sdk-output/identities/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/identities/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/identities/docs/Models/Localizedmessage.md b/sdk-output/identities/docs/Models/Localizedmessage.md new file mode 100644 index 00000000..03786b9f --- /dev/null +++ b/sdk-output/identities/docs/Models/Localizedmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-localizedmessage-v1 +title: LocalizedmessageV1 +pagination_label: LocalizedmessageV1 +sidebar_label: LocalizedmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +slug: /tools/sdk/typescript/identities/models/localizedmessage-v1 +tags: ['SDK', 'Software Development Kit', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +--- + +# LocalizedmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **string** | Message locale | [default to undefined] +**message** | **string** | Message text | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Processidentitiesrequest.md b/sdk-output/identities/docs/Models/Processidentitiesrequest.md new file mode 100644 index 00000000..4289cf51 --- /dev/null +++ b/sdk-output/identities/docs/Models/Processidentitiesrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-processidentitiesrequest-v1 +title: ProcessidentitiesrequestV1 +pagination_label: ProcessidentitiesrequestV1 +sidebar_label: ProcessidentitiesrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProcessidentitiesrequestV1', 'v1ProcessidentitiesrequestV1'] +slug: /tools/sdk/typescript/identities/models/processidentitiesrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ProcessidentitiesrequestV1', 'v1ProcessidentitiesrequestV1'] +--- + +# ProcessidentitiesrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityIds** | **(optional)** **Array<string>** | List of up to 250 identity IDs to process. | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/README.md b/sdk-output/identities/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identities/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identities/docs/Models/Roleassignmentdto.md b/sdk-output/identities/docs/Models/Roleassignmentdto.md new file mode 100644 index 00000000..a348bf02 --- /dev/null +++ b/sdk-output/identities/docs/Models/Roleassignmentdto.md @@ -0,0 +1,29 @@ +--- +id: v1-roleassignmentdto-v1 +title: RoleassignmentdtoV1 +pagination_label: RoleassignmentdtoV1 +sidebar_label: RoleassignmentdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleassignmentdtoV1', 'v1RoleassignmentdtoV1'] +slug: /tools/sdk/typescript/identities/models/roleassignmentdto-v1 +tags: ['SDK', 'Software Development Kit', 'RoleassignmentdtoV1', 'v1RoleassignmentdtoV1'] +--- + +# RoleassignmentdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Assignment Id | [default to undefined] +**role** | **(optional)** **BasereferencedtoV1** | | [default to undefined] +**comments** | **(optional)** **string** | Comments added by the user when the assignment was made | [default to undefined] +**assignmentSource** | **(optional)** **string** | Source describing how this assignment was made | [default to undefined] +**assigner** | **(optional)** **RoleassignmentdtoAssignerV1** | | [default to undefined] +**assignedDimensions** | **(optional)** **Array<BasereferencedtoV1>** | Dimensions assigned related to this role | [default to undefined] +**assignmentContext** | **(optional)** **RoleassignmentdtoAssignmentContextV1** | | [default to undefined] +**accountTargets** | **(optional)** **Array<RoletargetdtoV1>** | | [default to undefined] +**startDate** | **(optional)** **string** | Date when assignment will be active, if access was requested with a future start date. If null, assignment is active immediately | [default to undefined] +**removeDate** | **(optional)** **string** | Date that the assignment will be removed | [default to undefined] +**addedDate** | **(optional)** **string** | Date that the assignment was added | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/RoleassignmentdtoAssigner.md b/sdk-output/identities/docs/Models/RoleassignmentdtoAssigner.md new file mode 100644 index 00000000..9846fa40 --- /dev/null +++ b/sdk-output/identities/docs/Models/RoleassignmentdtoAssigner.md @@ -0,0 +1,21 @@ +--- +id: v1-roleassignmentdto-assigner-v1 +title: RoleassignmentdtoAssignerV1 +pagination_label: RoleassignmentdtoAssignerV1 +sidebar_label: RoleassignmentdtoAssignerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleassignmentdtoAssignerV1', 'v1RoleassignmentdtoAssignerV1'] +slug: /tools/sdk/typescript/identities/models/roleassignmentdto-assigner-v1 +tags: ['SDK', 'Software Development Kit', 'RoleassignmentdtoAssignerV1', 'v1RoleassignmentdtoAssignerV1'] +--- + +# RoleassignmentdtoAssignerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Object type | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/RoleassignmentdtoAssignmentContext.md b/sdk-output/identities/docs/Models/RoleassignmentdtoAssignmentContext.md new file mode 100644 index 00000000..a16f61a4 --- /dev/null +++ b/sdk-output/identities/docs/Models/RoleassignmentdtoAssignmentContext.md @@ -0,0 +1,21 @@ +--- +id: v1-roleassignmentdto-assignment-context-v1 +title: RoleassignmentdtoAssignmentContextV1 +pagination_label: RoleassignmentdtoAssignmentContextV1 +sidebar_label: RoleassignmentdtoAssignmentContextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleassignmentdtoAssignmentContextV1', 'v1RoleassignmentdtoAssignmentContextV1'] +slug: /tools/sdk/typescript/identities/models/roleassignmentdto-assignment-context-v1 +tags: ['SDK', 'Software Development Kit', 'RoleassignmentdtoAssignmentContextV1', 'v1RoleassignmentdtoAssignmentContextV1'] +--- + +# RoleassignmentdtoAssignmentContextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested** | **(optional)** **AccessrequestcontextV1** | | [default to undefined] +**matched** | **(optional)** **Array<RolematchdtoV1>** | | [default to undefined] +**computedDate** | **(optional)** **string** | Date that the assignment will was evaluated | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Roleassignmentref.md b/sdk-output/identities/docs/Models/Roleassignmentref.md new file mode 100644 index 00000000..330b080d --- /dev/null +++ b/sdk-output/identities/docs/Models/Roleassignmentref.md @@ -0,0 +1,23 @@ +--- +id: v1-roleassignmentref-v1 +title: RoleassignmentrefV1 +pagination_label: RoleassignmentrefV1 +sidebar_label: RoleassignmentrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleassignmentrefV1', 'v1RoleassignmentrefV1'] +slug: /tools/sdk/typescript/identities/models/roleassignmentref-v1 +tags: ['SDK', 'Software Development Kit', 'RoleassignmentrefV1', 'v1RoleassignmentrefV1'] +--- + +# RoleassignmentrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Assignment Id | [default to undefined] +**role** | **(optional)** **BasereferencedtoV1** | | [default to undefined] +**addedDate** | **(optional)** **string** | Date that the assignment was added | [default to undefined] +**startDate** | **(optional)** **string** | Date when assignment will be active, if requested with a future date. If null, assignment is active immediately | [default to undefined] +**removeDate** | **(optional)** **string** | Date that the assignment will be removed | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Rolematchdto.md b/sdk-output/identities/docs/Models/Rolematchdto.md new file mode 100644 index 00000000..ba1858f7 --- /dev/null +++ b/sdk-output/identities/docs/Models/Rolematchdto.md @@ -0,0 +1,20 @@ +--- +id: v1-rolematchdto-v1 +title: RolematchdtoV1 +pagination_label: RolematchdtoV1 +sidebar_label: RolematchdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolematchdtoV1', 'v1RolematchdtoV1'] +slug: /tools/sdk/typescript/identities/models/rolematchdto-v1 +tags: ['SDK', 'Software Development Kit', 'RolematchdtoV1', 'v1RolematchdtoV1'] +--- + +# RolematchdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roleRef** | **(optional)** **BasereferencedtoV1** | | [default to undefined] +**matchedAttributes** | **(optional)** **Array<ContextattributedtoV1>** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Roletargetdto.md b/sdk-output/identities/docs/Models/Roletargetdto.md new file mode 100644 index 00000000..e989b7a7 --- /dev/null +++ b/sdk-output/identities/docs/Models/Roletargetdto.md @@ -0,0 +1,21 @@ +--- +id: v1-roletargetdto-v1 +title: RoletargetdtoV1 +pagination_label: RoletargetdtoV1 +sidebar_label: RoletargetdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoletargetdtoV1', 'v1RoletargetdtoV1'] +slug: /tools/sdk/typescript/identities/models/roletargetdto-v1 +tags: ['SDK', 'Software Development Kit', 'RoletargetdtoV1', 'v1RoletargetdtoV1'] +--- + +# RoletargetdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **(optional)** **BasereferencedtoV1** | | [default to undefined] +**accountInfo** | **(optional)** **AccountinfodtoV1** | | [default to undefined] +**role** | **(optional)** **BasereferencedtoV1** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Sendaccountverificationrequest.md b/sdk-output/identities/docs/Models/Sendaccountverificationrequest.md new file mode 100644 index 00000000..3f0f6108 --- /dev/null +++ b/sdk-output/identities/docs/Models/Sendaccountverificationrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-sendaccountverificationrequest-v1 +title: SendaccountverificationrequestV1 +pagination_label: SendaccountverificationrequestV1 +sidebar_label: SendaccountverificationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendaccountverificationrequestV1', 'v1SendaccountverificationrequestV1'] +slug: /tools/sdk/typescript/identities/models/sendaccountverificationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'SendaccountverificationrequestV1', 'v1SendaccountverificationrequestV1'] +--- + +# SendaccountverificationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceName** | **(optional)** **string** | The source name where identity account password should be reset | [default to undefined] +**via** | **string** | The method to send notification | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taggedobjectdto.md b/sdk-output/identities/docs/Models/Taggedobjectdto.md new file mode 100644 index 00000000..6fe25e64 --- /dev/null +++ b/sdk-output/identities/docs/Models/Taggedobjectdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taggedobjectdto-v1 +title: TaggedobjectdtoV1 +pagination_label: TaggedobjectdtoV1 +sidebar_label: TaggedobjectdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaggedobjectdtoV1', 'v1TaggedobjectdtoV1'] +slug: /tools/sdk/typescript/identities/models/taggedobjectdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaggedobjectdtoV1', 'v1TaggedobjectdtoV1'] +--- + +# TaggedobjectdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type | [default to undefined] +**id** | **(optional)** **string** | ID of the object this reference applies to | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object this reference applies to | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Target.md b/sdk-output/identities/docs/Models/Target.md new file mode 100644 index 00000000..87a2d8a9 --- /dev/null +++ b/sdk-output/identities/docs/Models/Target.md @@ -0,0 +1,21 @@ +--- +id: v1-target-v1 +title: TargetV1 +pagination_label: TargetV1 +sidebar_label: TargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TargetV1', 'v1TargetV1'] +slug: /tools/sdk/typescript/identities/models/target-v1 +tags: ['SDK', 'Software Development Kit', 'TargetV1', 'v1TargetV1'] +--- + +# TargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Target ID | [default to undefined] +**type** | **(optional)** **string** | Target type | [default to undefined] +**name** | **(optional)** **string** | Target name | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taskdefinitionsummary.md b/sdk-output/identities/docs/Models/Taskdefinitionsummary.md new file mode 100644 index 00000000..18e7f97b --- /dev/null +++ b/sdk-output/identities/docs/Models/Taskdefinitionsummary.md @@ -0,0 +1,24 @@ +--- +id: v1-taskdefinitionsummary-v1 +title: TaskdefinitionsummaryV1 +pagination_label: TaskdefinitionsummaryV1 +sidebar_label: TaskdefinitionsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +slug: /tools/sdk/typescript/identities/models/taskdefinitionsummary-v1 +tags: ['SDK', 'Software Development Kit', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +--- + +# TaskdefinitionsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the TaskDefinition | [default to undefined] +**uniqueName** | **string** | Name of the TaskDefinition | [default to undefined] +**description** | **string** | Description of the TaskDefinition | [default to undefined] +**parentName** | **string** | Name of the parent of the TaskDefinition | [default to undefined] +**executor** | **string** | Executor of the TaskDefinition | [default to undefined] +**arguments** | | Formal parameters of the TaskDefinition, without values | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taskresultresponse.md b/sdk-output/identities/docs/Models/Taskresultresponse.md new file mode 100644 index 00000000..fe94e9ee --- /dev/null +++ b/sdk-output/identities/docs/Models/Taskresultresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-taskresultresponse-v1 +title: TaskresultresponseV1 +pagination_label: TaskresultresponseV1 +sidebar_label: TaskresultresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultresponseV1', 'v1TaskresultresponseV1'] +slug: /tools/sdk/typescript/identities/models/taskresultresponse-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultresponseV1', 'v1TaskresultresponseV1'] +--- + +# TaskresultresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | the type of response reference | [default to undefined] +**id** | **(optional)** **string** | the task ID | [default to undefined] +**name** | **(optional)** **string** | the task name (not used in this endpoint, always null) | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taskreturndetails.md b/sdk-output/identities/docs/Models/Taskreturndetails.md new file mode 100644 index 00000000..4c33e2fb --- /dev/null +++ b/sdk-output/identities/docs/Models/Taskreturndetails.md @@ -0,0 +1,20 @@ +--- +id: v1-taskreturndetails-v1 +title: TaskreturndetailsV1 +pagination_label: TaskreturndetailsV1 +sidebar_label: TaskreturndetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +slug: /tools/sdk/typescript/identities/models/taskreturndetails-v1 +tags: ['SDK', 'Software Development Kit', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +--- + +# TaskreturndetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Display name of the TaskReturnDetails | [default to undefined] +**attributeName** | **string** | Attribute the TaskReturnDetails is for | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taskstatus.md b/sdk-output/identities/docs/Models/Taskstatus.md new file mode 100644 index 00000000..38b89dab --- /dev/null +++ b/sdk-output/identities/docs/Models/Taskstatus.md @@ -0,0 +1,36 @@ +--- +id: v1-taskstatus-v1 +title: TaskstatusV1 +pagination_label: TaskstatusV1 +sidebar_label: TaskstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusV1', 'v1TaskstatusV1'] +slug: /tools/sdk/typescript/identities/models/taskstatus-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusV1', 'v1TaskstatusV1'] +--- + +# TaskstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the task this TaskStatus represents | [default to undefined] +**type** | **string** | Type of task this TaskStatus represents | [default to undefined] +**uniqueName** | **string** | Name of the task this TaskStatus represents | [default to undefined] +**description** | **string** | Description of the task this TaskStatus represents | [default to undefined] +**parentName** | **string** | Name of the parent of the task this TaskStatus represents | [default to undefined] +**launcher** | **string** | Service to execute the task this TaskStatus represents | [default to undefined] +**target** | **(optional)** **TargetV1** | | [default to undefined] +**created** | **string** | Creation date of the task this TaskStatus represents | [default to undefined] +**modified** | **string** | Last modification date of the task this TaskStatus represents | [default to undefined] +**launched** | **string** | Launch date of the task this TaskStatus represents | [default to undefined] +**completed** | **string** | Completion date of the task this TaskStatus represents | [default to undefined] +**completionStatus** | **string** | Completion status of the task this TaskStatus represents | [default to undefined] +**messages** | **Array<TaskstatusmessageV1>** | Messages associated with the task this TaskStatus represents | [default to undefined] +**returns** | **Array<TaskreturndetailsV1>** | Return values from the task this TaskStatus represents | [default to undefined] +**attributes** | | Attributes of the task this TaskStatus represents | [default to undefined] +**progress** | **string** | Current progress of the task this TaskStatus represents | [default to undefined] +**percentComplete** | **number** | Current percentage completion of the task this TaskStatus represents | [default to undefined] +**taskDefinitionSummary** | **(optional)** **TaskdefinitionsummaryV1** | | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/Taskstatusmessage.md b/sdk-output/identities/docs/Models/Taskstatusmessage.md new file mode 100644 index 00000000..39d36c3a --- /dev/null +++ b/sdk-output/identities/docs/Models/Taskstatusmessage.md @@ -0,0 +1,22 @@ +--- +id: v1-taskstatusmessage-v1 +title: TaskstatusmessageV1 +pagination_label: TaskstatusmessageV1 +sidebar_label: TaskstatusmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +slug: /tools/sdk/typescript/identities/models/taskstatusmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +--- + +# TaskstatusmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of the message | [default to undefined] +**localizedText** | **LocalizedmessageV1** | | [default to undefined] +**key** | **string** | Key of the message | [default to undefined] +**parameters** | **Array<TaskstatusmessageParametersInnerV1>** | Message parameters for internationalization | [default to undefined] + diff --git a/sdk-output/identities/docs/Models/TaskstatusmessageParametersInner.md b/sdk-output/identities/docs/Models/TaskstatusmessageParametersInner.md new file mode 100644 index 00000000..e4ed8688 --- /dev/null +++ b/sdk-output/identities/docs/Models/TaskstatusmessageParametersInner.md @@ -0,0 +1,18 @@ +--- +id: v1-taskstatusmessage-parameters-inner-v1 +title: TaskstatusmessageParametersInnerV1 +pagination_label: TaskstatusmessageParametersInnerV1 +sidebar_label: TaskstatusmessageParametersInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +slug: /tools/sdk/typescript/identities/models/taskstatusmessage-parameters-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +--- + +# TaskstatusmessageParametersInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/identity_attributes/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/identity_attributes/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..32540fef --- /dev/null +++ b/sdk-output/identity_attributes/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,94 @@ +- path: /identity-attributes/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#create-identity-attribute-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const identityattribute2V1: Identityattribute2V1 = ; // Identityattribute2V1 | + const result = await apiInstance.createIdentityAttributeV1(identityattribute2V1); + console.log(result); +- path: /identity-attributes/v1/{name} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#delete-identity-attribute-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const name: string = 'displayName'; // string | The attribute\'s technical name. (default to undefined) + const result = await apiInstance.deleteIdentityAttributeV1(name); + console.log(result); +- path: /identity-attributes/v1/bulk-delete + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#delete-identity-attributes-in-bulk-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const identityattributenamesV1: IdentityattributenamesV1 = ; // IdentityattributenamesV1 | + const result = await apiInstance.deleteIdentityAttributesInBulkV1(identityattributenamesV1); + console.log(result); +- path: /identity-attributes/v1/{name} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#get-identity-attribute-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const name: string = 'displayName'; // string | The attribute\'s technical name. (default to undefined) + const result = await apiInstance.getIdentityAttributeV1(name); + console.log(result); +- path: /identity-attributes/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#list-identity-attributes-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const includeSystem: boolean = false; // boolean | Include \'system\' attributes in the response. (optional) (default to false) + const includeSilent: boolean = false; // boolean | Include \'silent\' attributes in the response. (optional) (default to false) + const searchableOnly: boolean = false; // boolean | Include only \'searchable\' attributes in the response. (optional) (default to false) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listIdentityAttributesV1(); + console.log(result); +- path: /identity-attributes/v1/{name} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_attributes/methods/identity-attributes#put-identity-attribute-v1 + source: | + import { IdentityAttributesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityAttributesV1Api(configuration); + const name: string = 'displayName'; // string | The attribute\'s technical name. (default to undefined) + const identityattribute2V1: Identityattribute2V1 = ; // Identityattribute2V1 | + const result = await apiInstance.putIdentityAttributeV1(name, identityattribute2V1); + console.log(result); diff --git a/sdk-output/identity_attributes/docs/Methods/IdentityAttributesV1Api.md b/sdk-output/identity_attributes/docs/Methods/IdentityAttributesV1Api.md new file mode 100644 index 00000000..e9006283 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Methods/IdentityAttributesV1Api.md @@ -0,0 +1,261 @@ +--- +id: v1-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityAttributes', 'v1IdentityAttributes'] +slug: /tools/sdk/typescript/identity_attributes/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'v1IdentityAttributes'] +--- + +# IdentityAttributesV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-attribute-v1**](#create-identity-attribute-v1) | **POST** `/identity-attributes/v1` | Create identity attribute +[**delete-identity-attribute-v1**](#delete-identity-attribute-v1) | **DELETE** `/identity-attributes/v1/{name}` | Delete identity attribute +[**delete-identity-attributes-in-bulk-v1**](#delete-identity-attributes-in-bulk-v1) | **DELETE** `/identity-attributes/v1/bulk-delete` | Bulk delete identity attributes +[**get-identity-attribute-v1**](#get-identity-attribute-v1) | **GET** `/identity-attributes/v1/{name}` | Get identity attribute +[**list-identity-attributes-v1**](#list-identity-attributes-v1) | **GET** `/identity-attributes/v1` | List identity attributes +[**put-identity-attribute-v1**](#put-identity-attribute-v1) | **PUT** `/identity-attributes/v1/{name}` | Update identity attribute + + +## create-identity-attribute-v1 +Create identity attribute +Use this API to create a new identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-identity-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityattribute2V1** | **Identityattribute2V1** | | + +### Return type + +**Identityattribute2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const identityattribute2V1: Identityattribute2V1 = ; // +const result = await apiInstance.createIdentityAttributeV1(identityattribute2V1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-identity-attribute-v1 +Delete identity attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The attribute\'s technical name. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const name: string = displayName; // The attribute\'s technical name. +const result = await apiInstance.deleteIdentityAttributeV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## delete-identity-attributes-in-bulk-v1 +Bulk delete identity attributes +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-attributes-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityattributenamesV1** | **IdentityattributenamesV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const identityattributenamesV1: IdentityattributenamesV1 = ; // +const result = await apiInstance.deleteIdentityAttributesInBulkV1(identityattributenamesV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-attribute-v1 +Get identity attribute +This gets an identity attribute for a given technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The attribute\'s technical name. | [default to undefined] + +### Return type + +**Identityattribute2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const name: string = displayName; // The attribute\'s technical name. +const result = await apiInstance.getIdentityAttributeV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-attributes-v1 +List identity attributes +Use this API to get a collection of identity attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**includeSystem** | **boolean** | Include \'system\' attributes in the response. | [optional] [default to false] +**includeSilent** | **boolean** | Include \'silent\' attributes in the response. | [optional] [default to false] +**searchableOnly** | **boolean** | Include only \'searchable\' attributes in the response. | [optional] [default to false] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const includeSystem: boolean = false; // Include \'system\' attributes in the response. (optional) +const includeSilent: boolean = false; // Include \'silent\' attributes in the response. (optional) +const searchableOnly: boolean = false; // Include only \'searchable\' attributes in the response. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listIdentityAttributesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-identity-attribute-v1 +Update identity attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-identity-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | The attribute\'s technical name. | [default to undefined] +**identityattribute2V1** | **Identityattribute2V1** | | + +### Return type + +**Identityattribute2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityAttributesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityAttributesV1Api(configuration); +const name: string = displayName; // The attribute\'s technical name. +const identityattribute2V1: Identityattribute2V1 = ; // +const result = await apiInstance.putIdentityAttributeV1(name, identityattribute2V1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/identity_attributes/docs/Methods/Index.md b/sdk-output/identity_attributes/docs/Methods/Index.md new file mode 100644 index 00000000..be6a211c --- /dev/null +++ b/sdk-output/identity_attributes/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: identity_attributes-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: identity_attributes-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_attributes', 'methods'] +slug: /tools/sdk/typescript/identity_attributes/methods +tags: ['SDK', 'Software Development Kit', 'identity_attributes', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/identity_attributes/docs/Models/Errormessagedto.md b/sdk-output/identity_attributes/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..7898d7da --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/identity_attributes/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/Errorresponsedto.md b/sdk-output/identity_attributes/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..0f5b1a53 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/identity_attributes/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/Identityattribute2.md b/sdk-output/identity_attributes/docs/Models/Identityattribute2.md new file mode 100644 index 00000000..65310d9f --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Identityattribute2.md @@ -0,0 +1,26 @@ +--- +id: v1-identityattribute2-v1 +title: Identityattribute2V1 +pagination_label: Identityattribute2V1 +sidebar_label: Identityattribute2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Identityattribute2V1', 'v1Identityattribute2V1'] +slug: /tools/sdk/typescript/identity_attributes/models/identityattribute2-v1 +tags: ['SDK', 'Software Development Kit', 'Identityattribute2V1', 'v1Identityattribute2V1'] +--- + +# Identityattribute2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Identity attribute\'s technical name. | [default to undefined] +**displayName** | **(optional)** **string** | Identity attribute\'s business-friendly name. | [default to undefined] +**standard** | **(optional)** **boolean** | Indicates whether the attribute is \'standard\' or \'default\'. | [default to false] +**type** | **(optional)** **string** | Identity attribute\'s type. | [default to undefined] +**multi** | **(optional)** **boolean** | Indicates whether the identity attribute is multi-valued. | [default to false] +**searchable** | **(optional)** **boolean** | Indicates whether the identity attribute is searchable. | [default to false] +**system** | **(optional)** **boolean** | Indicates whether the identity attribute is \'system\', meaning that it doesn\'t have a source and isn\'t configurable. | [default to false] +**sources** | **(optional)** **Array<Source2V1>** | Identity attribute\'s list of sources - this specifies how the rule\'s value is derived. | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/Identityattributenames.md b/sdk-output/identity_attributes/docs/Models/Identityattributenames.md new file mode 100644 index 00000000..4bc04d6e --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Identityattributenames.md @@ -0,0 +1,19 @@ +--- +id: v1-identityattributenames-v1 +title: IdentityattributenamesV1 +pagination_label: IdentityattributenamesV1 +sidebar_label: IdentityattributenamesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributenamesV1', 'v1IdentityattributenamesV1'] +slug: /tools/sdk/typescript/identity_attributes/models/identityattributenames-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributenamesV1', 'v1IdentityattributenamesV1'] +--- + +# IdentityattributenamesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **(optional)** **Array<string>** | List of identity attributes\' technical names. | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/Index.md b/sdk-output/identity_attributes/docs/Models/Index.md new file mode 100644 index 00000000..e78f6b6f --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: identity_attributes-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: identity_attributes-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_attributes', 'models'] +slug: /tools/sdk/typescript/identity_attributes/models +tags: ['SDK', 'Software Development Kit', 'identity_attributes', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1401Response.md b/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1401Response.md new file mode 100644 index 00000000..b8949f66 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-attributes-v1401-response-v1 +title: ListIdentityAttributesV1401ResponseV1 +pagination_label: ListIdentityAttributesV1401ResponseV1 +sidebar_label: ListIdentityAttributesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityAttributesV1401ResponseV1', 'v1ListIdentityAttributesV1401ResponseV1'] +slug: /tools/sdk/typescript/identity_attributes/models/list-identity-attributes-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityAttributesV1401ResponseV1', 'v1ListIdentityAttributesV1401ResponseV1'] +--- + +# ListIdentityAttributesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1429Response.md b/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1429Response.md new file mode 100644 index 00000000..41978a31 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/ListIdentityAttributesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-attributes-v1429-response-v1 +title: ListIdentityAttributesV1429ResponseV1 +pagination_label: ListIdentityAttributesV1429ResponseV1 +sidebar_label: ListIdentityAttributesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityAttributesV1429ResponseV1', 'v1ListIdentityAttributesV1429ResponseV1'] +slug: /tools/sdk/typescript/identity_attributes/models/list-identity-attributes-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityAttributesV1429ResponseV1', 'v1ListIdentityAttributesV1429ResponseV1'] +--- + +# ListIdentityAttributesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_attributes/docs/Models/Localeorigin.md b/sdk-output/identity_attributes/docs/Models/Localeorigin.md new file mode 100644 index 00000000..93376de3 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/identity_attributes/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/identity_attributes/docs/Models/README.md b/sdk-output/identity_attributes/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_attributes/docs/Models/Source2.md b/sdk-output/identity_attributes/docs/Models/Source2.md new file mode 100644 index 00000000..38b0ba21 --- /dev/null +++ b/sdk-output/identity_attributes/docs/Models/Source2.md @@ -0,0 +1,20 @@ +--- +id: v1-source2-v1 +title: Source2V1 +pagination_label: Source2V1 +sidebar_label: Source2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Source2V1', 'v1Source2V1'] +slug: /tools/sdk/typescript/identity_attributes/models/source2-v1 +tags: ['SDK', 'Software Development Kit', 'Source2V1', 'v1Source2V1'] +--- + +# Source2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Attribute mapping type. | [default to undefined] +**properties** | **(optional)** **object** | Attribute mapping properties. | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/identity_history/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a1ad7bdd --- /dev/null +++ b/sdk-output/identity_history/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,217 @@ +- path: /historical-identities/v1/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#compare-identity-snapshots-access-type-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const accessType: string = 'role'; // 'accessProfile' | 'account' | 'app' | 'entitlement' | 'role' | The specific type which needs to be compared (default to undefined) + const accessAssociated: boolean = 2007-03-01T13:00:00Z; // boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) (default to undefined) + const snapshot1: string = '2008-03-01T13:00:00Z'; // string | The snapshot 1 of identity (optional) (default to undefined) + const snapshot2: string = '2009-03-01T13:00:00Z'; // string | The snapshot 2 of identity (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.compareIdentitySnapshotsAccessTypeV1(id, accessType); + console.log(result); +- path: /historical-identities/v1/{id}/compare + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#compare-identity-snapshots-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const snapshot1: string = '2007-03-01T13:00:00Z'; // string | The snapshot 1 of identity (optional) (default to undefined) + const snapshot2: string = '2008-03-01T13:00:00Z'; // string | The snapshot 2 of identity (optional) (default to undefined) + const accessItemTypes: Array<string> = ; // Array | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.compareIdentitySnapshotsV1(id); + console.log(result); +- path: /historical-identities/v1/{id}/events + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#get-historical-identity-events-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const from: string = '2024-03-01T13:00:00Z'; // string | The optional instant until which access events are returned (optional) (default to undefined) + const eventTypes: Array<string> = ["AccessAddedEvent","AccessRemovedEvent"]; // Array | An optional list of event types to return. If null or empty, all events are returned (optional) (default to undefined) + const accessItemTypes: Array<string> = ["entitlement","account"]; // Array | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getHistoricalIdentityEventsV1(id); + console.log(result); +- path: /historical-identities/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#get-historical-identity-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getHistoricalIdentityV1(id); + console.log(result); +- path: /historical-identities/v1/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#get-identity-snapshot-summary-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const before: string = '2007-03-01T13:00:00Z'; // string | The date before which snapshot summary is required (optional) (default to undefined) + const interval: string = 'interval_example'; // 'day' | 'month' | The interval indicating day or month. Defaults to month if not specified (optional) (default to undefined) + const timeZone: string = 'UTC'; // string | The time zone. Defaults to UTC if not provided (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentitySnapshotSummaryV1(id); + console.log(result); +- path: /historical-identities/v1/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#get-identity-snapshot-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const date: string = '2007-03-01T13:00:00Z'; // string | The specified date (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentitySnapshotV1(id, date); + console.log(result); +- path: /historical-identities/v1/{id}/start-date + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#get-identity-start-date-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getIdentityStartDateV1(id); + console.log(result); +- path: /historical-identities/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#list-historical-identities-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const startsWithQuery: string = 'Ada'; // string | This param is used for starts-with search for first, last and display name of the identity (optional) (default to undefined) + const isDeleted: boolean = true; // boolean | Indicates if we want to only list down deleted identities or not. (optional) (default to undefined) + const isActive: boolean = true; // boolean | Indicates if we want to only list active or inactive identities. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listHistoricalIdentitiesV1(); + console.log(result); +- path: /historical-identities/v1/{id}/access-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#list-identity-access-items-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const type: string = 'account'; // 'account' | 'entitlement' | 'app' | 'accessProfile' | 'role' | The type of access item for the identity. If not provided, it defaults to account (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listIdentityAccessItemsV1(id); + console.log(result); +- path: /historical-identities/v1/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#list-identity-snapshot-access-items-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const date: string = '2007-03-01T13:00:00Z'; // string | The specified date (default to undefined) + const type: string = 'account'; // string | The access item type (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listIdentitySnapshotAccessItemsV1(id, date); + console.log(result); +- path: /historical-identities/v1/{id}/snapshots + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_history/methods/identity-history#list-identity-snapshots-v1 + source: | + import { IdentityHistoryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityHistoryV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The identity id (default to undefined) + const start: string = '2007-03-01T13:00:00Z'; // string | The specified start date (optional) (default to undefined) + const interval: string = 'interval_example'; // 'day' | 'month' | The interval indicating the range in day or month for the specified interval-name (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listIdentitySnapshotsV1(id); + console.log(result); diff --git a/sdk-output/identity_history/docs/Methods/IdentityHistoryV1Api.md b/sdk-output/identity_history/docs/Methods/IdentityHistoryV1Api.md new file mode 100644 index 00000000..28b6b078 --- /dev/null +++ b/sdk-output/identity_history/docs/Methods/IdentityHistoryV1Api.md @@ -0,0 +1,586 @@ +--- +id: v1-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityHistory', 'v1IdentityHistory'] +slug: /tools/sdk/typescript/identity_history/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'v1IdentityHistory'] +--- + +# IdentityHistoryV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**compare-identity-snapshots-access-type-v1**](#compare-identity-snapshots-access-type-v1) | **GET** `/historical-identities/v1/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots +[**compare-identity-snapshots-v1**](#compare-identity-snapshots-v1) | **GET** `/historical-identities/v1/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**get-historical-identity-events-v1**](#get-historical-identity-events-v1) | **GET** `/historical-identities/v1/{id}/events` | List identity event history +[**get-historical-identity-v1**](#get-historical-identity-v1) | **GET** `/historical-identities/v1/{id}` | Get latest snapshot of identity +[**get-identity-snapshot-summary-v1**](#get-identity-snapshot-summary-v1) | **GET** `/historical-identities/v1/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**get-identity-snapshot-v1**](#get-identity-snapshot-v1) | **GET** `/historical-identities/v1/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**get-identity-start-date-v1**](#get-identity-start-date-v1) | **GET** `/historical-identities/v1/{id}/start-date` | Gets the start date of the identity +[**list-historical-identities-v1**](#list-historical-identities-v1) | **GET** `/historical-identities/v1` | Lists all the identities +[**list-identity-access-items-v1**](#list-identity-access-items-v1) | **GET** `/historical-identities/v1/{id}/access-items` | List access items by identity +[**list-identity-snapshot-access-items-v1**](#list-identity-snapshot-access-items-v1) | **GET** `/historical-identities/v1/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type +[**list-identity-snapshots-v1**](#list-identity-snapshots-v1) | **GET** `/historical-identities/v1/{id}/snapshots` | Lists all the snapshots for the identity + + +## compare-identity-snapshots-access-type-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets a list of differences of specific accesstype for the given identity between 2 snapshots +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/compare-identity-snapshots-access-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**accessType** | **'accessProfile' | 'account' | 'app' | 'entitlement' | 'role'** | The specific type which needs to be compared | [default to undefined] +**accessAssociated** | **boolean** | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed | [optional] [default to undefined] +**snapshot1** | **string** | The snapshot 1 of identity | [optional] [default to undefined] +**snapshot2** | **string** | The snapshot 2 of identity | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const accessType: string = role; // The specific type which needs to be compared +const accessAssociated: boolean = 2007-03-01T13:00:00Z; // Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) +const snapshot1: string = 2008-03-01T13:00:00Z; // The snapshot 1 of identity (optional) +const snapshot2: string = 2009-03-01T13:00:00Z; // The snapshot 2 of identity (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.compareIdentitySnapshotsAccessTypeV1(id, accessType); +console.log(result); +``` + +[[Back to top]](#) + +## compare-identity-snapshots-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets a difference of count for each access item types for the given identity between 2 snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/compare-identity-snapshots-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**snapshot1** | **string** | The snapshot 1 of identity | [optional] [default to undefined] +**snapshot2** | **string** | The snapshot 2 of identity | [optional] [default to undefined] +**accessItemTypes** | **Array<string>** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const snapshot1: string = 2007-03-01T13:00:00Z; // The snapshot 1 of identity (optional) +const snapshot2: string = 2008-03-01T13:00:00Z; // The snapshot 2 of identity (optional) +const accessItemTypes: Array<string> = ; // An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.compareIdentitySnapshotsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-historical-identity-events-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List identity event history +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-historical-identity-events-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**from** | **string** | The optional instant until which access events are returned | [optional] [default to undefined] +**eventTypes** | **Array<string>** | An optional list of event types to return. If null or empty, all events are returned | [optional] [default to undefined] +**accessItemTypes** | **Array<string>** | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const from: string = 2024-03-01T13:00:00Z; // The optional instant until which access events are returned (optional) +const eventTypes: Array<string> = ["AccessAddedEvent","AccessRemovedEvent"]; // An optional list of event types to return. If null or empty, all events are returned (optional) +const accessItemTypes: Array<string> = ["entitlement","account"]; // An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getHistoricalIdentityEventsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-historical-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get latest snapshot of identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-historical-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**IdentityhistoryresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getHistoricalIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-snapshot-summary-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets the summary for the event count for a specific identity +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-snapshot-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**before** | **string** | The date before which snapshot summary is required | [optional] [default to undefined] +**interval** | **'day' | 'month'** | The interval indicating day or month. Defaults to month if not specified | [optional] [default to undefined] +**timeZone** | **string** | The time zone. Defaults to UTC if not provided | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const before: string = 2007-03-01T13:00:00Z; // The date before which snapshot summary is required (optional) +const interval: string = interval_example; // The interval indicating day or month. Defaults to month if not specified (optional) +const timeZone: string = UTC; // The time zone. Defaults to UTC if not provided (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentitySnapshotSummaryV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-snapshot-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets an identity snapshot at a given date +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-snapshot-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**date** | **string** | The specified date | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**IdentityhistoryresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const date: string = 2007-03-01T13:00:00Z; // The specified date +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentitySnapshotV1(id, date); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-start-date-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets the start date of the identity +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-start-date-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getIdentityStartDateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-historical-identities-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Lists all the identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-historical-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**startsWithQuery** | **string** | This param is used for starts-with search for first, last and display name of the identity | [optional] [default to undefined] +**isDeleted** | **boolean** | Indicates if we want to only list down deleted identities or not. | [optional] [default to undefined] +**isActive** | **boolean** | Indicates if we want to only list active or inactive identities. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const startsWithQuery: string = Ada; // This param is used for starts-with search for first, last and display name of the identity (optional) +const isDeleted: boolean = true; // Indicates if we want to only list down deleted identities or not. (optional) +const isActive: boolean = true; // Indicates if we want to only list active or inactive identities. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listHistoricalIdentitiesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-access-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List access items by identity +This method retrieves a list of access item for the identity filtered by the access item type + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-access-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**type** | **'account' | 'entitlement' | 'app' | 'accessProfile' | 'role'** | The type of access item for the identity. If not provided, it defaults to account | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const type: string = account; // The type of access item for the identity. If not provided, it defaults to account (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listIdentityAccessItemsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-snapshot-access-items-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Gets the list of identity access items at a given date filterd by item type +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-snapshot-access-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**date** | **string** | The specified date | [default to undefined] +**type** | **string** | The access item type | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const date: string = 2007-03-01T13:00:00Z; // The specified date +const type: string = account; // The access item type (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listIdentitySnapshotAccessItemsV1(id, date); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-snapshots-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Lists all the snapshots for the identity +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-snapshots-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The identity id | [default to undefined] +**start** | **string** | The specified start date | [optional] [default to undefined] +**interval** | **'day' | 'month'** | The interval indicating the range in day or month for the specified interval-name | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityHistoryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityHistoryV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The identity id +const start: string = 2007-03-01T13:00:00Z; // The specified start date (optional) +const interval: string = interval_example; // The interval indicating the range in day or month for the specified interval-name (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listIdentitySnapshotsV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/identity_history/docs/Methods/Index.md b/sdk-output/identity_history/docs/Methods/Index.md new file mode 100644 index 00000000..189fd457 --- /dev/null +++ b/sdk-output/identity_history/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: identity_history-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: identity_history-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_history', 'methods'] +slug: /tools/sdk/typescript/identity_history/methods +tags: ['SDK', 'Software Development Kit', 'identity_history', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/identity_history/docs/Models/Accessitemaccessprofileresponse.md b/sdk-output/identity_history/docs/Models/Accessitemaccessprofileresponse.md new file mode 100644 index 00000000..42892b1a --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemaccessprofileresponse.md @@ -0,0 +1,30 @@ +--- +id: v1-accessitemaccessprofileresponse-v1 +title: AccessitemaccessprofileresponseV1 +pagination_label: AccessitemaccessprofileresponseV1 +sidebar_label: AccessitemaccessprofileresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemaccessprofileresponseV1', 'v1AccessitemaccessprofileresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemaccessprofileresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemaccessprofileresponseV1', 'v1AccessitemaccessprofileresponseV1'] +--- + +# AccessitemaccessprofileresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. accessProfile in this case | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the identity | [default to undefined] +**sourceName** | **(optional)** **string** | the name of the source | [default to undefined] +**entitlementCount** | **number** | the number of entitlements the access profile will create | [default to undefined] +**description** | **(optional)** **string** | the description for the access profile | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**appRefs** | **Array<AccessitemaccessprofileresponseAppRefsInnerV1>** | the list of app ids associated with the access profile | [default to undefined] +**startDate** | **(optional)** **string** | the date the access profile will be assigned to the specified identity, in case requested with a future start date | [default to undefined] +**removeDate** | **(optional)** **string** | the date the access profile is no longer assigned to the specified identity | [default to undefined] +**standalone** | **boolean** | indicates whether the access profile is standalone | [default to undefined] +**revocable** | **boolean** | indicates whether the access profile is revocable | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/AccessitemaccessprofileresponseAppRefsInner.md b/sdk-output/identity_history/docs/Models/AccessitemaccessprofileresponseAppRefsInner.md new file mode 100644 index 00000000..877a432c --- /dev/null +++ b/sdk-output/identity_history/docs/Models/AccessitemaccessprofileresponseAppRefsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-accessitemaccessprofileresponse-app-refs-inner-v1 +title: AccessitemaccessprofileresponseAppRefsInnerV1 +pagination_label: AccessitemaccessprofileresponseAppRefsInnerV1 +sidebar_label: AccessitemaccessprofileresponseAppRefsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemaccessprofileresponseAppRefsInnerV1', 'v1AccessitemaccessprofileresponseAppRefsInnerV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemaccessprofileresponse-app-refs-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemaccessprofileresponseAppRefsInnerV1', 'v1AccessitemaccessprofileresponseAppRefsInnerV1'] +--- + +# AccessitemaccessprofileresponseAppRefsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloudAppId** | **(optional)** **string** | the cloud app id associated with the access profile | [default to undefined] +**cloudAppName** | **(optional)** **string** | the cloud app name associated with the access profile | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemaccountresponse.md b/sdk-output/identity_history/docs/Models/Accessitemaccountresponse.md new file mode 100644 index 00000000..b5440dda --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemaccountresponse.md @@ -0,0 +1,25 @@ +--- +id: v1-accessitemaccountresponse-v1 +title: AccessitemaccountresponseV1 +pagination_label: AccessitemaccountresponseV1 +sidebar_label: AccessitemaccountresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemaccountresponseV1', 'v1AccessitemaccountresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemaccountresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemaccountresponseV1', 'v1AccessitemaccountresponseV1'] +--- + +# AccessitemaccountresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. account in this case | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the identity | [default to undefined] +**sourceName** | **(optional)** **string** | the name of the source | [default to undefined] +**nativeIdentity** | **string** | the native identifier used to uniquely identify an acccount | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**entitlementCount** | **(optional)** **number** | the number of entitlements the account will create | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemappresponse.md b/sdk-output/identity_history/docs/Models/Accessitemappresponse.md new file mode 100644 index 00000000..b70a8b68 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemappresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-accessitemappresponse-v1 +title: AccessitemappresponseV1 +pagination_label: AccessitemappresponseV1 +sidebar_label: AccessitemappresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemappresponseV1', 'v1AccessitemappresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemappresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemappresponseV1', 'v1AccessitemappresponseV1'] +--- + +# AccessitemappresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. entitlement in this case | [default to undefined] +**displayName** | **(optional)** **string** | the access item display name | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**appRoleId** | **string** | the app role id | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemassociated.md b/sdk-output/identity_history/docs/Models/Accessitemassociated.md new file mode 100644 index 00000000..46bf2683 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemassociated.md @@ -0,0 +1,24 @@ +--- +id: v1-accessitemassociated-v1 +title: AccessitemassociatedV1 +pagination_label: AccessitemassociatedV1 +sidebar_label: AccessitemassociatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemassociatedV1', 'v1AccessitemassociatedV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemassociated-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemassociatedV1', 'v1AccessitemassociatedV1'] +--- + +# AccessitemassociatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**accessItem** | **AccessitemassociatedAccessItemV1** | | [default to undefined] +**governanceEvent** | **CorrelatedgovernanceeventV1** | | [default to undefined] +**accessItemType** | **(optional)** **string** | the access item type | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/AccessitemassociatedAccessItem.md b/sdk-output/identity_history/docs/Models/AccessitemassociatedAccessItem.md new file mode 100644 index 00000000..f3df71dd --- /dev/null +++ b/sdk-output/identity_history/docs/Models/AccessitemassociatedAccessItem.md @@ -0,0 +1,37 @@ +--- +id: v1-accessitemassociated-access-item-v1 +title: AccessitemassociatedAccessItemV1 +pagination_label: AccessitemassociatedAccessItemV1 +sidebar_label: AccessitemassociatedAccessItemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemassociatedAccessItemV1', 'v1AccessitemassociatedAccessItemV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemassociated-access-item-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemassociatedAccessItemV1', 'v1AccessitemassociatedAccessItemV1'] +--- + +# AccessitemassociatedAccessItemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. entitlement in this case | [default to undefined] +**displayName** | **(optional)** **string** | the access item display name | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**attribute** | **string** | the entitlement attribute | [default to undefined] +**value** | **string** | the associated value | [default to undefined] +**type** | **string** | the type of entitlement | [default to undefined] +**description** | **(optional)** **string** | the description for the role | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**standalone** | **boolean** | indicates whether the access profile is standalone | [default to undefined] +**privileged** | **boolean** | indicates whether the entitlement is privileged | [default to undefined] +**cloudGoverned** | **boolean** | indicates whether the entitlement is cloud governed | [default to undefined] +**entitlementCount** | **number** | the number of entitlements the account will create | [default to undefined] +**appRefs** | **Array<AccessitemaccessprofileresponseAppRefsInnerV1>** | the list of app ids associated with the access profile | [default to undefined] +**startDate** | **(optional)** **string** | the date the access profile will be assigned to the specified identity, in case requested with a future start date | [default to undefined] +**removeDate** | **(optional)** **string** | the date the role is no longer assigned to the specified identity | [default to undefined] +**revocable** | **boolean** | indicates whether the role is revocable | [default to undefined] +**nativeIdentity** | **string** | the native identifier used to uniquely identify an acccount | [default to undefined] +**appRoleId** | **string** | the app role id | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemdiff.md b/sdk-output/identity_history/docs/Models/Accessitemdiff.md new file mode 100644 index 00000000..dc8a554e --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemdiff.md @@ -0,0 +1,22 @@ +--- +id: v1-accessitemdiff-v1 +title: AccessitemdiffV1 +pagination_label: AccessitemdiffV1 +sidebar_label: AccessitemdiffV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemdiffV1', 'v1AccessitemdiffV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemdiff-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemdiffV1', 'v1AccessitemdiffV1'] +--- + +# AccessitemdiffV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the id of the access item | [default to undefined] +**eventType** | **(optional)** **string** | | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the access item | [default to undefined] +**sourceName** | **(optional)** **string** | the source name of the access item | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitementitlementresponse.md b/sdk-output/identity_history/docs/Models/Accessitementitlementresponse.md new file mode 100644 index 00000000..3fdfa8f6 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitementitlementresponse.md @@ -0,0 +1,30 @@ +--- +id: v1-accessitementitlementresponse-v1 +title: AccessitementitlementresponseV1 +pagination_label: AccessitementitlementresponseV1 +sidebar_label: AccessitementitlementresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitementitlementresponseV1', 'v1AccessitementitlementresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitementitlementresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitementitlementresponseV1', 'v1AccessitementitlementresponseV1'] +--- + +# AccessitementitlementresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. entitlement in this case | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the identity | [default to undefined] +**sourceName** | **(optional)** **string** | the name of the source | [default to undefined] +**attribute** | **string** | the entitlement attribute | [default to undefined] +**value** | **string** | the associated value | [default to undefined] +**type** | **string** | the type of entitlement | [default to undefined] +**description** | **(optional)** **string** | the description for the entitlment | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**standalone** | **boolean** | indicates whether the entitlement is standalone | [default to undefined] +**privileged** | **boolean** | indicates whether the entitlement is privileged | [default to undefined] +**cloudGoverned** | **boolean** | indicates whether the entitlement is cloud governed | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemremoved.md b/sdk-output/identity_history/docs/Models/Accessitemremoved.md new file mode 100644 index 00000000..cf4f6e2f --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemremoved.md @@ -0,0 +1,24 @@ +--- +id: v1-accessitemremoved-v1 +title: AccessitemremovedV1 +pagination_label: AccessitemremovedV1 +sidebar_label: AccessitemremovedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemremovedV1', 'v1AccessitemremovedV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemremoved-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemremovedV1', 'v1AccessitemremovedV1'] +--- + +# AccessitemremovedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessItem** | **AccessitemassociatedAccessItemV1** | | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] +**accessItemType** | **(optional)** **string** | the access item type | [default to undefined] +**governanceEvent** | **(optional)** **CorrelatedgovernanceeventV1** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessitemroleresponse.md b/sdk-output/identity_history/docs/Models/Accessitemroleresponse.md new file mode 100644 index 00000000..e4d1ebe1 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessitemroleresponse.md @@ -0,0 +1,26 @@ +--- +id: v1-accessitemroleresponse-v1 +title: AccessitemroleresponseV1 +pagination_label: AccessitemroleresponseV1 +sidebar_label: AccessitemroleresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemroleresponseV1', 'v1AccessitemroleresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessitemroleresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemroleresponseV1', 'v1AccessitemroleresponseV1'] +--- + +# AccessitemroleresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. role in this case | [default to undefined] +**displayName** | **(optional)** **string** | the role display name | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**description** | **(optional)** **string** | the description for the role | [default to undefined] +**startDate** | **(optional)** **string** | the date the access profile will be assigned to the specified identity, in case requested with a future start date | [default to undefined] +**removeDate** | **(optional)** **string** | the date the role is no longer assigned to the specified identity | [default to undefined] +**revocable** | **boolean** | indicates whether the role is revocable | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessrequested.md b/sdk-output/identity_history/docs/Models/Accessrequested.md new file mode 100644 index 00000000..f8462a8d --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessrequested.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequested-v1 +title: AccessrequestedV1 +pagination_label: AccessrequestedV1 +sidebar_label: AccessrequestedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestedV1', 'v1AccessrequestedV1'] +slug: /tools/sdk/typescript/identity_history/models/accessrequested-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestedV1', 'v1AccessrequestedV1'] +--- + +# AccessrequestedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequest** | **Accessrequestresponse2V1** | | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessrequestitemresponse.md b/sdk-output/identity_history/docs/Models/Accessrequestitemresponse.md new file mode 100644 index 00000000..a13b42dc --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessrequestitemresponse.md @@ -0,0 +1,26 @@ +--- +id: v1-accessrequestitemresponse-v1 +title: AccessrequestitemresponseV1 +pagination_label: AccessrequestitemresponseV1 +sidebar_label: AccessrequestitemresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestitemresponseV1', 'v1AccessrequestitemresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/accessrequestitemresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestitemresponseV1', 'v1AccessrequestitemresponseV1'] +--- + +# AccessrequestitemresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **string** | the access request item operation | [default to undefined] +**accessItemType** | **(optional)** **string** | the access item type | [default to undefined] +**name** | **(optional)** **string** | the name of access request item | [default to undefined] +**decision** | **(optional)** **string** | the final decision for the access request | [default to undefined] +**description** | **(optional)** **string** | the description of access request item | [default to undefined] +**sourceId** | **(optional)** **string** | the source id | [default to undefined] +**sourceName** | **(optional)** **string** | the source Name | [default to undefined] +**approvalInfos** | **(optional)** **Array<ApprovalinforesponseV1>** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accessrequestresponse2.md b/sdk-output/identity_history/docs/Models/Accessrequestresponse2.md new file mode 100644 index 00000000..df252c75 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accessrequestresponse2.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestresponse2-v1 +title: Accessrequestresponse2V1 +pagination_label: Accessrequestresponse2V1 +sidebar_label: Accessrequestresponse2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accessrequestresponse2V1', 'v1Accessrequestresponse2V1'] +slug: /tools/sdk/typescript/identity_history/models/accessrequestresponse2-v1 +tags: ['SDK', 'Software Development Kit', 'Accessrequestresponse2V1', 'v1Accessrequestresponse2V1'] +--- + +# Accessrequestresponse2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requesterId** | **(optional)** **string** | the requester Id | [default to undefined] +**requesterName** | **(optional)** **string** | the requesterName | [default to undefined] +**items** | **(optional)** **Array<AccessrequestitemresponseV1>** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Accountstatuschanged.md b/sdk-output/identity_history/docs/Models/Accountstatuschanged.md new file mode 100644 index 00000000..ece01258 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Accountstatuschanged.md @@ -0,0 +1,23 @@ +--- +id: v1-accountstatuschanged-v1 +title: AccountstatuschangedV1 +pagination_label: AccountstatuschangedV1 +sidebar_label: AccountstatuschangedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountstatuschangedV1', 'v1AccountstatuschangedV1'] +slug: /tools/sdk/typescript/identity_history/models/accountstatuschanged-v1 +tags: ['SDK', 'Software Development Kit', 'AccountstatuschangedV1', 'v1AccountstatuschangedV1'] +--- + +# AccountstatuschangedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] +**account** | **AccountstatuschangedAccountV1** | | [default to undefined] +**statusChange** | **AccountstatuschangedStatusChangeV1** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/AccountstatuschangedAccount.md b/sdk-output/identity_history/docs/Models/AccountstatuschangedAccount.md new file mode 100644 index 00000000..53f84ce0 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/AccountstatuschangedAccount.md @@ -0,0 +1,25 @@ +--- +id: v1-accountstatuschanged-account-v1 +title: AccountstatuschangedAccountV1 +pagination_label: AccountstatuschangedAccountV1 +sidebar_label: AccountstatuschangedAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountstatuschangedAccountV1', 'v1AccountstatuschangedAccountV1'] +slug: /tools/sdk/typescript/identity_history/models/accountstatuschanged-account-v1 +tags: ['SDK', 'Software Development Kit', 'AccountstatuschangedAccountV1', 'v1AccountstatuschangedAccountV1'] +--- + +# AccountstatuschangedAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the ID of the account in the database | [default to undefined] +**nativeIdentity** | **(optional)** **string** | the native identifier of the account | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the account | [default to undefined] +**sourceId** | **(optional)** **string** | the ID of the source for this account | [default to undefined] +**sourceName** | **(optional)** **string** | the name of the source for this account | [default to undefined] +**entitlementCount** | **(optional)** **number** | the number of entitlements on this account | [default to undefined] +**accessType** | **(optional)** **string** | this value is always \"account\" | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/AccountstatuschangedStatusChange.md b/sdk-output/identity_history/docs/Models/AccountstatuschangedStatusChange.md new file mode 100644 index 00000000..a5a6076d --- /dev/null +++ b/sdk-output/identity_history/docs/Models/AccountstatuschangedStatusChange.md @@ -0,0 +1,20 @@ +--- +id: v1-accountstatuschanged-status-change-v1 +title: AccountstatuschangedStatusChangeV1 +pagination_label: AccountstatuschangedStatusChangeV1 +sidebar_label: AccountstatuschangedStatusChangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountstatuschangedStatusChangeV1', 'v1AccountstatuschangedStatusChangeV1'] +slug: /tools/sdk/typescript/identity_history/models/accountstatuschanged-status-change-v1 +tags: ['SDK', 'Software Development Kit', 'AccountstatuschangedStatusChangeV1', 'v1AccountstatuschangedStatusChangeV1'] +--- + +# AccountstatuschangedStatusChangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previousStatus** | **(optional)** **string** | the previous status of the account | [default to undefined] +**newStatus** | **(optional)** **string** | the new status of the account | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Approvalinforesponse.md b/sdk-output/identity_history/docs/Models/Approvalinforesponse.md new file mode 100644 index 00000000..fc2db19b --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Approvalinforesponse.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalinforesponse-v1 +title: ApprovalinforesponseV1 +pagination_label: ApprovalinforesponseV1 +sidebar_label: ApprovalinforesponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalinforesponseV1', 'v1ApprovalinforesponseV1'] +slug: /tools/sdk/typescript/identity_history/models/approvalinforesponse-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalinforesponseV1', 'v1ApprovalinforesponseV1'] +--- + +# ApprovalinforesponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the id of approver | [default to undefined] +**name** | **(optional)** **string** | the name of approver | [default to undefined] +**status** | **(optional)** **string** | the status of the approval request | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Attributechange.md b/sdk-output/identity_history/docs/Models/Attributechange.md new file mode 100644 index 00000000..5d721ca0 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Attributechange.md @@ -0,0 +1,21 @@ +--- +id: v1-attributechange-v1 +title: AttributechangeV1 +pagination_label: AttributechangeV1 +sidebar_label: AttributechangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributechangeV1', 'v1AttributechangeV1'] +slug: /tools/sdk/typescript/identity_history/models/attributechange-v1 +tags: ['SDK', 'Software Development Kit', 'AttributechangeV1', 'v1AttributechangeV1'] +--- + +# AttributechangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | the attribute name | [default to undefined] +**previousValue** | **(optional)** **string** | the old value of attribute | [default to undefined] +**newValue** | **(optional)** **string** | the new value of attribute | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Attributeschanged.md b/sdk-output/identity_history/docs/Models/Attributeschanged.md new file mode 100644 index 00000000..9f6a40a1 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Attributeschanged.md @@ -0,0 +1,22 @@ +--- +id: v1-attributeschanged-v1 +title: AttributeschangedV1 +pagination_label: AttributeschangedV1 +sidebar_label: AttributeschangedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributeschangedV1', 'v1AttributeschangedV1'] +slug: /tools/sdk/typescript/identity_history/models/attributeschanged-v1 +tags: ['SDK', 'Software Development Kit', 'AttributeschangedV1', 'v1AttributeschangedV1'] +--- + +# AttributeschangedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeChanges** | **Array<AttributechangeV1>** | | [default to undefined] +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Certifierresponse.md b/sdk-output/identity_history/docs/Models/Certifierresponse.md new file mode 100644 index 00000000..62824765 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Certifierresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-certifierresponse-v1 +title: CertifierresponseV1 +pagination_label: CertifierresponseV1 +sidebar_label: CertifierresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertifierresponseV1', 'v1CertifierresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/certifierresponse-v1 +tags: ['SDK', 'Software Development Kit', 'CertifierresponseV1', 'v1CertifierresponseV1'] +--- + +# CertifierresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the id of the certifier | [default to undefined] +**displayName** | **(optional)** **string** | the name of the certifier | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Correlatedgovernanceevent.md b/sdk-output/identity_history/docs/Models/Correlatedgovernanceevent.md new file mode 100644 index 00000000..77e9d32f --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Correlatedgovernanceevent.md @@ -0,0 +1,25 @@ +--- +id: v1-correlatedgovernanceevent-v1 +title: CorrelatedgovernanceeventV1 +pagination_label: CorrelatedgovernanceeventV1 +sidebar_label: CorrelatedgovernanceeventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CorrelatedgovernanceeventV1', 'v1CorrelatedgovernanceeventV1'] +slug: /tools/sdk/typescript/identity_history/models/correlatedgovernanceevent-v1 +tags: ['SDK', 'Software Development Kit', 'CorrelatedgovernanceeventV1', 'v1CorrelatedgovernanceeventV1'] +--- + +# CorrelatedgovernanceeventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the governance event, such as the certification name or access request ID. | [default to undefined] +**dateTime** | **(optional)** **string** | The date that the certification or access request was completed. | [default to undefined] +**type** | **(optional)** **string** | The type of governance event. | [default to undefined] +**governanceId** | **(optional)** **string** | The ID of the instance that caused the event - either the certification ID or access request ID. | [default to undefined] +**owners** | **(optional)** **Array<CertifierresponseV1>** | The owners of the governance event (the certifiers or approvers) | [default to undefined] +**reviewers** | **(optional)** **Array<CertifierresponseV1>** | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [default to undefined] +**decisionMaker** | **(optional)** **CertifierresponseV1** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Errormessagedto.md b/sdk-output/identity_history/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..16e3f36f --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/identity_history/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Errorresponsedto.md b/sdk-output/identity_history/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..b6f001f1 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/identity_history/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/GetHistoricalIdentityEventsV1200ResponseInner.md b/sdk-output/identity_history/docs/Models/GetHistoricalIdentityEventsV1200ResponseInner.md new file mode 100644 index 00000000..a69e47c7 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/GetHistoricalIdentityEventsV1200ResponseInner.md @@ -0,0 +1,34 @@ +--- +id: v1-get-historical-identity-events-v1200-response-inner-v1 +title: GetHistoricalIdentityEventsV1200ResponseInnerV1 +pagination_label: GetHistoricalIdentityEventsV1200ResponseInnerV1 +sidebar_label: GetHistoricalIdentityEventsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetHistoricalIdentityEventsV1200ResponseInnerV1', 'v1GetHistoricalIdentityEventsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/identity_history/models/get-historical-identity-events-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEventsV1200ResponseInnerV1', 'v1GetHistoricalIdentityEventsV1200ResponseInnerV1'] +--- + +# GetHistoricalIdentityEventsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certificationId** | **string** | the id of the certification item | [default to undefined] +**certificationName** | **string** | the certification item name | [default to undefined] +**signedDate** | **(optional)** **string** | the date ceritification was signed | [default to undefined] +**certifiers** | **(optional)** **Array<CertifierresponseV1>** | this field is deprecated and may go away | [default to undefined] +**reviewers** | **(optional)** **Array<CertifierresponseV1>** | The list of identities who review this certification | [default to undefined] +**signer** | **(optional)** **CertifierresponseV1** | | [default to undefined] +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] +**identityId** | **(optional)** **string** | the identity id | [default to undefined] +**accessItem** | **AccessitemassociatedAccessItemV1** | | [default to undefined] +**governanceEvent** | **CorrelatedgovernanceeventV1** | | [default to undefined] +**accessItemType** | **(optional)** **string** | the access item type | [default to undefined] +**attributeChanges** | **Array<AttributechangeV1>** | | [default to undefined] +**accessRequest** | **Accessrequestresponse2V1** | | [default to undefined] +**account** | **AccountstatuschangedAccountV1** | | [default to undefined] +**statusChange** | **AccountstatuschangedStatusChangeV1** | | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Identitycertified.md b/sdk-output/identity_history/docs/Models/Identitycertified.md new file mode 100644 index 00000000..bb916aaf --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Identitycertified.md @@ -0,0 +1,26 @@ +--- +id: v1-identitycertified-v1 +title: IdentitycertifiedV1 +pagination_label: IdentitycertifiedV1 +sidebar_label: IdentitycertifiedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycertifiedV1', 'v1IdentitycertifiedV1'] +slug: /tools/sdk/typescript/identity_history/models/identitycertified-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycertifiedV1', 'v1IdentitycertifiedV1'] +--- + +# IdentitycertifiedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certificationId** | **string** | the id of the certification item | [default to undefined] +**certificationName** | **string** | the certification item name | [default to undefined] +**signedDate** | **(optional)** **string** | the date ceritification was signed | [default to undefined] +**certifiers** | **(optional)** **Array<CertifierresponseV1>** | this field is deprecated and may go away | [default to undefined] +**reviewers** | **(optional)** **Array<CertifierresponseV1>** | The list of identities who review this certification | [default to undefined] +**signer** | **(optional)** **CertifierresponseV1** | | [default to undefined] +**eventType** | **(optional)** **string** | the event type | [default to undefined] +**dateTime** | **(optional)** **string** | the date of event | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Identitycompareresponse.md b/sdk-output/identity_history/docs/Models/Identitycompareresponse.md new file mode 100644 index 00000000..2f38e8b5 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Identitycompareresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-identitycompareresponse-v1 +title: IdentitycompareresponseV1 +pagination_label: IdentitycompareresponseV1 +sidebar_label: IdentitycompareresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycompareresponseV1', 'v1IdentitycompareresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/identitycompareresponse-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycompareresponseV1', 'v1IdentitycompareresponseV1'] +--- + +# IdentitycompareresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessItemDiff** | **(optional)** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Identityhistoryresponse.md b/sdk-output/identity_history/docs/Models/Identityhistoryresponse.md new file mode 100644 index 00000000..3b64ec39 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Identityhistoryresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-identityhistoryresponse-v1 +title: IdentityhistoryresponseV1 +pagination_label: IdentityhistoryresponseV1 +sidebar_label: IdentityhistoryresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityhistoryresponseV1', 'v1IdentityhistoryresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/identityhistoryresponse-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityhistoryresponseV1', 'v1IdentityhistoryresponseV1'] +--- + +# IdentityhistoryresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the identity ID | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the identity | [default to undefined] +**snapshot** | **(optional)** **string** | the date when the identity record was created | [default to undefined] +**deletedDate** | **(optional)** **string** | the date when the identity was deleted | [default to undefined] +**accessItemCount** | **(optional)** | A map containing the count of each access item | [default to undefined] +**attributes** | **(optional)** | A map containing the identity attributes | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Identitylistitem.md b/sdk-output/identity_history/docs/Models/Identitylistitem.md new file mode 100644 index 00000000..9892352b --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Identitylistitem.md @@ -0,0 +1,24 @@ +--- +id: v1-identitylistitem-v1 +title: IdentitylistitemV1 +pagination_label: IdentitylistitemV1 +sidebar_label: IdentitylistitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitylistitemV1', 'v1IdentitylistitemV1'] +slug: /tools/sdk/typescript/identity_history/models/identitylistitem-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitylistitemV1', 'v1IdentitylistitemV1'] +--- + +# IdentitylistitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the identity ID | [default to undefined] +**displayName** | **(optional)** **string** | the display name of the identity | [default to undefined] +**firstName** | **(optional)** **string** | the first name of the identity | [default to undefined] +**lastName** | **(optional)** **string** | the last name of the identity | [default to undefined] +**active** | **(optional)** **boolean** | indicates if an identity is active or not | [default to true] +**deletedDate** | **(optional)** **string** | the date when the identity was deleted | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Identitysnapshotsummaryresponse.md b/sdk-output/identity_history/docs/Models/Identitysnapshotsummaryresponse.md new file mode 100644 index 00000000..88e37c15 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Identitysnapshotsummaryresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-identitysnapshotsummaryresponse-v1 +title: IdentitysnapshotsummaryresponseV1 +pagination_label: IdentitysnapshotsummaryresponseV1 +sidebar_label: IdentitysnapshotsummaryresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitysnapshotsummaryresponseV1', 'v1IdentitysnapshotsummaryresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/identitysnapshotsummaryresponse-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitysnapshotsummaryresponseV1', 'v1IdentitysnapshotsummaryresponseV1'] +--- + +# IdentitysnapshotsummaryresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**snapshot** | **(optional)** **string** | the date when the identity record was created | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Index.md b/sdk-output/identity_history/docs/Models/Index.md new file mode 100644 index 00000000..a2ef8358 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: identity_history-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: identity_history-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_history', 'models'] +slug: /tools/sdk/typescript/identity_history/models +tags: ['SDK', 'Software Development Kit', 'identity_history', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1401Response.md b/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1401Response.md new file mode 100644 index 00000000..6208aa8f --- /dev/null +++ b/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-historical-identities-v1401-response-v1 +title: ListHistoricalIdentitiesV1401ResponseV1 +pagination_label: ListHistoricalIdentitiesV1401ResponseV1 +sidebar_label: ListHistoricalIdentitiesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListHistoricalIdentitiesV1401ResponseV1', 'v1ListHistoricalIdentitiesV1401ResponseV1'] +slug: /tools/sdk/typescript/identity_history/models/list-historical-identities-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListHistoricalIdentitiesV1401ResponseV1', 'v1ListHistoricalIdentitiesV1401ResponseV1'] +--- + +# ListHistoricalIdentitiesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1429Response.md b/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1429Response.md new file mode 100644 index 00000000..09b442a9 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/ListHistoricalIdentitiesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-historical-identities-v1429-response-v1 +title: ListHistoricalIdentitiesV1429ResponseV1 +pagination_label: ListHistoricalIdentitiesV1429ResponseV1 +sidebar_label: ListHistoricalIdentitiesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListHistoricalIdentitiesV1429ResponseV1', 'v1ListHistoricalIdentitiesV1429ResponseV1'] +slug: /tools/sdk/typescript/identity_history/models/list-historical-identities-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListHistoricalIdentitiesV1429ResponseV1', 'v1ListHistoricalIdentitiesV1429ResponseV1'] +--- + +# ListHistoricalIdentitiesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/ListIdentityAccessItemsV1200ResponseInner.md b/sdk-output/identity_history/docs/Models/ListIdentityAccessItemsV1200ResponseInner.md new file mode 100644 index 00000000..9eb76553 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/ListIdentityAccessItemsV1200ResponseInner.md @@ -0,0 +1,37 @@ +--- +id: v1-list-identity-access-items-v1200-response-inner-v1 +title: ListIdentityAccessItemsV1200ResponseInnerV1 +pagination_label: ListIdentityAccessItemsV1200ResponseInnerV1 +sidebar_label: ListIdentityAccessItemsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityAccessItemsV1200ResponseInnerV1', 'v1ListIdentityAccessItemsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/identity_history/models/list-identity-access-items-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItemsV1200ResponseInnerV1', 'v1ListIdentityAccessItemsV1200ResponseInnerV1'] +--- + +# ListIdentityAccessItemsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. entitlement in this case | [default to undefined] +**displayName** | **(optional)** **string** | the access item display name | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**attribute** | **string** | the entitlement attribute | [default to undefined] +**value** | **string** | the associated value | [default to undefined] +**type** | **string** | the type of entitlement | [default to undefined] +**description** | **(optional)** **string** | the description for the role | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**standalone** | **boolean** | indicates whether the access profile is standalone | [default to undefined] +**privileged** | **boolean** | indicates whether the entitlement is privileged | [default to undefined] +**cloudGoverned** | **boolean** | indicates whether the entitlement is cloud governed | [default to undefined] +**entitlementCount** | **number** | the number of entitlements the account will create | [default to undefined] +**appRefs** | **Array<AccessitemaccessprofileresponseAppRefsInnerV1>** | the list of app ids associated with the access profile | [default to undefined] +**startDate** | **(optional)** **string** | the date the access profile will be assigned to the specified identity, in case requested with a future start date | [default to undefined] +**removeDate** | **(optional)** **string** | the date the role is no longer assigned to the specified identity | [default to undefined] +**revocable** | **boolean** | indicates whether the role is revocable | [default to undefined] +**nativeIdentity** | **string** | the native identifier used to uniquely identify an acccount | [default to undefined] +**appRoleId** | **string** | the app role id | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/ListIdentitySnapshotAccessItemsV1200ResponseInner.md b/sdk-output/identity_history/docs/Models/ListIdentitySnapshotAccessItemsV1200ResponseInner.md new file mode 100644 index 00000000..ca3cdf0b --- /dev/null +++ b/sdk-output/identity_history/docs/Models/ListIdentitySnapshotAccessItemsV1200ResponseInner.md @@ -0,0 +1,37 @@ +--- +id: v1-list-identity-snapshot-access-items-v1200-response-inner-v1 +title: ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 +pagination_label: ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 +sidebar_label: ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentitySnapshotAccessItemsV1200ResponseInnerV1', 'v1ListIdentitySnapshotAccessItemsV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/identity_history/models/list-identity-snapshot-access-items-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItemsV1200ResponseInnerV1', 'v1ListIdentitySnapshotAccessItemsV1200ResponseInnerV1'] +--- + +# ListIdentitySnapshotAccessItemsV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the access item id | [default to undefined] +**accessType** | **(optional)** **string** | the access item type. role in this case | [default to undefined] +**displayName** | **(optional)** **string** | the role display name | [default to undefined] +**sourceName** | **(optional)** **string** | the associated source name if it exists | [default to undefined] +**entitlementCount** | **number** | the number of entitlements the account will create | [default to undefined] +**description** | **(optional)** **string** | the description for the role | [default to undefined] +**sourceId** | **(optional)** **string** | the id of the source | [default to undefined] +**appRefs** | **Array<AccessitemaccessprofileresponseAppRefsInnerV1>** | the list of app ids associated with the access profile | [default to undefined] +**startDate** | **(optional)** **string** | the date the access profile will be assigned to the specified identity, in case requested with a future start date | [default to undefined] +**removeDate** | **(optional)** **string** | the date the role is no longer assigned to the specified identity | [default to undefined] +**standalone** | **boolean** | indicates whether the entitlement is standalone | [default to undefined] +**revocable** | **boolean** | indicates whether the role is revocable | [default to undefined] +**nativeIdentity** | **string** | the native identifier used to uniquely identify an acccount | [default to undefined] +**appRoleId** | **string** | the app role id | [default to undefined] +**attribute** | **string** | the entitlement attribute | [default to undefined] +**value** | **string** | the associated value | [default to undefined] +**type** | **string** | the type of entitlement | [default to undefined] +**privileged** | **boolean** | indicates whether the entitlement is privileged | [default to undefined] +**cloudGoverned** | **boolean** | indicates whether the entitlement is cloud governed | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/Localeorigin.md b/sdk-output/identity_history/docs/Models/Localeorigin.md new file mode 100644 index 00000000..17bb21a3 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/identity_history/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/identity_history/docs/Models/Metricresponse.md b/sdk-output/identity_history/docs/Models/Metricresponse.md new file mode 100644 index 00000000..dcdd0d27 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/Metricresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-metricresponse-v1 +title: MetricresponseV1 +pagination_label: MetricresponseV1 +sidebar_label: MetricresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MetricresponseV1', 'v1MetricresponseV1'] +slug: /tools/sdk/typescript/identity_history/models/metricresponse-v1 +tags: ['SDK', 'Software Development Kit', 'MetricresponseV1', 'v1MetricresponseV1'] +--- + +# MetricresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | the name of metric | [default to undefined] +**value** | **(optional)** **number** | the value associated to the metric | [default to undefined] + diff --git a/sdk-output/identity_history/docs/Models/README.md b/sdk-output/identity_history/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_history/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_profiles/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/identity_profiles/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..6bf45d2c --- /dev/null +++ b/sdk-output/identity_profiles/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,174 @@ +- path: /identity-profiles/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#create-identity-profile-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityprofileV1: IdentityprofileV1 = ; // IdentityprofileV1 | + const result = await apiInstance.createIdentityProfileV1(identityprofileV1); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#delete-identity-profile-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityProfileId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity profile ID. (default to undefined) + const result = await apiInstance.deleteIdentityProfileV1(identityProfileId); + console.log(result); +- path: /identity-profiles/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#delete-identity-profiles-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const requestBody: Array<string> = ; // Array | Identity Profile bulk delete request body. + const result = await apiInstance.deleteIdentityProfilesV1(requestBody); + console.log(result); +- path: /identity-profiles/v1/export + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#export-identity-profiles-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) (default to undefined) + const sorters: string = 'id,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) (default to undefined) + const result = await apiInstance.exportIdentityProfilesV1(); + console.log(result); +- path: /identity-profiles/v1/identity-preview + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#generate-identity-preview-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identitypreviewrequestV1: IdentitypreviewrequestV1 = ; // IdentitypreviewrequestV1 | Identity Preview request body. + const result = await apiInstance.generateIdentityPreviewV1(identitypreviewrequestV1); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#get-default-identity-attribute-config-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | The Identity Profile ID. (default to undefined) + const result = await apiInstance.getDefaultIdentityAttributeConfigV1(identityProfileId); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#get-identity-profile-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const result = await apiInstance.getIdentityProfileV1(identityProfileId); + console.log(result); +- path: /identity-profiles/v1/import + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#import-identity-profiles-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityprofileexportedobjectV1: Array<IdentityprofileexportedobjectV1> = ; // Array | Previously exported Identity Profiles. + const result = await apiInstance.importIdentityProfilesV1(identityprofileexportedobjectV1); + console.log(result); +- path: /identity-profiles/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#list-identity-profiles-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "ef38f94347e94562b5bb8424a56397d8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) (default to undefined) + const sorters: string = 'id,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) (default to undefined) + const result = await apiInstance.listIdentityProfilesV1(); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#sync-identity-profile-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityProfileId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Identity Profile ID to be processed (default to undefined) + const result = await apiInstance.syncIdentityProfileV1(identityProfileId); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/identity_profiles/methods/identity-profiles#update-identity-profile-v1 + source: | + import { IdentityProfilesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new IdentityProfilesV1Api(configuration); + const identityProfileId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Identity profile ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/identityAttributeConfig/attributeTransforms/0","value":{"identityAttributeName":"location","transformDefinition":{"type":"accountAttribute","attributes":{"sourceName":"Employees","attributeName":"location","sourceId":"2c91808878b7d63b0178c66ffcdc4ce4"}}}}]; // Array | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.updateIdentityProfileV1(identityProfileId, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/identity_profiles/docs/Methods/IdentityProfilesV1Api.md b/sdk-output/identity_profiles/docs/Methods/IdentityProfilesV1Api.md new file mode 100644 index 00000000..d4848125 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Methods/IdentityProfilesV1Api.md @@ -0,0 +1,493 @@ +--- +id: v1-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityProfiles', 'v1IdentityProfiles'] +slug: /tools/sdk/typescript/identity_profiles/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'v1IdentityProfiles'] +--- + +# IdentityProfilesV1Api + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-identity-profile-v1**](#create-identity-profile-v1) | **POST** `/identity-profiles/v1` | Create identity profile +[**delete-identity-profile-v1**](#delete-identity-profile-v1) | **DELETE** `/identity-profiles/v1/{identity-profile-id}` | Delete identity profile +[**delete-identity-profiles-v1**](#delete-identity-profiles-v1) | **POST** `/identity-profiles/v1/bulk-delete` | Delete identity profiles +[**export-identity-profiles-v1**](#export-identity-profiles-v1) | **GET** `/identity-profiles/v1/export` | Export identity profiles +[**generate-identity-preview-v1**](#generate-identity-preview-v1) | **POST** `/identity-profiles/v1/identity-preview` | Generate identity profile preview +[**get-default-identity-attribute-config-v1**](#get-default-identity-attribute-config-v1) | **GET** `/identity-profiles/v1/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**get-identity-profile-v1**](#get-identity-profile-v1) | **GET** `/identity-profiles/v1/{identity-profile-id}` | Get identity profile +[**import-identity-profiles-v1**](#import-identity-profiles-v1) | **POST** `/identity-profiles/v1/import` | Import identity profiles +[**list-identity-profiles-v1**](#list-identity-profiles-v1) | **GET** `/identity-profiles/v1` | List identity profiles +[**sync-identity-profile-v1**](#sync-identity-profile-v1) | **POST** `/identity-profiles/v1/{identity-profile-id}/process-identities` | Process identities under profile +[**update-identity-profile-v1**](#update-identity-profile-v1) | **PATCH** `/identity-profiles/v1/{identity-profile-id}` | Update identity profile + + +## create-identity-profile-v1 +Create identity profile +Creates an identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-identity-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityprofileV1** | **IdentityprofileV1** | | + +### Return type + +**IdentityprofileV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityprofileV1: IdentityprofileV1 = ; // +const result = await apiInstance.createIdentityProfileV1(identityprofileV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-identity-profile-v1 +Delete identity profile +Delete an identity profile by ID. +On success, this endpoint will return a reference to the bulk delete task result. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] + +### Return type + +**TaskresultsimplifiedV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityProfileId: string = ef38f94347e94562b5bb8424a56397d8; // Identity profile ID. +const result = await apiInstance.deleteIdentityProfileV1(identityProfileId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-identity-profiles-v1 +Delete identity profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-identity-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestBody** | **Array<string>** | Identity Profile bulk delete request body. | + +### Return type + +**TaskresultsimplifiedV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const requestBody: Array<string> = ; // Identity Profile bulk delete request body. +const result = await apiInstance.deleteIdentityProfilesV1(requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## export-identity-profiles-v1 +Export identity profiles +This exports existing identity profiles in the format specified by the sp-config service. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-identity-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) +const sorters: string = id,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) +const result = await apiInstance.exportIdentityProfilesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## generate-identity-preview-v1 +Generate identity profile preview +This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/generate-identity-preview-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identitypreviewrequestV1** | **IdentitypreviewrequestV1** | Identity Preview request body. | + +### Return type + +**IdentitypreviewresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identitypreviewrequestV1: IdentitypreviewrequestV1 = ; // Identity Preview request body. +const result = await apiInstance.generateIdentityPreviewV1(identitypreviewrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-default-identity-attribute-config-v1 +Get default identity attribute config +This returns the default identity attribute config. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-default-identity-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | The Identity Profile ID. | [default to undefined] + +### Return type + +**IdentityattributeconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // The Identity Profile ID. +const result = await apiInstance.getDefaultIdentityAttributeConfigV1(identityProfileId); +console.log(result); +``` + +[[Back to top]](#) + +## get-identity-profile-v1 +Get identity profile +Get a single identity profile by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-identity-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] + +### Return type + +**IdentityprofileV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const result = await apiInstance.getIdentityProfileV1(identityProfileId); +console.log(result); +``` + +[[Back to top]](#) + +## import-identity-profiles-v1 +Import identity profiles +This imports previously exported identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-identity-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityprofileexportedobjectV1** | **Array<IdentityprofileexportedobjectV1>** | Previously exported Identity Profiles. | + +### Return type + +**ObjectimportresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityprofileexportedobjectV1: Array<IdentityprofileexportedobjectV1> = ; // Previously exported Identity Profiles. +const result = await apiInstance.importIdentityProfilesV1(identityprofileexportedobjectV1); +console.log(result); +``` + +[[Back to top]](#) + +## list-identity-profiles-v1 +List identity profiles +Get a list of identity profiles, based on the specified query parameters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-identity-profiles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "ef38f94347e94562b5bb8424a56397d8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) +const sorters: string = id,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) +const result = await apiInstance.listIdentityProfilesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## sync-identity-profile-v1 +Process identities under profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/sync-identity-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | The Identity Profile ID to be processed | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityProfileId: string = ef38f94347e94562b5bb8424a56397d8; // The Identity Profile ID to be processed +const result = await apiInstance.syncIdentityProfileV1(identityProfileId); +console.log(result); +``` + +[[Back to top]](#) + +## update-identity-profile-v1 +Update identity profile +Update a specified identity profile with this PATCH request. + +You cannot update these fields: +* id +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-identity-profile-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**IdentityprofileV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { IdentityProfilesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new IdentityProfilesV1Api(configuration); +const identityProfileId: string = ef38f94347e94562b5bb8424a56397d8; // Identity profile ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/identityAttributeConfig/attributeTransforms/0","value":{"identityAttributeName":"location","transformDefinition":{"type":"accountAttribute","attributes":{"sourceName":"Employees","attributeName":"location","sourceId":"2c91808878b7d63b0178c66ffcdc4ce4"}}}}]; // List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.updateIdentityProfileV1(identityProfileId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/identity_profiles/docs/Methods/Index.md b/sdk-output/identity_profiles/docs/Methods/Index.md new file mode 100644 index 00000000..8ba86634 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: identity_profiles-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: identity_profiles-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_profiles', 'methods'] +slug: /tools/sdk/typescript/identity_profiles/methods +tags: ['SDK', 'Software Development Kit', 'identity_profiles', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/identity_profiles/docs/Models/ArrayInner.md b/sdk-output/identity_profiles/docs/Models/ArrayInner.md new file mode 100644 index 00000000..f2e4ff6c --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/identity_profiles/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/identity_profiles/docs/Models/Basecommondto.md b/sdk-output/identity_profiles/docs/Models/Basecommondto.md new file mode 100644 index 00000000..97b0ce7a --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/identity_profiles/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Errormessagedto.md b/sdk-output/identity_profiles/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..e3db18af --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/identity_profiles/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Errorresponsedto.md b/sdk-output/identity_profiles/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..aaaecc2f --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/identity_profiles/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityattributeconfig.md b/sdk-output/identity_profiles/docs/Models/Identityattributeconfig.md new file mode 100644 index 00000000..a4199639 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityattributeconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-identityattributeconfig-v1 +title: IdentityattributeconfigV1 +pagination_label: IdentityattributeconfigV1 +sidebar_label: IdentityattributeconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeconfigV1', 'v1IdentityattributeconfigV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityattributeconfig-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeconfigV1', 'v1IdentityattributeconfigV1'] +--- + +# IdentityattributeconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Backend will only promote values if the profile/mapping is enabled. | [default to false] +**attributeTransforms** | **(optional)** **Array<IdentityattributetransformV1>** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityattributepreview.md b/sdk-output/identity_profiles/docs/Models/Identityattributepreview.md new file mode 100644 index 00000000..6819ced4 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityattributepreview.md @@ -0,0 +1,22 @@ +--- +id: v1-identityattributepreview-v1 +title: IdentityattributepreviewV1 +pagination_label: IdentityattributepreviewV1 +sidebar_label: IdentityattributepreviewV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributepreviewV1', 'v1IdentityattributepreviewV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityattributepreview-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributepreviewV1', 'v1IdentityattributepreviewV1'] +--- + +# IdentityattributepreviewV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the attribute that is being previewed. | [default to undefined] +**value** | **(optional)** **string** | Value that was derived during the preview. | [default to undefined] +**previousValue** | **(optional)** **string** | The value of the attribute before the preview. | [default to undefined] +**errorMessages** | **(optional)** **Array<ErrormessagedtoV1>** | List of error messages | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityattributetransform.md b/sdk-output/identity_profiles/docs/Models/Identityattributetransform.md new file mode 100644 index 00000000..a41b060f --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityattributetransform.md @@ -0,0 +1,20 @@ +--- +id: v1-identityattributetransform-v1 +title: IdentityattributetransformV1 +pagination_label: IdentityattributetransformV1 +sidebar_label: IdentityattributetransformV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributetransformV1', 'v1IdentityattributetransformV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityattributetransform-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributetransformV1', 'v1IdentityattributetransformV1'] +--- + +# IdentityattributetransformV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityAttributeName** | **(optional)** **string** | Identity attribute\'s name. | [default to undefined] +**transformDefinition** | **(optional)** **TransformdefinitionV1** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityexceptionreportreference.md b/sdk-output/identity_profiles/docs/Models/Identityexceptionreportreference.md new file mode 100644 index 00000000..bdc5b9e3 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityexceptionreportreference.md @@ -0,0 +1,20 @@ +--- +id: v1-identityexceptionreportreference-v1 +title: IdentityexceptionreportreferenceV1 +pagination_label: IdentityexceptionreportreferenceV1 +sidebar_label: IdentityexceptionreportreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityexceptionreportreferenceV1', 'v1IdentityexceptionreportreferenceV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityexceptionreportreference-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityexceptionreportreferenceV1', 'v1IdentityexceptionreportreferenceV1'] +--- + +# IdentityexceptionreportreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**taskResultId** | **(optional)** **string** | Task result ID. | [default to undefined] +**reportName** | **(optional)** **string** | Report name. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identitypreviewrequest.md b/sdk-output/identity_profiles/docs/Models/Identitypreviewrequest.md new file mode 100644 index 00000000..8f6a4c29 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identitypreviewrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-identitypreviewrequest-v1 +title: IdentitypreviewrequestV1 +pagination_label: IdentitypreviewrequestV1 +sidebar_label: IdentitypreviewrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitypreviewrequestV1', 'v1IdentitypreviewrequestV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identitypreviewrequest-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitypreviewrequestV1', 'v1IdentitypreviewrequestV1'] +--- + +# IdentitypreviewrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The Identity id | [default to undefined] +**identityAttributeConfig** | **(optional)** **IdentityattributeconfigV1** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identitypreviewresponse.md b/sdk-output/identity_profiles/docs/Models/Identitypreviewresponse.md new file mode 100644 index 00000000..8ea9d650 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identitypreviewresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-identitypreviewresponse-v1 +title: IdentitypreviewresponseV1 +pagination_label: IdentitypreviewresponseV1 +sidebar_label: IdentitypreviewresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitypreviewresponseV1', 'v1IdentitypreviewresponseV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identitypreviewresponse-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitypreviewresponseV1', 'v1IdentitypreviewresponseV1'] +--- + +# IdentitypreviewresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **(optional)** **IdentitypreviewresponseIdentityV1** | | [default to undefined] +**previewAttributes** | **(optional)** **Array<IdentityattributepreviewV1>** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/IdentitypreviewresponseIdentity.md b/sdk-output/identity_profiles/docs/Models/IdentitypreviewresponseIdentity.md new file mode 100644 index 00000000..c65cbcba --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/IdentitypreviewresponseIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-identitypreviewresponse-identity-v1 +title: IdentitypreviewresponseIdentityV1 +pagination_label: IdentitypreviewresponseIdentityV1 +sidebar_label: IdentitypreviewresponseIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitypreviewresponseIdentityV1', 'v1IdentitypreviewresponseIdentityV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identitypreviewresponse-identity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitypreviewresponseIdentityV1', 'v1IdentitypreviewresponseIdentityV1'] +--- + +# IdentitypreviewresponseIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Identity\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s display name. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityprofile.md b/sdk-output/identity_profiles/docs/Models/Identityprofile.md new file mode 100644 index 00000000..145cc85b --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityprofile.md @@ -0,0 +1,31 @@ +--- +id: v1-identityprofile-v1 +title: IdentityprofileV1 +pagination_label: IdentityprofileV1 +sidebar_label: IdentityprofileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofileV1', 'v1IdentityprofileV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityprofile-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofileV1', 'v1IdentityprofileV1'] +--- + +# IdentityprofileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**description** | **(optional)** **string** | Identity profile\'s description. | [default to undefined] +**owner** | **(optional)** **IdentityprofileAllOfOwnerV1** | | [default to undefined] +**priority** | **(optional)** **number** | Identity profile\'s priority. | [default to undefined] +**authoritativeSource** | **IdentityprofileAllOfAuthoritativeSourceV1** | | [default to undefined] +**identityRefreshRequired** | **(optional)** **boolean** | Set this value to \'True\' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [default to false] +**identityCount** | **(optional)** **number** | Number of identities belonging to the identity profile. | [default to undefined] +**identityAttributeConfig** | **(optional)** **IdentityattributeconfigV1** | | [default to undefined] +**identityExceptionReportReference** | **(optional)** **IdentityexceptionreportreferenceV1** | | [default to undefined] +**hasTimeBasedAttr** | **(optional)** **boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [default to false] + diff --git a/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfAuthoritativeSource.md b/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfAuthoritativeSource.md new file mode 100644 index 00000000..8e48b53c --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfAuthoritativeSource.md @@ -0,0 +1,21 @@ +--- +id: v1-identityprofile-all-of-authoritative-source-v1 +title: IdentityprofileAllOfAuthoritativeSourceV1 +pagination_label: IdentityprofileAllOfAuthoritativeSourceV1 +sidebar_label: IdentityprofileAllOfAuthoritativeSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofileAllOfAuthoritativeSourceV1', 'v1IdentityprofileAllOfAuthoritativeSourceV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityprofile-all-of-authoritative-source-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofileAllOfAuthoritativeSourceV1', 'v1IdentityprofileAllOfAuthoritativeSourceV1'] +--- + +# IdentityprofileAllOfAuthoritativeSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Authoritative source\'s object type. | [default to undefined] +**id** | **(optional)** **string** | Authoritative source\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Authoritative source\'s name. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfOwner.md b/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfOwner.md new file mode 100644 index 00000000..3be6f575 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/IdentityprofileAllOfOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-identityprofile-all-of-owner-v1 +title: IdentityprofileAllOfOwnerV1 +pagination_label: IdentityprofileAllOfOwnerV1 +sidebar_label: IdentityprofileAllOfOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofileAllOfOwnerV1', 'v1IdentityprofileAllOfOwnerV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityprofile-all-of-owner-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofileAllOfOwnerV1', 'v1IdentityprofileAllOfOwnerV1'] +--- + +# IdentityprofileAllOfOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s object type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Identityprofileexportedobject.md b/sdk-output/identity_profiles/docs/Models/Identityprofileexportedobject.md new file mode 100644 index 00000000..89ecfc01 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Identityprofileexportedobject.md @@ -0,0 +1,21 @@ +--- +id: v1-identityprofileexportedobject-v1 +title: IdentityprofileexportedobjectV1 +pagination_label: IdentityprofileexportedobjectV1 +sidebar_label: IdentityprofileexportedobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofileexportedobjectV1', 'v1IdentityprofileexportedobjectV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityprofileexportedobject-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofileexportedobjectV1', 'v1IdentityprofileexportedobjectV1'] +--- + +# IdentityprofileexportedobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **(optional)** **number** | Version or object from the target service. | [default to undefined] +**self** | **(optional)** **IdentityprofileexportedobjectSelfV1** | | [default to undefined] +**object** | **(optional)** **IdentityprofileV1** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/IdentityprofileexportedobjectSelf.md b/sdk-output/identity_profiles/docs/Models/IdentityprofileexportedobjectSelf.md new file mode 100644 index 00000000..c9411aef --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/IdentityprofileexportedobjectSelf.md @@ -0,0 +1,21 @@ +--- +id: v1-identityprofileexportedobject-self-v1 +title: IdentityprofileexportedobjectSelfV1 +pagination_label: IdentityprofileexportedobjectSelfV1 +sidebar_label: IdentityprofileexportedobjectSelfV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofileexportedobjectSelfV1', 'v1IdentityprofileexportedobjectSelfV1'] +slug: /tools/sdk/typescript/identity_profiles/models/identityprofileexportedobject-self-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofileexportedobjectSelfV1', 'v1IdentityprofileexportedobjectSelfV1'] +--- + +# IdentityprofileexportedobjectSelfV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Exported object\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Exported object\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Exported object\'s display name. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Importobject.md b/sdk-output/identity_profiles/docs/Models/Importobject.md new file mode 100644 index 00000000..7d394d80 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Importobject.md @@ -0,0 +1,21 @@ +--- +id: v1-importobject-v1 +title: ImportobjectV1 +pagination_label: ImportobjectV1 +sidebar_label: ImportobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportobjectV1', 'v1ImportobjectV1'] +slug: /tools/sdk/typescript/identity_profiles/models/importobject-v1 +tags: ['SDK', 'Software Development Kit', 'ImportobjectV1', 'v1ImportobjectV1'] +--- + +# ImportobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of object created or updated by import. | [default to undefined] +**id** | **(optional)** **string** | ID of object created or updated by import. | [default to undefined] +**name** | **(optional)** **string** | Display name of object created or updated by import. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Index.md b/sdk-output/identity_profiles/docs/Models/Index.md new file mode 100644 index 00000000..9b15ec49 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: identity_profiles-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: identity_profiles-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'identity_profiles', 'models'] +slug: /tools/sdk/typescript/identity_profiles/models +tags: ['SDK', 'Software Development Kit', 'identity_profiles', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/identity_profiles/docs/Models/Jsonpatchoperation.md b/sdk-output/identity_profiles/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..d44d271a --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/identity_profiles/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/JsonpatchoperationValue.md b/sdk-output/identity_profiles/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..2b3175d4 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/identity_profiles/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1401Response.md b/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1401Response.md new file mode 100644 index 00000000..df234d6b --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-profiles-v1401-response-v1 +title: ListIdentityProfilesV1401ResponseV1 +pagination_label: ListIdentityProfilesV1401ResponseV1 +sidebar_label: ListIdentityProfilesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityProfilesV1401ResponseV1', 'v1ListIdentityProfilesV1401ResponseV1'] +slug: /tools/sdk/typescript/identity_profiles/models/list-identity-profiles-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityProfilesV1401ResponseV1', 'v1ListIdentityProfilesV1401ResponseV1'] +--- + +# ListIdentityProfilesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1429Response.md b/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1429Response.md new file mode 100644 index 00000000..fe64fd32 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/ListIdentityProfilesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-identity-profiles-v1429-response-v1 +title: ListIdentityProfilesV1429ResponseV1 +pagination_label: ListIdentityProfilesV1429ResponseV1 +sidebar_label: ListIdentityProfilesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListIdentityProfilesV1429ResponseV1', 'v1ListIdentityProfilesV1429ResponseV1'] +slug: /tools/sdk/typescript/identity_profiles/models/list-identity-profiles-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListIdentityProfilesV1429ResponseV1', 'v1ListIdentityProfilesV1429ResponseV1'] +--- + +# ListIdentityProfilesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Localeorigin.md b/sdk-output/identity_profiles/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dd11ad4c --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/identity_profiles/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/identity_profiles/docs/Models/Objectimportresult.md b/sdk-output/identity_profiles/docs/Models/Objectimportresult.md new file mode 100644 index 00000000..489d6cf8 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Objectimportresult.md @@ -0,0 +1,22 @@ +--- +id: v1-objectimportresult-v1 +title: ObjectimportresultV1 +pagination_label: ObjectimportresultV1 +sidebar_label: ObjectimportresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectimportresultV1', 'v1ObjectimportresultV1'] +slug: /tools/sdk/typescript/identity_profiles/models/objectimportresult-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectimportresultV1', 'v1ObjectimportresultV1'] +--- + +# ObjectimportresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | **Array<SpconfigmessageV1>** | Informational messages returned from the target service on import. | [default to undefined] +**warnings** | **Array<SpconfigmessageV1>** | Warning messages returned from the target service on import. | [default to undefined] +**errors** | **Array<SpconfigmessageV1>** | Error messages returned from the target service on import. | [default to undefined] +**importedObjects** | **Array<ImportobjectV1>** | References to objects that were created or updated by the import. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/README.md b/sdk-output/identity_profiles/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/identity_profiles/docs/Models/Spconfigmessage.md b/sdk-output/identity_profiles/docs/Models/Spconfigmessage.md new file mode 100644 index 00000000..4785d799 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Spconfigmessage.md @@ -0,0 +1,21 @@ +--- +id: v1-spconfigmessage-v1 +title: SpconfigmessageV1 +pagination_label: SpconfigmessageV1 +sidebar_label: SpconfigmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigmessageV1', 'v1SpconfigmessageV1'] +slug: /tools/sdk/typescript/identity_profiles/models/spconfigmessage-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigmessageV1', 'v1SpconfigmessageV1'] +--- + +# SpconfigmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | Message key. | [default to undefined] +**text** | **string** | Message text. | [default to undefined] +**details** | | Message details if any, in key:value pairs. | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Taskresultsimplified.md b/sdk-output/identity_profiles/docs/Models/Taskresultsimplified.md new file mode 100644 index 00000000..2f03d007 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Taskresultsimplified.md @@ -0,0 +1,25 @@ +--- +id: v1-taskresultsimplified-v1 +title: TaskresultsimplifiedV1 +pagination_label: TaskresultsimplifiedV1 +sidebar_label: TaskresultsimplifiedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultsimplifiedV1', 'v1TaskresultsimplifiedV1'] +slug: /tools/sdk/typescript/identity_profiles/models/taskresultsimplified-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultsimplifiedV1', 'v1TaskresultsimplifiedV1'] +--- + +# TaskresultsimplifiedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Task identifier | [default to undefined] +**name** | **(optional)** **string** | Task name | [default to undefined] +**description** | **(optional)** **string** | Task description | [default to undefined] +**launcher** | **(optional)** **string** | User or process who launched the task | [default to undefined] +**completed** | **(optional)** **string** | Date time of completion | [default to undefined] +**launched** | **(optional)** **string** | Date time when the task was launched | [default to undefined] +**completionStatus** | **(optional)** **string** | Task result status | [default to undefined] + diff --git a/sdk-output/identity_profiles/docs/Models/Transformdefinition.md b/sdk-output/identity_profiles/docs/Models/Transformdefinition.md new file mode 100644 index 00000000..186bf6f7 --- /dev/null +++ b/sdk-output/identity_profiles/docs/Models/Transformdefinition.md @@ -0,0 +1,20 @@ +--- +id: v1-transformdefinition-v1 +title: TransformdefinitionV1 +pagination_label: TransformdefinitionV1 +sidebar_label: TransformdefinitionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransformdefinitionV1', 'v1TransformdefinitionV1'] +slug: /tools/sdk/typescript/identity_profiles/models/transformdefinition-v1 +tags: ['SDK', 'Software Development Kit', 'TransformdefinitionV1', 'v1TransformdefinitionV1'] +--- + +# TransformdefinitionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Transform definition type. | [default to undefined] +**attributes** | **(optional)** | Arbitrary key-value pairs to store any metadata for the object | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/jit_access/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5e494169 --- /dev/null +++ b/sdk-output/jit_access/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,31 @@ +- path: /jit-activation-config/v1/{configType} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/jit_access/methods/jit-access#get-jit-activation-config-v1 + source: | + import { JITAccessV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new JITAccessV1Api(configuration); + const configType: string = 'policy'; // 'policy' | Configuration kind to read. Only **policy** (JIT activation policy) is supported today. (default to undefined) + const result = await apiInstance.getJitActivationConfigV1(configType); + console.log(result); +- path: /jit-activation-config/v1/{configType} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/jit_access/methods/jit-access#patch-jit-activation-config-v1 + source: | + import { JITAccessV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new JITAccessV1Api(configuration); + const configType: string = 'policy'; // 'policy' | Configuration kind to update. Only **policy** (JIT activation policy) is supported today. (default to undefined) + const jitaccessoperationrequestV1: Array<JitaccessoperationrequestV1> = ; // Array | + const result = await apiInstance.patchJitActivationConfigV1(configType, jitaccessoperationrequestV1); + console.log(result); diff --git a/sdk-output/jit_access/docs/Methods/Index.md b/sdk-output/jit_access/docs/Methods/Index.md new file mode 100644 index 00000000..c13d2dc6 --- /dev/null +++ b/sdk-output/jit_access/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: jit_access-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: jit_access-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'jit_access', 'methods'] +slug: /tools/sdk/typescript/jit_access/methods +tags: ['SDK', 'Software Development Kit', 'jit_access', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/jit_access/docs/Methods/JITAccessV1Api.md b/sdk-output/jit_access/docs/Methods/JITAccessV1Api.md new file mode 100644 index 00000000..11cdb9f4 --- /dev/null +++ b/sdk-output/jit_access/docs/Methods/JITAccessV1Api.md @@ -0,0 +1,112 @@ +--- +id: v1-jit-access +title: JITAccess +pagination_label: JITAccess +sidebar_label: JITAccess +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JITAccess', 'v1JITAccess'] +slug: /tools/sdk/typescript/jit_access/methods/jit-access +tags: ['SDK', 'Software Development Kit', 'JITAccess', 'v1JITAccess'] +--- + +# JITAccessV1Api + Use these APIs to configure JIT provisioning activation policy for the tenant. +OAuth scopes: **idn:jit-policy:read** and **idn:jit-policy:manage** (get config), **idn:jit-policy:update** and **idn:jit-policy:manage** (update config). JIT activation workflow APIs use **idn:jit-activation-workflow:*** scopes (activate, extend, deactivate, manage, and **idn:jit-activation-workflow-internal:manage**). +For REST contract details, use the JIT Access operations in this specification and the [SailPoint API documentation](https://developer.sailpoint.com/idn/api/). + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-jit-activation-config-v1**](#get-jit-activation-config-v1) | **GET** `/jit-activation-config/v1/{configType}` | Get JIT activation policy configuration +[**patch-jit-activation-config-v1**](#patch-jit-activation-config-v1) | **PATCH** `/jit-activation-config/v1/{configType}` | Update JIT activation policy configuration + + +## get-jit-activation-config-v1 +Get JIT activation policy configuration +Returns the tenant's current JIT activation policy configuration, including governed entitlement IDs, activation and extension time limits, default periods, notification settings, and whether the policy applies to future assignments. + +The tenant comes from the authenticated request context (not the URL). Use **configType** to select which configuration to read. Returns **404** if that configuration has not been stored yet. + +**User level:** POLICY_ADMIN (policy administrator). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-jit-activation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**configType** | **'policy'** | Configuration kind to read. Only **policy** (JIT activation policy) is supported today. | [default to undefined] + +### Return type + +**JitactivationconfigresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { JITAccessV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new JITAccessV1Api(configuration); +const configType: string = policy; // Configuration kind to read. Only **policy** (JIT activation policy) is supported today. +const result = await apiInstance.getJitActivationConfigV1(configType); +console.log(result); +``` + +[[Back to top]](#) + +## patch-jit-activation-config-v1 +Update JIT activation policy configuration +Updates the tenant's JIT activation policy configuration by applying one or more **replace** operations (same shape as JSON Patch: **op**, **path**, **value**). Use this to change entitlement lists, max/default activation and extension durations, notification recipients or template, and the apply-to-future-assignments flag. + +The body must be a non-empty array. Only **replace** is supported; each **path** must be one of the values documented on the request item schema. The tenant is taken from the request context. **configType** selects which configuration to update. Returns **404** if the configuration does not exist, or **400** for an empty body, unknown **configType**, or invalid path/value. + +**User level:** POLICY_ADMIN (policy administrator). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-jit-activation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**configType** | **'policy'** | Configuration kind to update. Only **policy** (JIT activation policy) is supported today. | [default to undefined] +**jitaccessoperationrequestV1** | **Array<JitaccessoperationrequestV1>** | | + +### Return type + +**JitactivationconfigresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { JITAccessV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new JITAccessV1Api(configuration); +const configType: string = policy; // Configuration kind to update. Only **policy** (JIT activation policy) is supported today. +const jitaccessoperationrequestV1: Array<JitaccessoperationrequestV1> = ; // +const result = await apiInstance.patchJitActivationConfigV1(configType, jitaccessoperationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/jit_access/docs/Models/Errormessagedto.md b/sdk-output/jit_access/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..3acec6e1 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/jit_access/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/Errorresponsedto.md b/sdk-output/jit_access/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cfd32de5 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/jit_access/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1401Response.md b/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1401Response.md new file mode 100644 index 00000000..2676ab00 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-jit-activation-config-v1401-response-v1 +title: GetJitActivationConfigV1401ResponseV1 +pagination_label: GetJitActivationConfigV1401ResponseV1 +sidebar_label: GetJitActivationConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetJitActivationConfigV1401ResponseV1', 'v1GetJitActivationConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/jit_access/models/get-jit-activation-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetJitActivationConfigV1401ResponseV1', 'v1GetJitActivationConfigV1401ResponseV1'] +--- + +# GetJitActivationConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1429Response.md b/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1429Response.md new file mode 100644 index 00000000..d725df65 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/GetJitActivationConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-jit-activation-config-v1429-response-v1 +title: GetJitActivationConfigV1429ResponseV1 +pagination_label: GetJitActivationConfigV1429ResponseV1 +sidebar_label: GetJitActivationConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetJitActivationConfigV1429ResponseV1', 'v1GetJitActivationConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/jit_access/models/get-jit-activation-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetJitActivationConfigV1429ResponseV1', 'v1GetJitActivationConfigV1429ResponseV1'] +--- + +# GetJitActivationConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/Index.md b/sdk-output/jit_access/docs/Models/Index.md new file mode 100644 index 00000000..00cec1ff --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: jit_access-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: jit_access-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'jit_access', 'models'] +slug: /tools/sdk/typescript/jit_access/models +tags: ['SDK', 'Software Development Kit', 'jit_access', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/jit_access/docs/Models/Jitaccessoperationrequest.md b/sdk-output/jit_access/docs/Models/Jitaccessoperationrequest.md new file mode 100644 index 00000000..03cdd277 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Jitaccessoperationrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-jitaccessoperationrequest-v1 +title: JitaccessoperationrequestV1 +pagination_label: JitaccessoperationrequestV1 +sidebar_label: JitaccessoperationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitaccessoperationrequestV1', 'v1JitaccessoperationrequestV1'] +slug: /tools/sdk/typescript/jit_access/models/jitaccessoperationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'JitaccessoperationrequestV1', 'v1JitaccessoperationrequestV1'] +--- + +# JitaccessoperationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **(optional)** **string** | Operation type. Defaults to `replace` if omitted. | [default to OpV1_Replace] +**path** | **string** | Path to replace. Only the following JSON Pointer-style paths are supported. | [default to undefined] +**value** | **JitaccessoperationrequestValueV1** | | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/JitaccessoperationrequestValue.md b/sdk-output/jit_access/docs/Models/JitaccessoperationrequestValue.md new file mode 100644 index 00000000..3a7b4c48 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/JitaccessoperationrequestValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jitaccessoperationrequest-value-v1 +title: JitaccessoperationrequestValueV1 +pagination_label: JitaccessoperationrequestValueV1 +sidebar_label: JitaccessoperationrequestValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitaccessoperationrequestValueV1', 'v1JitaccessoperationrequestValueV1'] +slug: /tools/sdk/typescript/jit_access/models/jitaccessoperationrequest-value-v1 +tags: ['SDK', 'Software Development Kit', 'JitaccessoperationrequestValueV1', 'v1JitaccessoperationrequestValueV1'] +--- + +# JitaccessoperationrequestValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/jit_access/docs/Models/Jitactivationconfigresponse.md b/sdk-output/jit_access/docs/Models/Jitactivationconfigresponse.md new file mode 100644 index 00000000..95f5f0f3 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Jitactivationconfigresponse.md @@ -0,0 +1,27 @@ +--- +id: v1-jitactivationconfigresponse-v1 +title: JitactivationconfigresponseV1 +pagination_label: JitactivationconfigresponseV1 +sidebar_label: JitactivationconfigresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationconfigresponseV1', 'v1JitactivationconfigresponseV1'] +slug: /tools/sdk/typescript/jit_access/models/jitactivationconfigresponse-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationconfigresponseV1', 'v1JitactivationconfigresponseV1'] +--- + +# JitactivationconfigresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier of this JIT activation configuration instance (persisted config id). | [default to undefined] +**entitlementIds** | **(optional)** **Array<string>** | Entitlement IDs governed by JIT activation policy. May be a single-element array when only one entitlement is in scope. | [default to undefined] +**maxActivationPeriodMins** | **(optional)** **number** | Maximum allowed JIT activation duration for a single grant, in minutes; null if unset. | [default to undefined] +**maxActivationPeriodExtensionMins** | **(optional)** **number** | Maximum allowed extension of an active JIT activation, in minutes; null if unset. | [default to undefined] +**defaultMaxActivationPeriodMins** | **(optional)** **number** | Default activation duration offered when a user requests JIT access, in minutes; null if unset. | [default to undefined] +**defaultMaxActivationPeriodExtensionMins** | **(optional)** **number** | Default extension duration offered for an active JIT activation, in minutes; null if unset. | [default to undefined] +**notificationRecipients** | **(optional)** **Array<string>** | Email addresses notified for JIT activation events (for example policy owners or a shared mailbox). | [default to undefined] +**notificationTemplate** | **(optional)** **string** | Name or key of the email template used for JIT activation notifications; null if unset. | [default to undefined] +**applyToFutureAssignments** | **boolean** | Whether the policy applies to future entitlement assignments. | [default to undefined] + diff --git a/sdk-output/jit_access/docs/Models/Localeorigin.md b/sdk-output/jit_access/docs/Models/Localeorigin.md new file mode 100644 index 00000000..7a970a98 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/jit_access/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/jit_access/docs/Models/README.md b/sdk-output/jit_access/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/jit_access/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d7679e38 --- /dev/null +++ b/sdk-output/jit_activations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,45 @@ +- path: /jit-activations/v1/activate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/jit_activations/methods/jit-activations#start-activate-workflow-v1 + source: | + import { JITActivationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new JITActivationsV1Api(configuration); + const jitactivationactivaterequestV1: JitactivationactivaterequestV1 = ; // JitactivationactivaterequestV1 | + const result = await apiInstance.startActivateWorkflowV1(jitactivationactivaterequestV1); + console.log(result); +- path: /jit-activations/v1/deactivate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/jit_activations/methods/jit-activations#start-deactivate-workflow-v1 + source: | + import { JITActivationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new JITActivationsV1Api(configuration); + const jitactivationdeactivaterequestV1: JitactivationdeactivaterequestV1 = ; // JitactivationdeactivaterequestV1 | + const result = await apiInstance.startDeactivateWorkflowV1(jitactivationdeactivaterequestV1); + console.log(result); +- path: /jit-activations/v1/extend + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/jit_activations/methods/jit-activations#start-extend-workflow-v1 + source: | + import { JITActivationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new JITActivationsV1Api(configuration); + const jitactivationextendrequestV1: JitactivationextendrequestV1 = ; // JitactivationextendrequestV1 | + const result = await apiInstance.startExtendWorkflowV1(jitactivationextendrequestV1); + console.log(result); diff --git a/sdk-output/jit_activations/docs/Methods/Index.md b/sdk-output/jit_activations/docs/Methods/Index.md new file mode 100644 index 00000000..c5846308 --- /dev/null +++ b/sdk-output/jit_activations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: jit_activations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: jit_activations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'jit_activations', 'methods'] +slug: /tools/sdk/typescript/jit_activations/methods +tags: ['SDK', 'Software Development Kit', 'jit_activations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/jit_activations/docs/Methods/JITActivationsV1Api.md b/sdk-output/jit_activations/docs/Methods/JITActivationsV1Api.md new file mode 100644 index 00000000..acbb0d45 --- /dev/null +++ b/sdk-output/jit_activations/docs/Methods/JITActivationsV1Api.md @@ -0,0 +1,154 @@ +--- +id: v1-jit-activations +title: JITActivations +pagination_label: JITActivations +sidebar_label: JITActivations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JITActivations', 'v1JITActivations'] +slug: /tools/sdk/typescript/jit_activations/methods/jit-activations +tags: ['SDK', 'Software Development Kit', 'JITActivations', 'v1JITActivations'] +--- + +# JITActivationsV1Api + Use this API to start and manage Just-In-Time (JIT) Privileged activation workflows for entitlement connections. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-activate-workflow-v1**](#start-activate-workflow-v1) | **POST** `/jit-activations/v1/activate` | Start JIT activation workflow +[**start-deactivate-workflow-v1**](#start-deactivate-workflow-v1) | **POST** `/jit-activations/v1/deactivate` | Deactivate JIT activation workflow +[**start-extend-workflow-v1**](#start-extend-workflow-v1) | **POST** `/jit-activations/v1/extend` | Extend JIT activation workflow + + +## start-activate-workflow-v1 +Start JIT activation workflow +Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. +The service performs quick validation; the workflow performs additional validation. + +The response is returned with HTTP 202 Accepted while the workflow initializes. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-activate-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jitactivationactivaterequestV1** | **JitactivationactivaterequestV1** | | + +### Return type + +**JitactivationactivateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { JITActivationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new JITActivationsV1Api(configuration); +const jitactivationactivaterequestV1: JitactivationactivaterequestV1 = ; // +const result = await apiInstance.startActivateWorkflowV1(jitactivationactivaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-deactivate-workflow-v1 +Deactivate JIT activation workflow +Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate. + +This request cannot be applied to a workflow that does not exist or whose execution has already completed. +The client receives an error response in those cases. + +The response is returned with HTTP 202 Accepted after the signal is sent. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-deactivate-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jitactivationdeactivaterequestV1** | **JitactivationdeactivaterequestV1** | | + +### Return type + +**JitactivationdeactivateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { JITActivationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new JITActivationsV1Api(configuration); +const jitactivationdeactivaterequestV1: JitactivationdeactivaterequestV1 = ; // +const result = await apiInstance.startDeactivateWorkflowV1(jitactivationdeactivaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-extend-workflow-v1 +Extend JIT activation workflow +Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period +by the requested number of minutes. + +This request cannot be applied to a workflow that does not exist or whose execution has already completed. +The client receives an error response in those cases. + +The response is returned with HTTP 202 Accepted after the signal is sent. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-extend-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jitactivationextendrequestV1** | **JitactivationextendrequestV1** | | + +### Return type + +**JitactivationextendresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { JITActivationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new JITActivationsV1Api(configuration); +const jitactivationextendrequestV1: JitactivationextendrequestV1 = ; // +const result = await apiInstance.startExtendWorkflowV1(jitactivationextendrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/jit_activations/docs/Models/Activationworkflowstatus.md b/sdk-output/jit_activations/docs/Models/Activationworkflowstatus.md new file mode 100644 index 00000000..7858186c --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Activationworkflowstatus.md @@ -0,0 +1,33 @@ +--- +id: v1-activationworkflowstatus-v1 +title: ActivationworkflowstatusV1 +pagination_label: ActivationworkflowstatusV1 +sidebar_label: ActivationworkflowstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ActivationworkflowstatusV1', 'v1ActivationworkflowstatusV1'] +slug: /tools/sdk/typescript/jit_activations/models/activationworkflowstatus-v1 +tags: ['SDK', 'Software Development Kit', 'ActivationworkflowstatusV1', 'v1ActivationworkflowstatusV1'] +--- + +# ActivationworkflowstatusV1 + +## Enum + + +* `Creating` (value: `'CREATING'`) + +* `Activating` (value: `'ACTIVATING'`) + +* `Invalid` (value: `'INVALID'`) + +* `Error` (value: `'ERROR'`) + +* `Provisioned` (value: `'PROVISIONED'`) + +* `Deprovisioning` (value: `'DEPROVISIONING'`) + +* `Completed` (value: `'COMPLETED'`) + +* `Revoked` (value: `'REVOKED'`) + + diff --git a/sdk-output/jit_activations/docs/Models/Errormessagedto.md b/sdk-output/jit_activations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..291fd386 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/jit_activations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Errorresponsedto.md b/sdk-output/jit_activations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..5075688f --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/jit_activations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Index.md b/sdk-output/jit_activations/docs/Models/Index.md new file mode 100644 index 00000000..39f4d882 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: jit_activations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: jit_activations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'jit_activations', 'models'] +slug: /tools/sdk/typescript/jit_activations/models +tags: ['SDK', 'Software Development Kit', 'jit_activations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationactivaterequest.md b/sdk-output/jit_activations/docs/Models/Jitactivationactivaterequest.md new file mode 100644 index 00000000..7b3d942d --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationactivaterequest.md @@ -0,0 +1,20 @@ +--- +id: v1-jitactivationactivaterequest-v1 +title: JitactivationactivaterequestV1 +pagination_label: JitactivationactivaterequestV1 +sidebar_label: JitactivationactivaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationactivaterequestV1', 'v1JitactivationactivaterequestV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationactivaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationactivaterequestV1', 'v1JitactivationactivaterequestV1'] +--- + +# JitactivationactivaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectionId** | **string** | Entitlement connection identifier for the activation. | [default to undefined] +**activationPeriodMins** | **number** | Requested activation duration in minutes. | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationactivateresponse.md b/sdk-output/jit_activations/docs/Models/Jitactivationactivateresponse.md new file mode 100644 index 00000000..72ed480a --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationactivateresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-jitactivationactivateresponse-v1 +title: JitactivationactivateresponseV1 +pagination_label: JitactivationactivateresponseV1 +sidebar_label: JitactivationactivateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationactivateresponseV1', 'v1JitactivationactivateresponseV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationactivateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationactivateresponseV1', 'v1JitactivationactivateresponseV1'] +--- + +# JitactivationactivateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Workflow or business identifier for this activation. | [default to undefined] +**activationId** | **string** | Persistent activation record identifier for this JIT activation. | [default to undefined] +**connectionId** | **string** | Entitlement connection identifier for the activation. | [default to undefined] +**activationPeriodMins** | **number** | Activation duration in minutes for this workflow. | [default to undefined] +**status** | **ActivationworkflowstatusV1** | | [default to undefined] +**startTime** | **string** | Time when the activation workflow was started (ISO-8601). | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationdeactivaterequest.md b/sdk-output/jit_activations/docs/Models/Jitactivationdeactivaterequest.md new file mode 100644 index 00000000..507e4d1b --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationdeactivaterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-jitactivationdeactivaterequest-v1 +title: JitactivationdeactivaterequestV1 +pagination_label: JitactivationdeactivaterequestV1 +sidebar_label: JitactivationdeactivaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationdeactivaterequestV1', 'v1JitactivationdeactivaterequestV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationdeactivaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationdeactivaterequestV1', 'v1JitactivationdeactivaterequestV1'] +--- + +# JitactivationdeactivaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectionId** | **string** | Entitlement connection identifier for the activation to deactivate. | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationdeactivateresponse.md b/sdk-output/jit_activations/docs/Models/Jitactivationdeactivateresponse.md new file mode 100644 index 00000000..4ee77fb8 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationdeactivateresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-jitactivationdeactivateresponse-v1 +title: JitactivationdeactivateresponseV1 +pagination_label: JitactivationdeactivateresponseV1 +sidebar_label: JitactivationdeactivateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationdeactivateresponseV1', 'v1JitactivationdeactivateresponseV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationdeactivateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationdeactivateresponseV1', 'v1JitactivationdeactivateresponseV1'] +--- + +# JitactivationdeactivateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Workflow or business identifier for this activation. | [default to undefined] +**activationId** | **string** | Persistent activation record identifier for this JIT activation. | [default to undefined] +**connectionId** | **string** | Entitlement connection identifier for the activation. | [default to undefined] +**status** | **ActivationworkflowstatusV1** | | [default to undefined] +**startTime** | **string** | Time associated with this deactivation request (ISO-8601). | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationextendrequest.md b/sdk-output/jit_activations/docs/Models/Jitactivationextendrequest.md new file mode 100644 index 00000000..48d4f132 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationextendrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-jitactivationextendrequest-v1 +title: JitactivationextendrequestV1 +pagination_label: JitactivationextendrequestV1 +sidebar_label: JitactivationextendrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationextendrequestV1', 'v1JitactivationextendrequestV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationextendrequest-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationextendrequestV1', 'v1JitactivationextendrequestV1'] +--- + +# JitactivationextendrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectionId** | **string** | Entitlement connection identifier for the activation to extend. | [default to undefined] +**activationPeriodExtensionMins** | **number** | Number of minutes to extend the activation period. | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Jitactivationextendresponse.md b/sdk-output/jit_activations/docs/Models/Jitactivationextendresponse.md new file mode 100644 index 00000000..de2dc137 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Jitactivationextendresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-jitactivationextendresponse-v1 +title: JitactivationextendresponseV1 +pagination_label: JitactivationextendresponseV1 +sidebar_label: JitactivationextendresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JitactivationextendresponseV1', 'v1JitactivationextendresponseV1'] +slug: /tools/sdk/typescript/jit_activations/models/jitactivationextendresponse-v1 +tags: ['SDK', 'Software Development Kit', 'JitactivationextendresponseV1', 'v1JitactivationextendresponseV1'] +--- + +# JitactivationextendresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Workflow or business identifier for this activation. | [default to undefined] +**activationId** | **string** | Persistent activation record identifier for this JIT activation. | [default to undefined] +**connectionId** | **string** | Entitlement connection identifier for the activation. | [default to undefined] +**activationPeriodExtensionMins** | **number** | Extension applied to the activation period, in minutes. | [default to undefined] +**status** | **ActivationworkflowstatusV1** | | [default to undefined] +**startTime** | **string** | Time associated with this extend request (ISO-8601). | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/Localeorigin.md b/sdk-output/jit_activations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..40f1a684 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/jit_activations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/jit_activations/docs/Models/README.md b/sdk-output/jit_activations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1401Response.md b/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1401Response.md new file mode 100644 index 00000000..23a92c98 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-activate-workflow-v1401-response-v1 +title: StartActivateWorkflowV1401ResponseV1 +pagination_label: StartActivateWorkflowV1401ResponseV1 +sidebar_label: StartActivateWorkflowV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartActivateWorkflowV1401ResponseV1', 'v1StartActivateWorkflowV1401ResponseV1'] +slug: /tools/sdk/typescript/jit_activations/models/start-activate-workflow-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartActivateWorkflowV1401ResponseV1', 'v1StartActivateWorkflowV1401ResponseV1'] +--- + +# StartActivateWorkflowV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1429Response.md b/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1429Response.md new file mode 100644 index 00000000..99be7465 --- /dev/null +++ b/sdk-output/jit_activations/docs/Models/StartActivateWorkflowV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-activate-workflow-v1429-response-v1 +title: StartActivateWorkflowV1429ResponseV1 +pagination_label: StartActivateWorkflowV1429ResponseV1 +sidebar_label: StartActivateWorkflowV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartActivateWorkflowV1429ResponseV1', 'v1StartActivateWorkflowV1429ResponseV1'] +slug: /tools/sdk/typescript/jit_activations/models/start-activate-workflow-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartActivateWorkflowV1429ResponseV1', 'v1StartActivateWorkflowV1429ResponseV1'] +--- + +# StartActivateWorkflowV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/launchers/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/launchers/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d2169186 --- /dev/null +++ b/sdk-output/launchers/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,93 @@ +- path: /launchers/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#create-launcher-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const launcherrequestV1: LauncherrequestV1 = ; // LauncherrequestV1 | Payload to create a Launcher + const result = await apiInstance.createLauncherV1(launcherrequestV1); + console.log(result); +- path: /launchers/v1/{launcherID} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#delete-launcher-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const launcherID: string = 'e3012408-8b61-4564-ad41-c5ec131c325b'; // string | ID of the Launcher to be deleted (default to undefined) + const result = await apiInstance.deleteLauncherV1(launcherID); + console.log(result); +- path: /launchers/v1/{launcherID} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#get-launcher-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const launcherID: string = 'e3012408-8b61-4564-ad41-c5ec131c325b'; // string | ID of the Launcher to be retrieved (default to undefined) + const result = await apiInstance.getLauncherV1(launcherID); + console.log(result); +- path: /launchers/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#get-launchers-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const filters: string = 'disabled eq "true"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) (default to undefined) + const next: string = 'eyJuZXh0IjoxMjN9Cg=='; // string | Pagination marker (optional) (default to undefined) + const limit: number = 42; // number | Number of Launchers to return (optional) (default to 10) + const result = await apiInstance.getLaunchersV1(); + console.log(result); +- path: /launchers/v1/{launcherID} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#put-launcher-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const launcherID: string = 'e3012408-8b61-4564-ad41-c5ec131c325b'; // string | ID of the Launcher to be replaced (default to undefined) + const launcherrequestV1: LauncherrequestV1 = ; // LauncherrequestV1 | Payload to replace Launcher + const result = await apiInstance.putLauncherV1(launcherID, launcherrequestV1); + console.log(result); +- path: /launchers/v1/{launcherID}/launch + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/launchers/methods/launchers#start-launcher-v1 + source: | + import { LaunchersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LaunchersV1Api(configuration); + const launcherID: string = 'e3012408-8b61-4564-ad41-c5ec131c325b'; // string | ID of the Launcher to be launched (default to undefined) + const result = await apiInstance.startLauncherV1(launcherID); + console.log(result); diff --git a/sdk-output/launchers/docs/Methods/Index.md b/sdk-output/launchers/docs/Methods/Index.md new file mode 100644 index 00000000..c4eedb40 --- /dev/null +++ b/sdk-output/launchers/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: launchers-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: launchers-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'launchers', 'methods'] +slug: /tools/sdk/typescript/launchers/methods +tags: ['SDK', 'Software Development Kit', 'launchers', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/launchers/docs/Methods/LaunchersV1Api.md b/sdk-output/launchers/docs/Methods/LaunchersV1Api.md new file mode 100644 index 00000000..c5be45ff --- /dev/null +++ b/sdk-output/launchers/docs/Methods/LaunchersV1Api.md @@ -0,0 +1,259 @@ +--- +id: v1-launchers +title: Launchers +pagination_label: Launchers +sidebar_label: Launchers +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Launchers', 'v1Launchers'] +slug: /tools/sdk/typescript/launchers/methods/launchers +tags: ['SDK', 'Software Development Kit', 'Launchers', 'v1Launchers'] +--- + +# LaunchersV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-launcher-v1**](#create-launcher-v1) | **POST** `/launchers/v1` | Create launcher +[**delete-launcher-v1**](#delete-launcher-v1) | **DELETE** `/launchers/v1/{launcherID}` | Delete launcher +[**get-launcher-v1**](#get-launcher-v1) | **GET** `/launchers/v1/{launcherID}` | Get launcher by id +[**get-launchers-v1**](#get-launchers-v1) | **GET** `/launchers/v1` | List all launchers for tenant +[**put-launcher-v1**](#put-launcher-v1) | **PUT** `/launchers/v1/{launcherID}` | Replace launcher +[**start-launcher-v1**](#start-launcher-v1) | **POST** `/launchers/v1/{launcherID}/launch` | Launch a launcher + + +## create-launcher-v1 +Create launcher +Create a Launcher with given information + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-launcher-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**launcherrequestV1** | **LauncherrequestV1** | Payload to create a Launcher | + +### Return type + +**LauncherV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const launcherrequestV1: LauncherrequestV1 = ; // Payload to create a Launcher +const result = await apiInstance.createLauncherV1(launcherrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-launcher-v1 +Delete launcher +Delete the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-launcher-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**launcherID** | **string** | ID of the Launcher to be deleted | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const launcherID: string = e3012408-8b61-4564-ad41-c5ec131c325b; // ID of the Launcher to be deleted +const result = await apiInstance.deleteLauncherV1(launcherID); +console.log(result); +``` + +[[Back to top]](#) + +## get-launcher-v1 +Get launcher by id +Get details for the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-launcher-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**launcherID** | **string** | ID of the Launcher to be retrieved | [default to undefined] + +### Return type + +**LauncherV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const launcherID: string = e3012408-8b61-4564-ad41-c5ec131c325b; // ID of the Launcher to be retrieved +const result = await apiInstance.getLauncherV1(launcherID); +console.log(result); +``` + +[[Back to top]](#) + +## get-launchers-v1 +List all launchers for tenant +Return a list of Launchers for the authenticated tenant + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-launchers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* | [optional] [default to undefined] +**next** | **string** | Pagination marker | [optional] [default to undefined] +**limit** | **number** | Number of Launchers to return | [optional] [default to 10] + +### Return type + +**GetLaunchersV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const filters: string = disabled eq "true"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) +const next: string = eyJuZXh0IjoxMjN9Cg==; // Pagination marker (optional) +const limit: number = 42; // Number of Launchers to return (optional) +const result = await apiInstance.getLaunchersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-launcher-v1 +Replace launcher +Replace the given Launcher ID with given payload + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-launcher-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**launcherID** | **string** | ID of the Launcher to be replaced | [default to undefined] +**launcherrequestV1** | **LauncherrequestV1** | Payload to replace Launcher | + +### Return type + +**LauncherV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const launcherID: string = e3012408-8b61-4564-ad41-c5ec131c325b; // ID of the Launcher to be replaced +const launcherrequestV1: LauncherrequestV1 = ; // Payload to replace Launcher +const result = await apiInstance.putLauncherV1(launcherID, launcherrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-launcher-v1 +Launch a launcher +Launch the given Launcher ID + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-launcher-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**launcherID** | **string** | ID of the Launcher to be launched | [default to undefined] + +### Return type + +**StartLauncherV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LaunchersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LaunchersV1Api(configuration); +const launcherID: string = e3012408-8b61-4564-ad41-c5ec131c325b; // ID of the Launcher to be launched +const result = await apiInstance.startLauncherV1(launcherID); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/launchers/docs/Models/Errormessagedto.md b/sdk-output/launchers/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..4662364d --- /dev/null +++ b/sdk-output/launchers/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/launchers/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/Errorresponsedto.md b/sdk-output/launchers/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..05169dfc --- /dev/null +++ b/sdk-output/launchers/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/launchers/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/GetLaunchersV1200Response.md b/sdk-output/launchers/docs/Models/GetLaunchersV1200Response.md new file mode 100644 index 00000000..cf6789ea --- /dev/null +++ b/sdk-output/launchers/docs/Models/GetLaunchersV1200Response.md @@ -0,0 +1,20 @@ +--- +id: v1-get-launchers-v1200-response-v1 +title: GetLaunchersV1200ResponseV1 +pagination_label: GetLaunchersV1200ResponseV1 +sidebar_label: GetLaunchersV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetLaunchersV1200ResponseV1', 'v1GetLaunchersV1200ResponseV1'] +slug: /tools/sdk/typescript/launchers/models/get-launchers-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetLaunchersV1200ResponseV1', 'v1GetLaunchersV1200ResponseV1'] +--- + +# GetLaunchersV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next** | **(optional)** **string** | Pagination marker | [default to undefined] +**items** | **(optional)** **Array<LauncherV1>** | | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/GetLaunchersV1401Response.md b/sdk-output/launchers/docs/Models/GetLaunchersV1401Response.md new file mode 100644 index 00000000..b7f72ef1 --- /dev/null +++ b/sdk-output/launchers/docs/Models/GetLaunchersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-launchers-v1401-response-v1 +title: GetLaunchersV1401ResponseV1 +pagination_label: GetLaunchersV1401ResponseV1 +sidebar_label: GetLaunchersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetLaunchersV1401ResponseV1', 'v1GetLaunchersV1401ResponseV1'] +slug: /tools/sdk/typescript/launchers/models/get-launchers-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetLaunchersV1401ResponseV1', 'v1GetLaunchersV1401ResponseV1'] +--- + +# GetLaunchersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/GetLaunchersV1429Response.md b/sdk-output/launchers/docs/Models/GetLaunchersV1429Response.md new file mode 100644 index 00000000..e9ccbb29 --- /dev/null +++ b/sdk-output/launchers/docs/Models/GetLaunchersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-launchers-v1429-response-v1 +title: GetLaunchersV1429ResponseV1 +pagination_label: GetLaunchersV1429ResponseV1 +sidebar_label: GetLaunchersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetLaunchersV1429ResponseV1', 'v1GetLaunchersV1429ResponseV1'] +slug: /tools/sdk/typescript/launchers/models/get-launchers-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetLaunchersV1429ResponseV1', 'v1GetLaunchersV1429ResponseV1'] +--- + +# GetLaunchersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/Index.md b/sdk-output/launchers/docs/Models/Index.md new file mode 100644 index 00000000..c231f817 --- /dev/null +++ b/sdk-output/launchers/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: launchers-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: launchers-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'launchers', 'models'] +slug: /tools/sdk/typescript/launchers/models +tags: ['SDK', 'Software Development Kit', 'launchers', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/launchers/docs/Models/Launcher.md b/sdk-output/launchers/docs/Models/Launcher.md new file mode 100644 index 00000000..e6372f62 --- /dev/null +++ b/sdk-output/launchers/docs/Models/Launcher.md @@ -0,0 +1,28 @@ +--- +id: v1-launcher-v1 +title: LauncherV1 +pagination_label: LauncherV1 +sidebar_label: LauncherV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LauncherV1', 'v1LauncherV1'] +slug: /tools/sdk/typescript/launchers/models/launcher-v1 +tags: ['SDK', 'Software Development Kit', 'LauncherV1', 'v1LauncherV1'] +--- + +# LauncherV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the Launcher | [default to undefined] +**created** | **string** | Date the Launcher was created | [default to undefined] +**modified** | **string** | Date the Launcher was last modified | [default to undefined] +**owner** | **LauncherOwnerV1** | | [default to undefined] +**name** | **string** | Name of the Launcher, limited to 255 characters | [default to undefined] +**description** | **string** | Description of the Launcher, limited to 2000 characters | [default to undefined] +**type** | **string** | Launcher type | [default to undefined] +**disabled** | **boolean** | State of the Launcher | [default to undefined] +**reference** | **(optional)** **LauncherReferenceV1** | | [default to undefined] +**config** | **string** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/LauncherOwner.md b/sdk-output/launchers/docs/Models/LauncherOwner.md new file mode 100644 index 00000000..68d7768a --- /dev/null +++ b/sdk-output/launchers/docs/Models/LauncherOwner.md @@ -0,0 +1,20 @@ +--- +id: v1-launcher-owner-v1 +title: LauncherOwnerV1 +pagination_label: LauncherOwnerV1 +sidebar_label: LauncherOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LauncherOwnerV1', 'v1LauncherOwnerV1'] +slug: /tools/sdk/typescript/launchers/models/launcher-owner-v1 +tags: ['SDK', 'Software Development Kit', 'LauncherOwnerV1', 'v1LauncherOwnerV1'] +--- + +# LauncherOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Owner type | [default to undefined] +**id** | **string** | Owner ID | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/LauncherReference.md b/sdk-output/launchers/docs/Models/LauncherReference.md new file mode 100644 index 00000000..3a39a482 --- /dev/null +++ b/sdk-output/launchers/docs/Models/LauncherReference.md @@ -0,0 +1,20 @@ +--- +id: v1-launcher-reference-v1 +title: LauncherReferenceV1 +pagination_label: LauncherReferenceV1 +sidebar_label: LauncherReferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LauncherReferenceV1', 'v1LauncherReferenceV1'] +slug: /tools/sdk/typescript/launchers/models/launcher-reference-v1 +tags: ['SDK', 'Software Development Kit', 'LauncherReferenceV1', 'v1LauncherReferenceV1'] +--- + +# LauncherReferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of Launcher reference | [default to undefined] +**id** | **(optional)** **string** | ID of Launcher reference | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/Launcherrequest.md b/sdk-output/launchers/docs/Models/Launcherrequest.md new file mode 100644 index 00000000..182e178e --- /dev/null +++ b/sdk-output/launchers/docs/Models/Launcherrequest.md @@ -0,0 +1,24 @@ +--- +id: v1-launcherrequest-v1 +title: LauncherrequestV1 +pagination_label: LauncherrequestV1 +sidebar_label: LauncherrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LauncherrequestV1', 'v1LauncherrequestV1'] +slug: /tools/sdk/typescript/launchers/models/launcherrequest-v1 +tags: ['SDK', 'Software Development Kit', 'LauncherrequestV1', 'v1LauncherrequestV1'] +--- + +# LauncherrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of the Launcher, limited to 255 characters | [default to undefined] +**description** | **string** | Description of the Launcher, limited to 2000 characters | [default to undefined] +**type** | **string** | Launcher type | [default to undefined] +**disabled** | **boolean** | State of the Launcher | [default to undefined] +**reference** | **(optional)** **LauncherrequestReferenceV1** | | [default to undefined] +**config** | **string** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/LauncherrequestReference.md b/sdk-output/launchers/docs/Models/LauncherrequestReference.md new file mode 100644 index 00000000..a95e855b --- /dev/null +++ b/sdk-output/launchers/docs/Models/LauncherrequestReference.md @@ -0,0 +1,20 @@ +--- +id: v1-launcherrequest-reference-v1 +title: LauncherrequestReferenceV1 +pagination_label: LauncherrequestReferenceV1 +sidebar_label: LauncherrequestReferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LauncherrequestReferenceV1', 'v1LauncherrequestReferenceV1'] +slug: /tools/sdk/typescript/launchers/models/launcherrequest-reference-v1 +tags: ['SDK', 'Software Development Kit', 'LauncherrequestReferenceV1', 'v1LauncherrequestReferenceV1'] +--- + +# LauncherrequestReferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of Launcher reference | [default to undefined] +**id** | **string** | ID of Launcher reference | [default to undefined] + diff --git a/sdk-output/launchers/docs/Models/Localeorigin.md b/sdk-output/launchers/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e7048c73 --- /dev/null +++ b/sdk-output/launchers/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/launchers/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/launchers/docs/Models/README.md b/sdk-output/launchers/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/launchers/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/launchers/docs/Models/StartLauncherV1200Response.md b/sdk-output/launchers/docs/Models/StartLauncherV1200Response.md new file mode 100644 index 00000000..66a43407 --- /dev/null +++ b/sdk-output/launchers/docs/Models/StartLauncherV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-launcher-v1200-response-v1 +title: StartLauncherV1200ResponseV1 +pagination_label: StartLauncherV1200ResponseV1 +sidebar_label: StartLauncherV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartLauncherV1200ResponseV1', 'v1StartLauncherV1200ResponseV1'] +slug: /tools/sdk/typescript/launchers/models/start-launcher-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartLauncherV1200ResponseV1', 'v1StartLauncherV1200ResponseV1'] +--- + +# StartLauncherV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**interactiveProcessId** | **string** | ID of the Interactive Process that was launched | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/lifecycle_states/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..1529df2f --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,100 @@ +- path: /identity-profiles/v1/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#create-lifecycle-state-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const lifecyclestateV1: LifecyclestateV1 = ; // LifecyclestateV1 | Lifecycle state to be created. + const result = await apiInstance.createLifecycleStateV1(identityProfileId, lifecyclestateV1); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#delete-lifecycle-state-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const lifecycleStateId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Lifecycle state ID. (default to undefined) + const result = await apiInstance.deleteLifecycleStateV1(identityProfileId, lifecycleStateId); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#get-lifecycle-state-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const lifecycleStateId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Lifecycle state ID. (default to undefined) + const result = await apiInstance.getLifecycleStateV1(identityProfileId, lifecycleStateId); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#get-lifecycle-states-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'created,modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) (default to undefined) + const result = await apiInstance.getLifecycleStatesV1(identityProfileId); + console.log(result); +- path: /identities/v1/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#set-lifecycle-state-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityId: string = '2c9180857893f1290178944561990364'; // string | ID of the identity to update. (default to undefined) + const setLifecycleStateV1RequestV1: SetLifecycleStateV1RequestV1 = ; // SetLifecycleStateV1RequestV1 | + const result = await apiInstance.setLifecycleStateV1(identityId, setLifecycleStateV1RequestV1); + console.log(result); +- path: /identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/lifecycle_states/methods/lifecycle-states#update-lifecycle-states-v1 + source: | + import { LifecycleStatesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new LifecycleStatesV1Api(configuration); + const identityProfileId: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | Identity profile ID. (default to undefined) + const lifecycleStateId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Lifecycle state ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/accessProfileIds","value":["2c918087742bab150174407a80f3125e","2c918087742bab150174407a80f3124f"]},{"op":"replace","path":"/accountActions","value":[{"action":"ENABLE","sourceIds":["2c9180846a2f82fb016a481c1b1560c5","2c9180846a2f82fb016a481c1b1560cc"],"excludeSourceIds":null,"allSources":false},{"action":"DISABLE","sourceIds":null,"excludeSourceIds":["3b551ccf5566478b9b77f37de25303aa"],"allSources":true},{"action":"DELETE","sourceIds":["3c9180846a2f82fb016a481c1b1560c5","8n9180846a2f82fb016a481c1b1560cc"],"excludeSourceIds":null,"allSources":false}]},{"op":"replace","path":"/emailNotificationOption","value":{"notifyManagers":true,"notifyAllAdmins":false,"notifySpecificUsers":false,"emailAddressList":[]}},{"op":"replace","path":"/accessActionConfiguration","value":{"removeAllAccessEnabled":true}}]; // Array | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority + const result = await apiInstance.updateLifecycleStatesV1(identityProfileId, lifecycleStateId, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/lifecycle_states/docs/Methods/Index.md b/sdk-output/lifecycle_states/docs/Methods/Index.md new file mode 100644 index 00000000..06b1384e --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: lifecycle_states-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: lifecycle_states-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'lifecycle_states', 'methods'] +slug: /tools/sdk/typescript/lifecycle_states/methods +tags: ['SDK', 'Software Development Kit', 'lifecycle_states', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/lifecycle_states/docs/Methods/LifecycleStatesV1Api.md b/sdk-output/lifecycle_states/docs/Methods/LifecycleStatesV1Api.md new file mode 100644 index 00000000..158830e5 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Methods/LifecycleStatesV1Api.md @@ -0,0 +1,311 @@ +--- +id: v1-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LifecycleStates', 'v1LifecycleStates'] +slug: /tools/sdk/typescript/lifecycle_states/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'v1LifecycleStates'] +--- + +# LifecycleStatesV1Api + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-lifecycle-state-v1**](#create-lifecycle-state-v1) | **POST** `/identity-profiles/v1/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**delete-lifecycle-state-v1**](#delete-lifecycle-state-v1) | **DELETE** `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**get-lifecycle-state-v1**](#get-lifecycle-state-v1) | **GET** `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**get-lifecycle-states-v1**](#get-lifecycle-states-v1) | **GET** `/identity-profiles/v1/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**set-lifecycle-state-v1**](#set-lifecycle-state-v1) | **POST** `/identities/v1/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**update-lifecycle-states-v1**](#update-lifecycle-states-v1) | **PATCH** `/identity-profiles/v1/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state + + +## create-lifecycle-state-v1 +Create lifecycle state +Use this endpoint to create a lifecycle state. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-lifecycle-state-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**lifecyclestateV1** | **LifecyclestateV1** | Lifecycle state to be created. | + +### Return type + +**LifecyclestateV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const lifecyclestateV1: LifecyclestateV1 = ; // Lifecycle state to be created. +const result = await apiInstance.createLifecycleStateV1(identityProfileId, lifecyclestateV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-lifecycle-state-v1 +Delete lifecycle state +Use this endpoint to delete the lifecycle state by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-lifecycle-state-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**lifecycleStateId** | **string** | Lifecycle state ID. | [default to undefined] + +### Return type + +**LifecyclestatedeletedV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const lifecycleStateId: string = ef38f94347e94562b5bb8424a56397d8; // Lifecycle state ID. +const result = await apiInstance.deleteLifecycleStateV1(identityProfileId, lifecycleStateId); +console.log(result); +``` + +[[Back to top]](#) + +## get-lifecycle-state-v1 +Get lifecycle state +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-lifecycle-state-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**lifecycleStateId** | **string** | Lifecycle state ID. | [default to undefined] + +### Return type + +**LifecyclestateV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const lifecycleStateId: string = ef38f94347e94562b5bb8424a56397d8; // Lifecycle state ID. +const result = await apiInstance.getLifecycleStateV1(identityProfileId, lifecycleStateId); +console.log(result); +``` + +[[Back to top]](#) + +## get-lifecycle-states-v1 +Lists lifecyclestates +Use this endpoint to list all lifecycle states by their associated identity profiles. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-lifecycle-states-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = created,modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, priority, created, modified** (optional) +const result = await apiInstance.getLifecycleStatesV1(identityProfileId); +console.log(result); +``` + +[[Back to top]](#) + +## set-lifecycle-state-v1 +Set lifecycle state +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-lifecycle-state-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | ID of the identity to update. | [default to undefined] +**setLifecycleStateV1RequestV1** | **SetLifecycleStateV1RequestV1** | | + +### Return type + +**SetLifecycleStateV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityId: string = 2c9180857893f1290178944561990364; // ID of the identity to update. +const setLifecycleStateV1RequestV1: SetLifecycleStateV1RequestV1 = ; // +const result = await apiInstance.setLifecycleStateV1(identityId, setLifecycleStateV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-lifecycle-states-v1 +Update lifecycle state +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-lifecycle-states-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityProfileId** | **string** | Identity profile ID. | [default to undefined] +**lifecycleStateId** | **string** | Lifecycle state ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority | + +### Return type + +**LifecyclestateV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { LifecycleStatesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new LifecycleStatesV1Api(configuration); +const identityProfileId: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // Identity profile ID. +const lifecycleStateId: string = ef38f94347e94562b5bb8424a56397d8; // Lifecycle state ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Updated description!"},{"op":"replace","path":"/accessProfileIds","value":["2c918087742bab150174407a80f3125e","2c918087742bab150174407a80f3124f"]},{"op":"replace","path":"/accountActions","value":[{"action":"ENABLE","sourceIds":["2c9180846a2f82fb016a481c1b1560c5","2c9180846a2f82fb016a481c1b1560cc"],"excludeSourceIds":null,"allSources":false},{"action":"DISABLE","sourceIds":null,"excludeSourceIds":["3b551ccf5566478b9b77f37de25303aa"],"allSources":true},{"action":"DELETE","sourceIds":["3c9180846a2f82fb016a481c1b1560c5","8n9180846a2f82fb016a481c1b1560cc"],"excludeSourceIds":null,"allSources":false}]},{"op":"replace","path":"/emailNotificationOption","value":{"notifyManagers":true,"notifyAllAdmins":false,"notifySpecificUsers":false,"emailAddressList":[]}},{"op":"replace","path":"/accessActionConfiguration","value":{"removeAllAccessEnabled":true}}]; // A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority +const result = await apiInstance.updateLifecycleStatesV1(identityProfileId, lifecycleStateId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/lifecycle_states/docs/Models/Accessactionconfiguration.md b/sdk-output/lifecycle_states/docs/Models/Accessactionconfiguration.md new file mode 100644 index 00000000..c9b0a3a2 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Accessactionconfiguration.md @@ -0,0 +1,19 @@ +--- +id: v1-accessactionconfiguration-v1 +title: AccessactionconfigurationV1 +pagination_label: AccessactionconfigurationV1 +sidebar_label: AccessactionconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessactionconfigurationV1', 'v1AccessactionconfigurationV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/accessactionconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'AccessactionconfigurationV1', 'v1AccessactionconfigurationV1'] +--- + +# AccessactionconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**removeAllAccessEnabled** | **(optional)** **boolean** | If true, then all accesses are marked for removal. | [default to false] + diff --git a/sdk-output/lifecycle_states/docs/Models/Accountaction.md b/sdk-output/lifecycle_states/docs/Models/Accountaction.md new file mode 100644 index 00000000..66460bf1 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Accountaction.md @@ -0,0 +1,22 @@ +--- +id: v1-accountaction-v1 +title: AccountactionV1 +pagination_label: AccountactionV1 +sidebar_label: AccountactionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountactionV1', 'v1AccountactionV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/accountaction-v1 +tags: ['SDK', 'Software Development Kit', 'AccountactionV1', 'v1AccountactionV1'] +--- + +# AccountactionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **(optional)** **string** | Describes if action will be enable, disable or delete. | [default to undefined] +**sourceIds** | **(optional)** **Array<string>** | A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. | [default to undefined] +**excludeSourceIds** | **(optional)** **Array<string>** | A list of source IDs to exclude from the action. Cannot be used together with sourceIds. | [default to undefined] +**allSources** | **(optional)** **boolean** | If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. | [default to false] + diff --git a/sdk-output/lifecycle_states/docs/Models/ArrayInner.md b/sdk-output/lifecycle_states/docs/Models/ArrayInner.md new file mode 100644 index 00000000..28e1f358 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/lifecycle_states/docs/Models/Basecommondto.md b/sdk-output/lifecycle_states/docs/Models/Basecommondto.md new file mode 100644 index 00000000..588fea34 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Emailnotificationoption.md b/sdk-output/lifecycle_states/docs/Models/Emailnotificationoption.md new file mode 100644 index 00000000..97579f92 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Emailnotificationoption.md @@ -0,0 +1,22 @@ +--- +id: v1-emailnotificationoption-v1 +title: EmailnotificationoptionV1 +pagination_label: EmailnotificationoptionV1 +sidebar_label: EmailnotificationoptionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EmailnotificationoptionV1', 'v1EmailnotificationoptionV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/emailnotificationoption-v1 +tags: ['SDK', 'Software Development Kit', 'EmailnotificationoptionV1', 'v1EmailnotificationoptionV1'] +--- + +# EmailnotificationoptionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**notifyManagers** | **(optional)** **boolean** | If true, then the manager is notified of the lifecycle state change. | [default to false] +**notifyAllAdmins** | **(optional)** **boolean** | If true, then all the admins are notified of the lifecycle state change. | [default to false] +**notifySpecificUsers** | **(optional)** **boolean** | If true, then the users specified in \"emailAddressList\" below are notified of lifecycle state change. | [default to false] +**emailAddressList** | **(optional)** **Array<string>** | List of user email addresses. If \"notifySpecificUsers\" option is true, then these users are notified of lifecycle state change. | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Errormessagedto.md b/sdk-output/lifecycle_states/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..857e3412 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Errorresponsedto.md b/sdk-output/lifecycle_states/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f23facc2 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Index.md b/sdk-output/lifecycle_states/docs/Models/Index.md new file mode 100644 index 00000000..05b34b02 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: lifecycle_states-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: lifecycle_states-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'lifecycle_states', 'models'] +slug: /tools/sdk/typescript/lifecycle_states/models +tags: ['SDK', 'Software Development Kit', 'lifecycle_states', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/lifecycle_states/docs/Models/Jsonpatchoperation.md b/sdk-output/lifecycle_states/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..91b4d034 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/JsonpatchoperationValue.md b/sdk-output/lifecycle_states/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..db5275f4 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/lifecycle_states/docs/Models/Lifecyclestate.md b/sdk-output/lifecycle_states/docs/Models/Lifecyclestate.md new file mode 100644 index 00000000..56104807 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Lifecyclestate.md @@ -0,0 +1,32 @@ +--- +id: v1-lifecyclestate-v1 +title: LifecyclestateV1 +pagination_label: LifecyclestateV1 +sidebar_label: LifecyclestateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LifecyclestateV1', 'v1LifecyclestateV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/lifecyclestate-v1 +tags: ['SDK', 'Software Development Kit', 'LifecyclestateV1', 'v1LifecyclestateV1'] +--- + +# LifecyclestateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates whether the lifecycle state is enabled or disabled. | [default to false] +**technicalName** | **string** | The lifecycle state\'s technical name. This is for internal use. | [default to undefined] +**description** | **(optional)** **string** | Lifecycle state\'s description. | [default to undefined] +**identityCount** | **(optional)** **number** | Number of identities that have the lifecycle state. | [readonly] [default to undefined] +**emailNotificationOption** | **(optional)** **EmailnotificationoptionV1** | | [default to undefined] +**accountActions** | **(optional)** **Array<AccountactionV1>** | | [default to undefined] +**accessProfileIds** | **(optional)** **Array<string>** | List of unique access-profile IDs that are associated with the lifecycle state. | [default to undefined] +**identityState** | **(optional)** **string** | The lifecycle state\'s associated identity state. This field is generally \'null\'. | [default to undefined] +**accessActionConfiguration** | **(optional)** **AccessactionconfigurationV1** | | [default to undefined] +**priority** | **(optional)** **number** | Used to control the order of lifecycle states when listing with `?sorters=priority`. Lower numbers appear first (ascending order). Out-of-the-box lifecycle states are assigned priorities in increments of 10. | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Lifecyclestatedeleted.md b/sdk-output/lifecycle_states/docs/Models/Lifecyclestatedeleted.md new file mode 100644 index 00000000..cb065608 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Lifecyclestatedeleted.md @@ -0,0 +1,21 @@ +--- +id: v1-lifecyclestatedeleted-v1 +title: LifecyclestatedeletedV1 +pagination_label: LifecyclestatedeletedV1 +sidebar_label: LifecyclestatedeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LifecyclestatedeletedV1', 'v1LifecyclestatedeletedV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/lifecyclestatedeleted-v1 +tags: ['SDK', 'Software Development Kit', 'LifecyclestatedeletedV1', 'v1LifecyclestatedeletedV1'] +--- + +# LifecyclestatedeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Deleted lifecycle state\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Deleted lifecycle state ID. | [default to undefined] +**name** | **(optional)** **string** | Deleted lifecycle state\'s display name. | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/Localeorigin.md b/sdk-output/lifecycle_states/docs/Models/Localeorigin.md new file mode 100644 index 00000000..941e216f --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/lifecycle_states/docs/Models/README.md b/sdk-output/lifecycle_states/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md new file mode 100644 index 00000000..f33f1442 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-lifecycle-state-v1200-response-v1 +title: SetLifecycleStateV1200ResponseV1 +pagination_label: SetLifecycleStateV1200ResponseV1 +sidebar_label: SetLifecycleStateV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetLifecycleStateV1200ResponseV1', 'v1SetLifecycleStateV1200ResponseV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/set-lifecycle-state-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateV1200ResponseV1', 'v1SetLifecycleStateV1200ResponseV1'] +--- + +# SetLifecycleStateV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountActivityId** | **(optional)** **string** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1401Response.md b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1401Response.md new file mode 100644 index 00000000..23ac9ab5 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-lifecycle-state-v1401-response-v1 +title: SetLifecycleStateV1401ResponseV1 +pagination_label: SetLifecycleStateV1401ResponseV1 +sidebar_label: SetLifecycleStateV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetLifecycleStateV1401ResponseV1', 'v1SetLifecycleStateV1401ResponseV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/set-lifecycle-state-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateV1401ResponseV1', 'v1SetLifecycleStateV1401ResponseV1'] +--- + +# SetLifecycleStateV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1429Response.md b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1429Response.md new file mode 100644 index 00000000..156c1697 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-set-lifecycle-state-v1429-response-v1 +title: SetLifecycleStateV1429ResponseV1 +pagination_label: SetLifecycleStateV1429ResponseV1 +sidebar_label: SetLifecycleStateV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetLifecycleStateV1429ResponseV1', 'v1SetLifecycleStateV1429ResponseV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/set-lifecycle-state-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateV1429ResponseV1', 'v1SetLifecycleStateV1429ResponseV1'] +--- + +# SetLifecycleStateV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1Request.md b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1Request.md new file mode 100644 index 00000000..217cb2a5 --- /dev/null +++ b/sdk-output/lifecycle_states/docs/Models/SetLifecycleStateV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-set-lifecycle-state-v1-request-v1 +title: SetLifecycleStateV1RequestV1 +pagination_label: SetLifecycleStateV1RequestV1 +sidebar_label: SetLifecycleStateV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SetLifecycleStateV1RequestV1', 'v1SetLifecycleStateV1RequestV1'] +slug: /tools/sdk/typescript/lifecycle_states/models/set-lifecycle-state-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateV1RequestV1', 'v1SetLifecycleStateV1RequestV1'] +--- + +# SetLifecycleStateV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lifecycleStateId** | **(optional)** **string** | ID of the lifecycle state to set. | [default to undefined] + diff --git a/sdk-output/machine_account_classify/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_account_classify/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a4288c41 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,16 @@ +- path: /accounts/v1/{id}/classify + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_classify/methods/machine-account-classify#send-classify-machine-account-v1 + source: | + import { MachineAccountClassifyV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountClassifyV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Account ID. (default to undefined) + const classificationMode: string = 'forceMachine'; // 'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman' | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to 'default') + const result = await apiInstance.sendClassifyMachineAccountV1(id); + console.log(result); diff --git a/sdk-output/machine_account_classify/docs/Methods/Index.md b/sdk-output/machine_account_classify/docs/Methods/Index.md new file mode 100644 index 00000000..a8475084 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_account_classify-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_account_classify-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_classify', 'methods'] +slug: /tools/sdk/typescript/machine_account_classify/methods +tags: ['SDK', 'Software Development Kit', 'machine_account_classify', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_account_classify/docs/Methods/MachineAccountClassifyV1Api.md b/sdk-output/machine_account_classify/docs/Methods/MachineAccountClassifyV1Api.md new file mode 100644 index 00000000..04cfab2a --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Methods/MachineAccountClassifyV1Api.md @@ -0,0 +1,61 @@ +--- +id: v1-machine-account-classify +title: MachineAccountClassify +pagination_label: MachineAccountClassify +sidebar_label: MachineAccountClassify +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineAccountClassify', 'v1MachineAccountClassify'] +slug: /tools/sdk/typescript/machine_account_classify/methods/machine-account-classify +tags: ['SDK', 'Software Development Kit', 'MachineAccountClassify', 'v1MachineAccountClassify'] +--- + +# MachineAccountClassifyV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**send-classify-machine-account-v1**](#send-classify-machine-account-v1) | **POST** `/accounts/v1/{id}/classify` | Classify single machine account + + +## send-classify-machine-account-v1 +Classify single machine account +Use this API to classify a single machine account. +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-classify-machine-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Account ID. | [default to undefined] +**classificationMode** | **'default' | 'ignoreManual' | 'forceMachine' | 'forceHuman'** | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. | [optional] [default to 'default'] + +### Return type + +**SendClassifyMachineAccountV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountClassifyV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountClassifyV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Account ID. +const classificationMode: string = forceMachine; // Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) +const result = await apiInstance.sendClassifyMachineAccountV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_account_classify/docs/Models/Errormessagedto.md b/sdk-output/machine_account_classify/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..103760ef --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_account_classify/docs/Models/Errorresponsedto.md b/sdk-output/machine_account_classify/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e4c211be --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_account_classify/docs/Models/Index.md b/sdk-output/machine_account_classify/docs/Models/Index.md new file mode 100644 index 00000000..7f1dae25 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_account_classify-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_account_classify-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_classify', 'models'] +slug: /tools/sdk/typescript/machine_account_classify/models +tags: ['SDK', 'Software Development Kit', 'machine_account_classify', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_account_classify/docs/Models/Localeorigin.md b/sdk-output/machine_account_classify/docs/Models/Localeorigin.md new file mode 100644 index 00000000..6aa19574 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_account_classify/docs/Models/README.md b/sdk-output/machine_account_classify/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1200Response.md b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1200Response.md new file mode 100644 index 00000000..33e90bd3 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-classify-machine-account-v1200-response-v1 +title: SendClassifyMachineAccountV1200ResponseV1 +pagination_label: SendClassifyMachineAccountV1200ResponseV1 +sidebar_label: SendClassifyMachineAccountV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendClassifyMachineAccountV1200ResponseV1', 'v1SendClassifyMachineAccountV1200ResponseV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/send-classify-machine-account-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccountV1200ResponseV1', 'v1SendClassifyMachineAccountV1200ResponseV1'] +--- + +# SendClassifyMachineAccountV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isMachine** | **(optional)** **boolean** | Indicates if account is classified as machine | [default to false] + diff --git a/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1401Response.md b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1401Response.md new file mode 100644 index 00000000..9344dda7 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-classify-machine-account-v1401-response-v1 +title: SendClassifyMachineAccountV1401ResponseV1 +pagination_label: SendClassifyMachineAccountV1401ResponseV1 +sidebar_label: SendClassifyMachineAccountV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendClassifyMachineAccountV1401ResponseV1', 'v1SendClassifyMachineAccountV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/send-classify-machine-account-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccountV1401ResponseV1', 'v1SendClassifyMachineAccountV1401ResponseV1'] +--- + +# SendClassifyMachineAccountV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1429Response.md b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1429Response.md new file mode 100644 index 00000000..76901602 --- /dev/null +++ b/sdk-output/machine_account_classify/docs/Models/SendClassifyMachineAccountV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-send-classify-machine-account-v1429-response-v1 +title: SendClassifyMachineAccountV1429ResponseV1 +pagination_label: SendClassifyMachineAccountV1429ResponseV1 +sidebar_label: SendClassifyMachineAccountV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendClassifyMachineAccountV1429ResponseV1', 'v1SendClassifyMachineAccountV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_account_classify/models/send-classify-machine-account-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'SendClassifyMachineAccountV1429ResponseV1', 'v1SendClassifyMachineAccountV1429ResponseV1'] +--- + +# SendClassifyMachineAccountV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_account_creation_request/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..9fbcca25 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,49 @@ +- path: /account-requests/v1/machine-account-create + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_creation_request/methods/machine-account-creation-request#create-machine-account-request-v1 + source: | + import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountCreationRequestV1Api(configuration); + const machineaccountcreaterequestinputV1: MachineaccountcreaterequestinputV1 = ; // MachineaccountcreaterequestinputV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createMachineAccountRequestV1(machineaccountcreaterequestinputV1); + console.log(result); +- path: /account-requests/v1/machine-account-create/{accountRequestId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_creation_request/methods/machine-account-creation-request#get-create-machine-account-request-v1 + source: | + import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountCreationRequestV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const accountRequestId: string = 'gt38f94347e94562b5bb8424a56498d8'; // string | Account Request ID (default to undefined) + const result = await apiInstance.getCreateMachineAccountRequestV1(xSailPointExperimental, accountRequestId); + console.log(result); +- path: /source-subtypes/v1/machine-account-create-access + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_creation_request/methods/machine-account-creation-request#get-machine-account-create-access-info-v1 + source: | + import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountCreationRequestV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const offset: number = 0; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const result = await apiInstance.getMachineAccountCreateAccessInfoV1(xSailPointExperimental); + console.log(result); diff --git a/sdk-output/machine_account_creation_request/docs/Methods/Index.md b/sdk-output/machine_account_creation_request/docs/Methods/Index.md new file mode 100644 index 00000000..cde4f9bd --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_account_creation_request-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_account_creation_request-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_creation_request', 'methods'] +slug: /tools/sdk/typescript/machine_account_creation_request/methods +tags: ['SDK', 'Software Development Kit', 'machine_account_creation_request', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestV1Api.md b/sdk-output/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestV1Api.md new file mode 100644 index 00000000..05fe7863 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestV1Api.md @@ -0,0 +1,160 @@ +--- +id: v1-machine-account-creation-request +title: MachineAccountCreationRequest +pagination_label: MachineAccountCreationRequest +sidebar_label: MachineAccountCreationRequest +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineAccountCreationRequest', 'v1MachineAccountCreationRequest'] +slug: /tools/sdk/typescript/machine_account_creation_request/methods/machine-account-creation-request +tags: ['SDK', 'Software Development Kit', 'MachineAccountCreationRequest', 'v1MachineAccountCreationRequest'] +--- + +# MachineAccountCreationRequestV1Api + Use this API to submit and retrieve machine account creation requests. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-account-request-v1**](#create-machine-account-request-v1) | **POST** `/account-requests/v1/machine-account-create` | Submit Machine Account Creation Request +[**get-create-machine-account-request-v1**](#get-create-machine-account-request-v1) | **GET** `/account-requests/v1/machine-account-create/{accountRequestId}` | Get Machine Account Creation Request +[**get-machine-account-create-access-info-v1**](#get-machine-account-create-access-info-v1) | **GET** `/source-subtypes/v1/machine-account-create-access` | Machine Account Create Access + + +## create-machine-account-request-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Submit Machine Account Creation Request +Initiates machine account creation request for the specified subtype. +This method validates the input data, processes the machine account creation request, +and generates an asynchronous result containing a tracking ID. + +>**NOTE: You can only request a machine accounts on subtype for which you have a create machine account entitlement provisioned.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-machine-account-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**machineaccountcreaterequestinputV1** | **MachineaccountcreaterequestinputV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AccountrequestasyncresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountCreationRequestV1Api(configuration); +const machineaccountcreaterequestinputV1: MachineaccountcreaterequestinputV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createMachineAccountRequestV1(machineaccountcreaterequestinputV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-create-machine-account-request-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get Machine Account Creation Request +Retrieves a account request details for machine account creation. This allows the user to view all details for given account request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-create-machine-account-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**accountRequestId** | **string** | Account Request ID | [default to undefined] + +### Return type + +**AccountrequestdetailsdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountCreationRequestV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const accountRequestId: string = gt38f94347e94562b5bb8424a56498d8; // Account Request ID +const result = await apiInstance.getCreateMachineAccountRequestV1(xSailPointExperimental, accountRequestId); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-create-access-info-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Machine Account Create Access +This endpoint retrieves the list of sources and subtypes for which logged in user has the entitlement to create a machine account. +The response includes a list of object detailing the source, subtype and entitlement details which enables the clients to understand if they can submit the request to create a machine account for the given subtype. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-create-access-info-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountCreationRequestV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountCreationRequestV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const result = await apiInstance.getMachineAccountCreateAccessInfoV1(xSailPointExperimental); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Accountrequestasyncresult.md b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestasyncresult.md new file mode 100644 index 00000000..521fe4c0 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestasyncresult.md @@ -0,0 +1,19 @@ +--- +id: v1-accountrequestasyncresult-v1 +title: AccountrequestasyncresultV1 +pagination_label: AccountrequestasyncresultV1 +sidebar_label: AccountrequestasyncresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestasyncresultV1', 'v1AccountrequestasyncresultV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/accountrequestasyncresult-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestasyncresultV1', 'v1AccountrequestasyncresultV1'] +--- + +# AccountrequestasyncresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountRequestId** | **string** | Id of the account request | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Accountrequestdetailsdto.md b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestdetailsdto.md new file mode 100644 index 00000000..c8e9fb3d --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestdetailsdto.md @@ -0,0 +1,26 @@ +--- +id: v1-accountrequestdetailsdto-v1 +title: AccountrequestdetailsdtoV1 +pagination_label: AccountrequestdetailsdtoV1 +sidebar_label: AccountrequestdetailsdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestdetailsdtoV1', 'v1AccountrequestdetailsdtoV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/accountrequestdetailsdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestdetailsdtoV1', 'v1AccountrequestdetailsdtoV1'] +--- + +# AccountrequestdetailsdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountRequestId** | **(optional)** **string** | Account request ID. | [default to undefined] +**requestType** | **(optional)** **string** | Type of the account request. | [default to undefined] +**createdAt** | **(optional)** **string** | Machine account creation request creation date and time. | [readonly] [default to undefined] +**completedAt** | **(optional)** **string** | Machine account creation request completion date and time. | [readonly] [default to undefined] +**overallStatus** | **(optional)** **string** | Overall status of the creation request. | [default to undefined] +**requester** | **(optional)** **AccountrequestdetailsdtoRequesterV1** | | [default to undefined] +**accountRequestPhases** | **(optional)** **Array<AccountrequestphaseV1>** | List of account request phases. | [default to undefined] +**errorDetails** | **(optional)** **string** | Detailed error information. | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/AccountrequestdetailsdtoRequester.md b/sdk-output/machine_account_creation_request/docs/Models/AccountrequestdetailsdtoRequester.md new file mode 100644 index 00000000..e3a26154 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/AccountrequestdetailsdtoRequester.md @@ -0,0 +1,21 @@ +--- +id: v1-accountrequestdetailsdto-requester-v1 +title: AccountrequestdetailsdtoRequesterV1 +pagination_label: AccountrequestdetailsdtoRequesterV1 +sidebar_label: AccountrequestdetailsdtoRequesterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestdetailsdtoRequesterV1', 'v1AccountrequestdetailsdtoRequesterV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/accountrequestdetailsdto-requester-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestdetailsdtoRequesterV1', 'v1AccountrequestdetailsdtoRequesterV1'] +--- + +# AccountrequestdetailsdtoRequesterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphase.md b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphase.md new file mode 100644 index 00000000..0519ba4a --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphase.md @@ -0,0 +1,22 @@ +--- +id: v1-accountrequestphase-v1 +title: AccountrequestphaseV1 +pagination_label: AccountrequestphaseV1 +sidebar_label: AccountrequestphaseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestphaseV1', 'v1AccountrequestphaseV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/accountrequestphase-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestphaseV1', 'v1AccountrequestphaseV1'] +--- + +# AccountrequestphaseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Enum of account request phase type | [default to undefined] +**state** | **(optional)** **AccountrequestphasestateV1** | | [default to undefined] +**started** | **(optional)** **string** | Start date of account request phase. | [readonly] [default to undefined] +**finished** | **(optional)** **string** | Finish date of account request phase. | [readonly] [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphasestate.md b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphasestate.md new file mode 100644 index 00000000..ad2f462a --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Accountrequestphasestate.md @@ -0,0 +1,31 @@ +--- +id: v1-accountrequestphasestate-v1 +title: AccountrequestphasestateV1 +pagination_label: AccountrequestphasestateV1 +sidebar_label: AccountrequestphasestateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountrequestphasestateV1', 'v1AccountrequestphasestateV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/accountrequestphasestate-v1 +tags: ['SDK', 'Software Development Kit', 'AccountrequestphasestateV1', 'v1AccountrequestphasestateV1'] +--- + +# AccountrequestphasestateV1 + +## Enum + + +* `Pending` (value: `'PENDING'`) + +* `Cancelled` (value: `'CANCELLED'`) + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Passed` (value: `'PASSED'`) + +* `Failed` (value: `'FAILED'`) + +* `NotStarted` (value: `'NOT_STARTED'`) + + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Basereferencedto.md b/sdk-output/machine_account_creation_request/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..dbc382d9 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1401Response.md b/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1401Response.md new file mode 100644 index 00000000..0d542eb8 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-create-machine-account-request-v1401-response-v1 +title: CreateMachineAccountRequestV1401ResponseV1 +pagination_label: CreateMachineAccountRequestV1401ResponseV1 +sidebar_label: CreateMachineAccountRequestV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateMachineAccountRequestV1401ResponseV1', 'v1CreateMachineAccountRequestV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/create-machine-account-request-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateMachineAccountRequestV1401ResponseV1', 'v1CreateMachineAccountRequestV1401ResponseV1'] +--- + +# CreateMachineAccountRequestV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1429Response.md b/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1429Response.md new file mode 100644 index 00000000..ebc9208c --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/CreateMachineAccountRequestV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-create-machine-account-request-v1429-response-v1 +title: CreateMachineAccountRequestV1429ResponseV1 +pagination_label: CreateMachineAccountRequestV1429ResponseV1 +sidebar_label: CreateMachineAccountRequestV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateMachineAccountRequestV1429ResponseV1', 'v1CreateMachineAccountRequestV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/create-machine-account-request-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateMachineAccountRequestV1429ResponseV1', 'v1CreateMachineAccountRequestV1429ResponseV1'] +--- + +# CreateMachineAccountRequestV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Dtotype.md b/sdk-output/machine_account_creation_request/docs/Models/Dtotype.md new file mode 100644 index 00000000..cc67fc0f --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Errormessagedto.md b/sdk-output/machine_account_creation_request/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..f1310e6a --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Errorresponsedto.md b/sdk-output/machine_account_creation_request/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..675b2bb0 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Index.md b/sdk-output/machine_account_creation_request/docs/Models/Index.md new file mode 100644 index 00000000..2e924fd2 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_account_creation_request-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_account_creation_request-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_creation_request', 'models'] +slug: /tools/sdk/typescript/machine_account_creation_request/models +tags: ['SDK', 'Software Development Kit', 'machine_account_creation_request', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_account_creation_request/docs/Models/Localeorigin.md b/sdk-output/machine_account_creation_request/docs/Models/Localeorigin.md new file mode 100644 index 00000000..26eb8b99 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreateaccessdto.md b/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreateaccessdto.md new file mode 100644 index 00000000..1cd2d06b --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreateaccessdto.md @@ -0,0 +1,21 @@ +--- +id: v1-machineaccountcreateaccessdto-v1 +title: MachineaccountcreateaccessdtoV1 +pagination_label: MachineaccountcreateaccessdtoV1 +sidebar_label: MachineaccountcreateaccessdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountcreateaccessdtoV1', 'v1MachineaccountcreateaccessdtoV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/machineaccountcreateaccessdto-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountcreateaccessdtoV1', 'v1MachineaccountcreateaccessdtoV1'] +--- + +# MachineaccountcreateaccessdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **(optional)** **string** | Source ID. | [default to undefined] +**sourceName** | **(optional)** **string** | Source name. | [default to undefined] +**subtypes** | **(optional)** **Array<MachineaccountcreateaccessdtoSubtypesInnerV1>** | List of subtypes for which the user has an entitlement to request machine accounts. | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/MachineaccountcreateaccessdtoSubtypesInner.md b/sdk-output/machine_account_creation_request/docs/Models/MachineaccountcreateaccessdtoSubtypesInner.md new file mode 100644 index 00000000..46fd8fc4 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/MachineaccountcreateaccessdtoSubtypesInner.md @@ -0,0 +1,22 @@ +--- +id: v1-machineaccountcreateaccessdto-subtypes-inner-v1 +title: MachineaccountcreateaccessdtoSubtypesInnerV1 +pagination_label: MachineaccountcreateaccessdtoSubtypesInnerV1 +sidebar_label: MachineaccountcreateaccessdtoSubtypesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountcreateaccessdtoSubtypesInnerV1', 'v1MachineaccountcreateaccessdtoSubtypesInnerV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/machineaccountcreateaccessdto-subtypes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountcreateaccessdtoSubtypesInnerV1', 'v1MachineaccountcreateaccessdtoSubtypesInnerV1'] +--- + +# MachineaccountcreateaccessdtoSubtypesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subtypeId** | **(optional)** **string** | Subtype ID. | [default to undefined] +**entitlementId** | **(optional)** **string** | Entitlement ID. | [default to undefined] +**subtypeDisplayName** | **(optional)** **string** | Subtype display name. | [default to undefined] +**subtypeTechnicalName** | **(optional)** **string** | Subtype technical name. | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreaterequestinput.md b/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreaterequestinput.md new file mode 100644 index 00000000..1120cbb9 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/Machineaccountcreaterequestinput.md @@ -0,0 +1,26 @@ +--- +id: v1-machineaccountcreaterequestinput-v1 +title: MachineaccountcreaterequestinputV1 +pagination_label: MachineaccountcreaterequestinputV1 +sidebar_label: MachineaccountcreaterequestinputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountcreaterequestinputV1', 'v1MachineaccountcreaterequestinputV1'] +slug: /tools/sdk/typescript/machine_account_creation_request/models/machineaccountcreaterequestinput-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountcreaterequestinputV1', 'v1MachineaccountcreaterequestinputV1'] +--- + +# MachineaccountcreaterequestinputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subtypeId** | **string** | Subtype ID for which machine account create is enabled and user have the entitlement to create the machine account. | [default to undefined] +**formId** | **(optional)** **string** | Form ID selected by user for the machine account create request. | [default to undefined] +**ownerIdentityId** | **string** | Owner Identity ID. This identity will be assigned as an owner of the created machine account. | [default to undefined] +**machineIdentityId** | **(optional)** **string** | Machine identity to correlate with the created machine account. If not provided, a new machine identity will be created. | [default to undefined] +**environment** | **(optional)** **string** | Environment type to use for the machine account. | [default to undefined] +**description** | **(optional)** **string** | Description for the machine account. | [default to undefined] +**userInput** | **(optional)** **object** | Fields of the form linked to the subtype in approval settings. | [default to undefined] +**entitlementIds** | **(optional)** **Array<string>** | List of entitlement IDs to provision for created machine account. | [default to undefined] + diff --git a/sdk-output/machine_account_creation_request/docs/Models/README.md b/sdk-output/machine_account_creation_request/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_creation_request/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_mappings/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_account_mappings/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..62ca75fa --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,64 @@ +- path: /sources/v1/{sourceId}/machine-account-mappings + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_mappings/methods/machine-account-mappings#create-machine-account-mappings-v1 + source: | + import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountMappingsV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const attributemappingsV1: AttributemappingsV1 = ; // AttributemappingsV1 | + const result = await apiInstance.createMachineAccountMappingsV1(sourceId, attributemappingsV1); + console.log(result); +- path: /sources/v1/{sourceId}/machine-account-mappings + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_mappings/methods/machine-account-mappings#delete-machine-account-mappings-v1 + source: | + import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountMappingsV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | source ID. (default to undefined) + const result = await apiInstance.deleteMachineAccountMappingsV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/machine-account-mappings + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_mappings/methods/machine-account-mappings#list-machine-account-mappings-v1 + source: | + import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountMappingsV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listMachineAccountMappingsV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/machine-mappings + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_mappings/methods/machine-account-mappings#set-machine-account-mappings-v1 + source: | + import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountMappingsV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const attributemappingsV1: AttributemappingsV1 = ; // AttributemappingsV1 | + const result = await apiInstance.setMachineAccountMappingsV1(sourceId, attributemappingsV1); + console.log(result); diff --git a/sdk-output/machine_account_mappings/docs/Methods/Index.md b/sdk-output/machine_account_mappings/docs/Methods/Index.md new file mode 100644 index 00000000..44e17978 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_account_mappings-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_account_mappings-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_mappings', 'methods'] +slug: /tools/sdk/typescript/machine_account_mappings/methods +tags: ['SDK', 'Software Development Kit', 'machine_account_mappings', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_account_mappings/docs/Methods/MachineAccountMappingsV1Api.md b/sdk-output/machine_account_mappings/docs/Methods/MachineAccountMappingsV1Api.md new file mode 100644 index 00000000..a9335c59 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Methods/MachineAccountMappingsV1Api.md @@ -0,0 +1,185 @@ +--- +id: v1-machine-account-mappings +title: MachineAccountMappings +pagination_label: MachineAccountMappings +sidebar_label: MachineAccountMappings +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineAccountMappings', 'v1MachineAccountMappings'] +slug: /tools/sdk/typescript/machine_account_mappings/methods/machine-account-mappings +tags: ['SDK', 'Software Development Kit', 'MachineAccountMappings', 'v1MachineAccountMappings'] +--- + +# MachineAccountMappingsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-account-mappings-v1**](#create-machine-account-mappings-v1) | **POST** `/sources/v1/{sourceId}/machine-account-mappings` | Create machine account mappings +[**delete-machine-account-mappings-v1**](#delete-machine-account-mappings-v1) | **DELETE** `/sources/v1/{sourceId}/machine-account-mappings` | Delete source\'s machine account mappings +[**list-machine-account-mappings-v1**](#list-machine-account-mappings-v1) | **GET** `/sources/v1/{sourceId}/machine-account-mappings` | Machine account mapping for source +[**set-machine-account-mappings-v1**](#set-machine-account-mappings-v1) | **PUT** `/sources/v1/{sourceId}/machine-mappings` | Update source\'s machine account mappings + + +## create-machine-account-mappings-v1 +Create machine account mappings +Creates Machine Account Mappings for both identities and accounts for a source. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-machine-account-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**attributemappingsV1** | **AttributemappingsV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountMappingsV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const attributemappingsV1: AttributemappingsV1 = ; // +const result = await apiInstance.createMachineAccountMappingsV1(sourceId, attributemappingsV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-machine-account-mappings-v1 +Delete source\'s machine account mappings +Use this API to remove machine account attribute mappings for a Source. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-machine-account-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | source ID. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountMappingsV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // source ID. +const result = await apiInstance.deleteMachineAccountMappingsV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## list-machine-account-mappings-v1 +Machine account mapping for source +Retrieves Machine account mappings for a specified source using Source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-machine-account-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountMappingsV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listMachineAccountMappingsV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## set-machine-account-mappings-v1 +Update source\'s machine account mappings +Use this API to update Machine Account Attribute Mapping for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-machine-account-mappings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**attributemappingsV1** | **AttributemappingsV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountMappingsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountMappingsV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const attributemappingsV1: AttributemappingsV1 = ; // +const result = await apiInstance.setMachineAccountMappingsV1(sourceId, attributemappingsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_account_mappings/docs/Models/Attributemappings.md b/sdk-output/machine_account_mappings/docs/Models/Attributemappings.md new file mode 100644 index 00000000..543b5e77 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/Attributemappings.md @@ -0,0 +1,20 @@ +--- +id: v1-attributemappings-v1 +title: AttributemappingsV1 +pagination_label: AttributemappingsV1 +sidebar_label: AttributemappingsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsV1', 'v1AttributemappingsV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsV1', 'v1AttributemappingsV1'] +--- + +# AttributemappingsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target** | **(optional)** **AttributemappingsAllOfTargetV1** | | [default to undefined] +**transformDefinition** | **(optional)** **AttributemappingsAllOfTransformDefinitionV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTarget.md b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTarget.md new file mode 100644 index 00000000..03f42333 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTarget.md @@ -0,0 +1,21 @@ +--- +id: v1-attributemappings-all-of-target-v1 +title: AttributemappingsAllOfTargetV1 +pagination_label: AttributemappingsAllOfTargetV1 +sidebar_label: AttributemappingsAllOfTargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsAllOfTargetV1', 'v1AttributemappingsAllOfTargetV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-all-of-target-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsAllOfTargetV1', 'v1AttributemappingsAllOfTargetV1'] +--- + +# AttributemappingsAllOfTargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of target entity | [default to undefined] +**attributeName** | **(optional)** **string** | Name of the targeted attribute | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of Source | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinition.md b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinition.md new file mode 100644 index 00000000..a7ae2555 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinition.md @@ -0,0 +1,21 @@ +--- +id: v1-attributemappings-all-of-transform-definition-v1 +title: AttributemappingsAllOfTransformDefinitionV1 +pagination_label: AttributemappingsAllOfTransformDefinitionV1 +sidebar_label: AttributemappingsAllOfTransformDefinitionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsAllOfTransformDefinitionV1', 'v1AttributemappingsAllOfTransformDefinitionV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-all-of-transform-definition-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsAllOfTransformDefinitionV1', 'v1AttributemappingsAllOfTransformDefinitionV1'] +--- + +# AttributemappingsAllOfTransformDefinitionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of transform | [default to undefined] +**attributes** | **(optional)** **AttributemappingsAllOfTransformDefinitionAttributesV1** | | [default to undefined] +**id** | **(optional)** **string** | Transform Operation | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributes.md b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributes.md new file mode 100644 index 00000000..2efb66ca --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributes.md @@ -0,0 +1,19 @@ +--- +id: v1-attributemappings-all-of-transform-definition-attributes-v1 +title: AttributemappingsAllOfTransformDefinitionAttributesV1 +pagination_label: AttributemappingsAllOfTransformDefinitionAttributesV1 +sidebar_label: AttributemappingsAllOfTransformDefinitionAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsAllOfTransformDefinitionAttributesV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-all-of-transform-definition-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsAllOfTransformDefinitionAttributesV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesV1'] +--- + +# AttributemappingsAllOfTransformDefinitionAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **(optional)** **AttributemappingsAllOfTransformDefinitionAttributesInputV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInput.md b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInput.md new file mode 100644 index 00000000..c7f48216 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInput.md @@ -0,0 +1,20 @@ +--- +id: v1-attributemappings-all-of-transform-definition-attributes-input-v1 +title: AttributemappingsAllOfTransformDefinitionAttributesInputV1 +pagination_label: AttributemappingsAllOfTransformDefinitionAttributesInputV1 +sidebar_label: AttributemappingsAllOfTransformDefinitionAttributesInputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsAllOfTransformDefinitionAttributesInputV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesInputV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-all-of-transform-definition-attributes-input-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsAllOfTransformDefinitionAttributesInputV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesInputV1'] +--- + +# AttributemappingsAllOfTransformDefinitionAttributesInputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The Type of Attribute | [default to undefined] +**attributes** | **(optional)** **AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInputAttributes.md b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInputAttributes.md new file mode 100644 index 00000000..6d9ead25 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/AttributemappingsAllOfTransformDefinitionAttributesInputAttributes.md @@ -0,0 +1,21 @@ +--- +id: v1-attributemappings-all-of-transform-definition-attributes-input-attributes-v1 +title: AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 +pagination_label: AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 +sidebar_label: AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/attributemappings-all-of-transform-definition-attributes-input-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1', 'v1AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1'] +--- + +# AttributemappingsAllOfTransformDefinitionAttributesInputAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **(optional)** **string** | The name of attribute | [default to undefined] +**sourceName** | **(optional)** **string** | Name of the Source | [default to undefined] +**name** | **(optional)** **string** | ID of the Source | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/Errormessagedto.md b/sdk-output/machine_account_mappings/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..7d50b4c9 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/Errorresponsedto.md b/sdk-output/machine_account_mappings/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..bab0ea79 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/Index.md b/sdk-output/machine_account_mappings/docs/Models/Index.md new file mode 100644 index 00000000..a8e89d10 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_account_mappings-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_account_mappings-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_mappings', 'models'] +slug: /tools/sdk/typescript/machine_account_mappings/models +tags: ['SDK', 'Software Development Kit', 'machine_account_mappings', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1401Response.md b/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1401Response.md new file mode 100644 index 00000000..c64630a2 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-account-mappings-v1401-response-v1 +title: ListMachineAccountMappingsV1401ResponseV1 +pagination_label: ListMachineAccountMappingsV1401ResponseV1 +sidebar_label: ListMachineAccountMappingsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineAccountMappingsV1401ResponseV1', 'v1ListMachineAccountMappingsV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/list-machine-account-mappings-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineAccountMappingsV1401ResponseV1', 'v1ListMachineAccountMappingsV1401ResponseV1'] +--- + +# ListMachineAccountMappingsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1429Response.md b/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1429Response.md new file mode 100644 index 00000000..930b2927 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/ListMachineAccountMappingsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-account-mappings-v1429-response-v1 +title: ListMachineAccountMappingsV1429ResponseV1 +pagination_label: ListMachineAccountMappingsV1429ResponseV1 +sidebar_label: ListMachineAccountMappingsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineAccountMappingsV1429ResponseV1', 'v1ListMachineAccountMappingsV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/list-machine-account-mappings-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineAccountMappingsV1429ResponseV1', 'v1ListMachineAccountMappingsV1429ResponseV1'] +--- + +# ListMachineAccountMappingsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_mappings/docs/Models/Localeorigin.md b/sdk-output/machine_account_mappings/docs/Models/Localeorigin.md new file mode 100644 index 00000000..4efd1403 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_account_mappings/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_account_mappings/docs/Models/README.md b/sdk-output/machine_account_mappings/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_mappings/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_subtypes/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_account_subtypes/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..58631d48 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,134 @@ +- path: /source-subtypes/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#create-source-subtype-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const createSourceSubtypeV1RequestV1: CreateSourceSubtypeV1RequestV1 = {"sourceId":"6d0458373bec4b4b80460992b76016da","technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}; // CreateSourceSubtypeV1RequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createSourceSubtypeV1(createSourceSubtypeV1RequestV1); + console.log(result); +- path: /source-subtypes/v1/{subtypeId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#delete-machine-account-subtype-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const subtypeId: string = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa'; // string | The ID of the subtype. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteMachineAccountSubtypeV1(subtypeId); + console.log(result); +- path: /source-subtypes/v1/{subtypeId}/machine-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#get-machine-account-subtype-approval-config-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const subtypeId: string = 'ef38f94347e94562b5bb8424a56498d8'; // string | machine subtype id. (default to undefined) + const result = await apiInstance.getMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId); + console.log(result); +- path: /source-subtypes/v1/{subtypeId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#get-source-subtype-by-id-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const subtypeId: string = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa'; // string | The ID of the subtype. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSourceSubtypeByIdV1(subtypeId); + console.log(result); +- path: /source-subtypes/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#list-source-subtypes-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const filters: string = 'displayName eq "sail"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* (optional) (default to undefined) + const sorters: string = 'displayName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listSourceSubtypesV1(); + console.log(result); +- path: /source-subtypes/v1/bulk-retrieve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#load-bulk-source-subtypes-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const requestBody: Array<string> = ; // Array | + const result = await apiInstance.loadBulkSourceSubtypesV1(xSailPointExperimental, requestBody); + console.log(result); +- path: /source-subtypes/v1/{subtypeId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#patch-machine-account-subtype-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const subtypeId: string = '6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa'; // string | The ID of the subtype. (default to undefined) + const requestBody: Array<object> = [{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]; // Array | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchMachineAccountSubtypeV1(subtypeId, requestBody); + console.log(result); +- path: /source-subtypes/v1/{subtypeId}/machine-config + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes#update-machine-account-subtype-approval-config-v1 + source: | + import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountSubtypesV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (default to 'true') + const subtypeId: string = '00eebcf881994e419d72e757fd30dc0e'; // string | machine account subtype ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | The JSONPatch payload used to update the object. + const result = await apiInstance.updateMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/machine_account_subtypes/docs/Methods/Index.md b/sdk-output/machine_account_subtypes/docs/Methods/Index.md new file mode 100644 index 00000000..9a9dded3 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_account_subtypes-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_account_subtypes-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_subtypes', 'methods'] +slug: /tools/sdk/typescript/machine_account_subtypes/methods +tags: ['SDK', 'Software Development Kit', 'machine_account_subtypes', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_account_subtypes/docs/Methods/MachineAccountSubtypesV1Api.md b/sdk-output/machine_account_subtypes/docs/Methods/MachineAccountSubtypesV1Api.md new file mode 100644 index 00000000..0a056561 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Methods/MachineAccountSubtypesV1Api.md @@ -0,0 +1,387 @@ +--- +id: v1-machine-account-subtypes +title: MachineAccountSubtypes +pagination_label: MachineAccountSubtypes +sidebar_label: MachineAccountSubtypes +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineAccountSubtypes', 'v1MachineAccountSubtypes'] +slug: /tools/sdk/typescript/machine_account_subtypes/methods/machine-account-subtypes +tags: ['SDK', 'Software Development Kit', 'MachineAccountSubtypes', 'v1MachineAccountSubtypes'] +--- + +# MachineAccountSubtypesV1Api + Use this API to get, update, and delete machine account subtype for sources. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-source-subtype-v1**](#create-source-subtype-v1) | **POST** `/source-subtypes/v1` | Create subtype +[**delete-machine-account-subtype-v1**](#delete-machine-account-subtype-v1) | **DELETE** `/source-subtypes/v1/{subtypeId}` | Delete subtype by ID +[**get-machine-account-subtype-approval-config-v1**](#get-machine-account-subtype-approval-config-v1) | **GET** `/source-subtypes/v1/{subtypeId}/machine-config` | Machine Subtype Approval Config +[**get-source-subtype-by-id-v1**](#get-source-subtype-by-id-v1) | **GET** `/source-subtypes/v1/{subtypeId}` | Get subtype by ID +[**list-source-subtypes-v1**](#list-source-subtypes-v1) | **GET** `/source-subtypes/v1` | Retrieve all subtypes +[**load-bulk-source-subtypes-v1**](#load-bulk-source-subtypes-v1) | **POST** `/source-subtypes/v1/bulk-retrieve` | Bulk Retrieve of Source Subtypes +[**patch-machine-account-subtype-v1**](#patch-machine-account-subtype-v1) | **PATCH** `/source-subtypes/v1/{subtypeId}` | Patch subtype by ID +[**update-machine-account-subtype-approval-config-v1**](#update-machine-account-subtype-approval-config-v1) | **PATCH** `/source-subtypes/v1/{subtypeId}/machine-config` | Machine Subtype Approval Config + + +## create-source-subtype-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create subtype +Create a new machine account subtype. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-source-subtype-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createSourceSubtypeV1RequestV1** | **CreateSourceSubtypeV1RequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypewithsourceV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const createSourceSubtypeV1RequestV1: CreateSourceSubtypeV1RequestV1 = {"sourceId":"6d0458373bec4b4b80460992b76016da","technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createSourceSubtypeV1(createSourceSubtypeV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-machine-account-subtype-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete subtype by ID +Delete a machine account subtype by subtype ID. + +Note: If subtype has approval settings or entitlement for machine account creation enablement then it'll be also deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-machine-account-subtype-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**subtypeId** | **string** | The ID of the subtype. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const subtypeId: string = 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa; // The ID of the subtype. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteMachineAccountSubtypeV1(subtypeId); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-subtype-approval-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Machine Subtype Approval Config +This endpoint retrieves the approval configuration for machine account creation and deletion at the machine subtype level. By providing a specific subtypeId in the path, clients can fetch the approval rules and settings (such as required approvers and comments policy) that govern account creation and deletion for that particular machine subtype. The response includes a MachineAccountSubtypeConfigDto object detailing these configurations, enabling clients to understand or display the approval workflow required for creating and deleting machine accounts of the given subtype. Use this endpoint to get machine subtype level approval config for account creation and deletion. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-subtype-approval-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**subtypeId** | **string** | machine subtype id. | [default to undefined] + +### Return type + +**MachineaccountsubtypeconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const subtypeId: string = ef38f94347e94562b5bb8424a56498d8; // machine subtype id. +const result = await apiInstance.getMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-subtype-by-id-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get subtype by ID +Get a machine account subtype by subtype ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-subtype-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**subtypeId** | **string** | The ID of the subtype. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypewithsourceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const subtypeId: string = 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa; // The ID of the subtype. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSourceSubtypeByIdV1(subtypeId); +console.log(result); +``` + +[[Back to top]](#) + +## list-source-subtypes-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve all subtypes +Get all machine account subtypes. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-source-subtypes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const filters: string = displayName eq "sail"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, sw* **technicalName**: *eq, sw* **source.id**: *eq, in* (optional) +const sorters: string = displayName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listSourceSubtypesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## load-bulk-source-subtypes-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Bulk Retrieve of Source Subtypes +This endpoint retrieves the subtypes for given subtypeIds. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/load-bulk-source-subtypes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**requestBody** | **Array<string>** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const requestBody: Array<string> = ; // +const result = await apiInstance.loadBulkSourceSubtypesV1(xSailPointExperimental, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## patch-machine-account-subtype-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch subtype by ID +Update fields of a machine account subtype by subtype ID. +Patchable fields only include: `displayName`, `description`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-machine-account-subtype-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**subtypeId** | **string** | The ID of the subtype. | [default to undefined] +**requestBody** | **Array<object>** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypewithsourceV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const subtypeId: string = 6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa; // The ID of the subtype. +const requestBody: Array<object> = [{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchMachineAccountSubtypeV1(subtypeId, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## update-machine-account-subtype-approval-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Machine Subtype Approval Config +Updates the approval configuration for machine account deletion at the specified machine subtype level. This endpoint allows clients to modify approval rules and settings (such as required approvers and comments policy) for account creation and deletion workflows associated with a given subtypeId. Use this to customize or enforce approval requirements for creating and deleting machine accounts of a particular subtype. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-machine-account-subtype-approval-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [default to 'true'] +**subtypeId** | **string** | machine account subtype ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the object. | + +### Return type + +**MachineaccountsubtypeconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountSubtypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountSubtypesV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. +const subtypeId: string = 00eebcf881994e419d72e757fd30dc0e; // machine account subtype ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // The JSONPatch payload used to update the object. +const result = await apiInstance.updateMachineAccountSubtypeApprovalConfigV1(xSailPointExperimental, subtypeId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_account_subtypes/docs/Models/ArrayInner.md b/sdk-output/machine_account_subtypes/docs/Models/ArrayInner.md new file mode 100644 index 00000000..2a095fcf --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/machine_account_subtypes/docs/Models/CreateSourceSubtypeV1Request.md b/sdk-output/machine_account_subtypes/docs/Models/CreateSourceSubtypeV1Request.md new file mode 100644 index 00000000..d0fcac7e --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/CreateSourceSubtypeV1Request.md @@ -0,0 +1,23 @@ +--- +id: v1-create-source-subtype-v1-request-v1 +title: CreateSourceSubtypeV1RequestV1 +pagination_label: CreateSourceSubtypeV1RequestV1 +sidebar_label: CreateSourceSubtypeV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateSourceSubtypeV1RequestV1', 'v1CreateSourceSubtypeV1RequestV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/create-source-subtype-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateSourceSubtypeV1RequestV1', 'v1CreateSourceSubtypeV1RequestV1'] +--- + +# CreateSourceSubtypeV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **string** | ID of the source where subtype is created. | [default to undefined] +**technicalName** | **string** | Technical name of the subtype. | [default to undefined] +**displayName** | **string** | Display name of the subtype. | [default to undefined] +**description** | **string** | Description of the subtype. | [default to undefined] +**type** | **(optional)** **string** | Type of the subtype. | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Errormessagedto.md b/sdk-output/machine_account_subtypes/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..cae72879 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Errorresponsedto.md b/sdk-output/machine_account_subtypes/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e568d61d --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Index.md b/sdk-output/machine_account_subtypes/docs/Models/Index.md new file mode 100644 index 00000000..8aae70b4 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_account_subtypes-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_account_subtypes-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_account_subtypes', 'models'] +slug: /tools/sdk/typescript/machine_account_subtypes/models +tags: ['SDK', 'Software Development Kit', 'machine_account_subtypes', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_account_subtypes/docs/Models/Jsonpatchoperation.md b/sdk-output/machine_account_subtypes/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..be51ef00 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/JsonpatchoperationValue.md b/sdk-output/machine_account_subtypes/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..4a65b80c --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1401Response.md b/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1401Response.md new file mode 100644 index 00000000..32a55059 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-load-bulk-source-subtypes-v1401-response-v1 +title: LoadBulkSourceSubtypesV1401ResponseV1 +pagination_label: LoadBulkSourceSubtypesV1401ResponseV1 +sidebar_label: LoadBulkSourceSubtypesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadBulkSourceSubtypesV1401ResponseV1', 'v1LoadBulkSourceSubtypesV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/load-bulk-source-subtypes-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'LoadBulkSourceSubtypesV1401ResponseV1', 'v1LoadBulkSourceSubtypesV1401ResponseV1'] +--- + +# LoadBulkSourceSubtypesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1429Response.md b/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1429Response.md new file mode 100644 index 00000000..0ddf435f --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/LoadBulkSourceSubtypesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-load-bulk-source-subtypes-v1429-response-v1 +title: LoadBulkSourceSubtypesV1429ResponseV1 +pagination_label: LoadBulkSourceSubtypesV1429ResponseV1 +sidebar_label: LoadBulkSourceSubtypesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadBulkSourceSubtypesV1429ResponseV1', 'v1LoadBulkSourceSubtypesV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/load-bulk-source-subtypes-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'LoadBulkSourceSubtypesV1429ResponseV1', 'v1LoadBulkSourceSubtypesV1429ResponseV1'] +--- + +# LoadBulkSourceSubtypesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Localeorigin.md b/sdk-output/machine_account_subtypes/docs/Models/Localeorigin.md new file mode 100644 index 00000000..ab846cd3 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Machineaccountsubtypeconfigdto.md b/sdk-output/machine_account_subtypes/docs/Models/Machineaccountsubtypeconfigdto.md new file mode 100644 index 00000000..a64af217 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Machineaccountsubtypeconfigdto.md @@ -0,0 +1,21 @@ +--- +id: v1-machineaccountsubtypeconfigdto-v1 +title: MachineaccountsubtypeconfigdtoV1 +pagination_label: MachineaccountsubtypeconfigdtoV1 +sidebar_label: MachineaccountsubtypeconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountsubtypeconfigdtoV1', 'v1MachineaccountsubtypeconfigdtoV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/machineaccountsubtypeconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountsubtypeconfigdtoV1', 'v1MachineaccountsubtypeconfigdtoV1'] +--- + +# MachineaccountsubtypeconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**subtypeId** | **(optional)** **string** | Unique identifier representing the specific subtype of the machine account, used to distinguish between different machine account categories. | [default to undefined] +**machineAccountCreate** | **(optional)** **MachineaccountsubtypeconfigdtoMachineAccountCreateV1** | | [default to undefined] +**machineAccountDelete** | **(optional)** **MachineaccountsubtypeconfigdtoMachineAccountDeleteV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountCreate.md b/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountCreate.md new file mode 100644 index 00000000..9a7e6733 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountCreate.md @@ -0,0 +1,25 @@ +--- +id: v1-machineaccountsubtypeconfigdto-machine-account-create-v1 +title: MachineaccountsubtypeconfigdtoMachineAccountCreateV1 +pagination_label: MachineaccountsubtypeconfigdtoMachineAccountCreateV1 +sidebar_label: MachineaccountsubtypeconfigdtoMachineAccountCreateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountsubtypeconfigdtoMachineAccountCreateV1', 'v1MachineaccountsubtypeconfigdtoMachineAccountCreateV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/machineaccountsubtypeconfigdto-machine-account-create-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountsubtypeconfigdtoMachineAccountCreateV1', 'v1MachineaccountsubtypeconfigdtoMachineAccountCreateV1'] +--- + +# MachineaccountsubtypeconfigdtoMachineAccountCreateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountCreateEnabled** | **(optional)** **boolean** | Specifies if the creation of machine accounts is allowed for this subtype. | [default to false] +**approvalRequired** | **(optional)** **boolean** | Specifies if approval is required for machine account creation requests for this subtype. | [default to false] +**formId** | **(optional)** **string** | Id of the form linked to subtype. | [default to undefined] +**entitlementId** | **(optional)** **string** | Id of the system created entitlement entitlement upon enabling account creation for this subtype. | [default to undefined] +**passwordSetting** | **(optional)** **string** | This is required before enabling the account creation to true. Default value will be null. | [default to undefined] +**passwordAttribute** | **(optional)** **string** | Name of the account attribute from the source\'s schema or new custom attribute to use when password settings is enabled. | [default to undefined] +**approvalConfig** | **(optional)** **MachinesubtypeapprovalconfigV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountDelete.md b/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountDelete.md new file mode 100644 index 00000000..eef6e799 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/MachineaccountsubtypeconfigdtoMachineAccountDelete.md @@ -0,0 +1,20 @@ +--- +id: v1-machineaccountsubtypeconfigdto-machine-account-delete-v1 +title: MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 +pagination_label: MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 +sidebar_label: MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountsubtypeconfigdtoMachineAccountDeleteV1', 'v1MachineaccountsubtypeconfigdtoMachineAccountDeleteV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/machineaccountsubtypeconfigdto-machine-account-delete-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountsubtypeconfigdtoMachineAccountDeleteV1', 'v1MachineaccountsubtypeconfigdtoMachineAccountDeleteV1'] +--- + +# MachineaccountsubtypeconfigdtoMachineAccountDeleteV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalRequired** | **(optional)** **boolean** | Indicates whether approval is required for an account deletion request. | [default to false] +**approvalConfig** | **(optional)** **MachinesubtypeapprovalconfigV1** | | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/Machinesubtypeapprovalconfig.md b/sdk-output/machine_account_subtypes/docs/Models/Machinesubtypeapprovalconfig.md new file mode 100644 index 00000000..bc02bcab --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Machinesubtypeapprovalconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-machinesubtypeapprovalconfig-v1 +title: MachinesubtypeapprovalconfigV1 +pagination_label: MachinesubtypeapprovalconfigV1 +sidebar_label: MachinesubtypeapprovalconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachinesubtypeapprovalconfigV1', 'v1MachinesubtypeapprovalconfigV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/machinesubtypeapprovalconfig-v1 +tags: ['SDK', 'Software Development Kit', 'MachinesubtypeapprovalconfigV1', 'v1MachinesubtypeapprovalconfigV1'] +--- + +# MachinesubtypeapprovalconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvers** | **(optional)** **string** | Comma separated string of approvers. Following are the options for approver types: manager, sourceOwner, accountOwner, workgroup:[workgroupId] (Governance group). Approval request will be assigned based on the order of the approvers passed. Multiple workgroups(governance groups) can be selected as an approver. >**Note:** accountOwner approver type is only for machine account delete approval settings. | [default to undefined] +**comments** | **(optional)** **string** | Comment configurations for the approval request. Following are the options for comments: ALL, OFF, APPROVAL, REJECT. | [default to undefined] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/README.md b/sdk-output/machine_account_subtypes/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_account_subtypes/docs/Models/Sourcesubtypewithsource.md b/sdk-output/machine_account_subtypes/docs/Models/Sourcesubtypewithsource.md new file mode 100644 index 00000000..b37d8cbd --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/Sourcesubtypewithsource.md @@ -0,0 +1,28 @@ +--- +id: v1-sourcesubtypewithsource-v1 +title: SourcesubtypewithsourceV1 +pagination_label: SourcesubtypewithsourceV1 +sidebar_label: SourcesubtypewithsourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcesubtypewithsourceV1', 'v1SourcesubtypewithsourceV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/sourcesubtypewithsource-v1 +tags: ['SDK', 'Software Development Kit', 'SourcesubtypewithsourceV1', 'v1SourcesubtypewithsourceV1'] +--- + +# SourcesubtypewithsourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the subtype. | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source. | [readonly] [default to undefined] +**technicalName** | **(optional)** **string** | Technical name of the subtype. | [default to undefined] +**displayName** | **(optional)** **string** | Display name of the subtype. | [default to undefined] +**description** | **(optional)** **string** | Description of the subtype. | [default to undefined] +**created** | **(optional)** **string** | Creation timestamp. | [default to undefined] +**modified** | **(optional)** **string** | Last modified timestamp. | [default to undefined] +**type** | **(optional)** **string** | Type of the subtype. Either MACHINE OR null. | [default to undefined] +**source** | **(optional)** **SourcesubtypewithsourceSourceV1** | | [default to undefined] +**systemManaged** | **(optional)** **boolean** | Indicates if the subtype is managed by the system. | [default to false] + diff --git a/sdk-output/machine_account_subtypes/docs/Models/SourcesubtypewithsourceSource.md b/sdk-output/machine_account_subtypes/docs/Models/SourcesubtypewithsourceSource.md new file mode 100644 index 00000000..392c6734 --- /dev/null +++ b/sdk-output/machine_account_subtypes/docs/Models/SourcesubtypewithsourceSource.md @@ -0,0 +1,21 @@ +--- +id: v1-sourcesubtypewithsource-source-v1 +title: SourcesubtypewithsourceSourceV1 +pagination_label: SourcesubtypewithsourceSourceV1 +sidebar_label: SourcesubtypewithsourceSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcesubtypewithsourceSourceV1', 'v1SourcesubtypewithsourceSourceV1'] +slug: /tools/sdk/typescript/machine_account_subtypes/models/sourcesubtypewithsource-source-v1 +tags: ['SDK', 'Software Development Kit', 'SourcesubtypewithsourceSourceV1', 'v1SourcesubtypewithsourceSourceV1'] +--- + +# SourcesubtypewithsourceSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the reference object. | [default to undefined] +**id** | **(optional)** **string** | Unique identifier for the source. | [default to undefined] +**name** | **(optional)** **string** | Name of the source. | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_accounts/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5746362d --- /dev/null +++ b/sdk-output/machine_accounts/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,159 @@ +- path: /sources/v1/{sourceId}/subtypes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#create-machine-account-subtype-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const sourceId: string = '6d0458373bec4b4b80460992b76016da'; // string | The ID of the source. (default to undefined) + const createMachineAccountSubtypeV1RequestV1: CreateMachineAccountSubtypeV1RequestV1 = {"technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}; // CreateMachineAccountSubtypeV1RequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createMachineAccountSubtypeV1(sourceId, createMachineAccountSubtypeV1RequestV1); + console.log(result); +- path: /sources/v1/{sourceId}/subtypes/{technicalName} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#delete-machine-account-subtype-by-technical-name-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const sourceId: string = '6d0458373bec4b4b80460992b76016da'; // string | The ID of the source. (default to undefined) + const technicalName: string = 'foo'; // string | The technical name of the subtype. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName); + console.log(result); +- path: /sources/v1/subtypes/{subtypeId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#get-machine-account-subtype-by-id-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const subtypeId: string = '43bdd144-4b17-4fce-a744-17c7fd3e717b'; // string | The ID of the machine account subtype. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getMachineAccountSubtypeByIdV1(subtypeId); + console.log(result); +- path: /sources/v1/{sourceId}/subtypes/{technicalName} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#get-machine-account-subtype-by-technical-name-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const sourceId: string = '6d0458373bec4b4b80460992b76016da'; // string | The ID of the source. (default to undefined) + const technicalName: string = 'foo'; // string | The technical name of the subtype. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName); + console.log(result); +- path: /machine-accounts/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#get-machine-account-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Account ID. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getMachineAccountV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/subtypes + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#list-machine-account-subtypes-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const sourceId: string = '6d0458373bec4b4b80460992b76016da'; // string | The ID of the source. (default to undefined) + const filters: string = 'displayName eq "sail"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'displayName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listMachineAccountSubtypesV1(sourceId); + console.log(result); +- path: /machine-accounts/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#list-machine-accounts-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'hasEntitlements eq true'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* (optional) (default to undefined) + const sorters: string = 'id,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listMachineAccountsV1(); + console.log(result); +- path: /sources/v1/{sourceId}/subtypes/{technicalName} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#patch-machine-account-subtype-by-technical-name-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const sourceId: string = '6d0458373bec4b4b80460992b76016da'; // string | The ID of the source. (default to undefined) + const technicalName: string = 'foo'; // string | The technical name of the subtype. (default to undefined) + const requestBody: Array<object> = [{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]; // Array | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName, requestBody); + console.log(result); +- path: /machine-accounts/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_accounts/methods/machine-accounts#update-machine-account-v1 + source: | + import { MachineAccountsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineAccountsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Account ID. (default to undefined) + const requestBody: Array<object> = [{"op":"add","path":"/environment","value":"test"}]; // Array | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateMachineAccountV1(id, requestBody); + console.log(result); diff --git a/sdk-output/machine_accounts/docs/Methods/Index.md b/sdk-output/machine_accounts/docs/Methods/Index.md new file mode 100644 index 00000000..0b8a908b --- /dev/null +++ b/sdk-output/machine_accounts/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_accounts-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_accounts-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_accounts', 'methods'] +slug: /tools/sdk/typescript/machine_accounts/methods +tags: ['SDK', 'Software Development Kit', 'machine_accounts', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_accounts/docs/Methods/MachineAccountsV1Api.md b/sdk-output/machine_accounts/docs/Methods/MachineAccountsV1Api.md new file mode 100644 index 00000000..93ef569b --- /dev/null +++ b/sdk-output/machine_accounts/docs/Methods/MachineAccountsV1Api.md @@ -0,0 +1,465 @@ +--- +id: v1-machine-accounts +title: MachineAccounts +pagination_label: MachineAccounts +sidebar_label: MachineAccounts +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineAccounts', 'v1MachineAccounts'] +slug: /tools/sdk/typescript/machine_accounts/methods/machine-accounts +tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'v1MachineAccounts'] +--- + +# MachineAccountsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-account-subtype-v1**](#create-machine-account-subtype-v1) | **POST** `/sources/v1/{sourceId}/subtypes` | Create subtype +[**delete-machine-account-subtype-by-technical-name-v1**](#delete-machine-account-subtype-by-technical-name-v1) | **DELETE** `/sources/v1/{sourceId}/subtypes/{technicalName}` | Delete subtype +[**get-machine-account-subtype-by-id-v1**](#get-machine-account-subtype-by-id-v1) | **GET** `/sources/v1/subtypes/{subtypeId}` | Retrieve subtype by subtype id +[**get-machine-account-subtype-by-technical-name-v1**](#get-machine-account-subtype-by-technical-name-v1) | **GET** `/sources/v1/{sourceId}/subtypes/{technicalName}` | Retrieve subtype by source and technicalName +[**get-machine-account-v1**](#get-machine-account-v1) | **GET** `/machine-accounts/v1/{id}` | Get machine account details +[**list-machine-account-subtypes-v1**](#list-machine-account-subtypes-v1) | **GET** `/sources/v1/{sourceId}/subtypes` | Retrieve all subtypes by source +[**list-machine-accounts-v1**](#list-machine-accounts-v1) | **GET** `/machine-accounts/v1` | List machine accounts +[**patch-machine-account-subtype-by-technical-name-v1**](#patch-machine-account-subtype-by-technical-name-v1) | **PATCH** `/sources/v1/{sourceId}/subtypes/{technicalName}` | Patch subtype +[**update-machine-account-v1**](#update-machine-account-v1) | **PATCH** `/machine-accounts/v1/{id}` | Update machine account details + + +## create-machine-account-subtype-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create subtype +Create a new machine account subtype for a source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-machine-account-subtype-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the source. | [default to undefined] +**createMachineAccountSubtypeV1RequestV1** | **CreateMachineAccountSubtypeV1RequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypeV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source. +const createMachineAccountSubtypeV1RequestV1: CreateMachineAccountSubtypeV1RequestV1 = {"technicalName":"foo","displayName":"Mr Foo","description":"fighters","type":"MACHINE"}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createMachineAccountSubtypeV1(sourceId, createMachineAccountSubtypeV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-machine-account-subtype-by-technical-name-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete subtype +Delete a machine account subtype by source ID and technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-machine-account-subtype-by-technical-name-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the source. | [default to undefined] +**technicalName** | **string** | The technical name of the subtype. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source. +const technicalName: string = foo; // The technical name of the subtype. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-subtype-by-id-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve subtype by subtype id +Get a machine account subtype by its unique ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-subtype-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**subtypeId** | **string** | The ID of the machine account subtype. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypeV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const subtypeId: string = 43bdd144-4b17-4fce-a744-17c7fd3e717b; // The ID of the machine account subtype. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getMachineAccountSubtypeByIdV1(subtypeId); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-subtype-by-technical-name-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve subtype by source and technicalName +Get a machine account subtype by source ID and technical name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-subtype-by-technical-name-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the source. | [default to undefined] +**technicalName** | **string** | The technical name of the subtype. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypeV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source. +const technicalName: string = foo; // The technical name of the subtype. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get machine account details +Use this API to return the details for a single machine account by its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Machine Account ID. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineaccountV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Account ID. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getMachineAccountV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-machine-account-subtypes-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Retrieve all subtypes by source +Get all machine account subtypes for a given source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-machine-account-subtypes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the source. | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source. +const filters: string = displayName eq "sail"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **displayName**: *eq, sw* **technicalName**: *eq, sw* (optional) +const sorters: string = displayName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, technicalName** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listMachineAccountSubtypesV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## list-machine-accounts-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List machine accounts +This returns a list of machine accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-machine-accounts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = hasEntitlements eq true; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **uuid**: *eq, in* **description**: *eq, in, sw* **machineIdentity.id**: *eq, in* **machineIdentity.name**: *eq, in, sw* **subtype.technicalName**: *eq, in, sw* **subtype.displayName**: *eq, in, sw* **accessType**: *eq, in, sw* **environment**: *eq, in, sw* **ownerIdentity**: *eq, in* **ownerIdentity.id**: *eq, in* **ownerIdentity.name**: *eq, in, sw* **manuallyCorrelated**: *eq* **enabled**: *eq* **locked**: *eq* **hasEntitlements**: *eq* **attributes**: *eq* **source.id**: *eq, in* **source.name**: *eq, in, sw* **created**: *eq, gt, lt, ge, le* **modified**: *eq, gt, lt, ge, le* (optional) +const sorters: string = id,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, nativeIdentity, ownerIdentity, uuid, description, machineIdentity.id, machineIdentity.name, subtype.technicalName, subtype.displayName, accessType, environment, manuallyCorrelated, enabled, locked, hasEntitlements, ownerIdentity.id, ownerIdentity.name, attributes, source.id, source.name, created, modified** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listMachineAccountsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-machine-account-subtype-by-technical-name-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch subtype +Update fields of a machine account subtype by source ID and technical name. +Patchable fields include: `displayName`, `description`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-machine-account-subtype-by-technical-name-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the source. | [default to undefined] +**technicalName** | **string** | The technical name of the subtype. | [default to undefined] +**requestBody** | **Array<object>** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesubtypeV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const sourceId: string = 6d0458373bec4b4b80460992b76016da; // The ID of the source. +const technicalName: string = foo; // The technical name of the subtype. +const requestBody: Array<object> = [{"op":"replace","path":"/displayName","value":"Test New DisplayName"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchMachineAccountSubtypeByTechnicalNameV1(sourceId, technicalName, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## update-machine-account-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update machine account details +Use this API to update machine accounts details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-machine-account-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Machine Account ID. | [default to undefined] +**requestBody** | **Array<object>** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineaccountV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MachineAccountsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineAccountsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Account ID. +const requestBody: Array<object> = [{"op":"add","path":"/environment","value":"test"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateMachineAccountV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_accounts/docs/Models/Basecommondto.md b/sdk-output/machine_accounts/docs/Models/Basecommondto.md new file mode 100644 index 00000000..5459a0d0 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/machine_accounts/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/CreateMachineAccountSubtypeV1Request.md b/sdk-output/machine_accounts/docs/Models/CreateMachineAccountSubtypeV1Request.md new file mode 100644 index 00000000..edbf7d97 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/CreateMachineAccountSubtypeV1Request.md @@ -0,0 +1,22 @@ +--- +id: v1-create-machine-account-subtype-v1-request-v1 +title: CreateMachineAccountSubtypeV1RequestV1 +pagination_label: CreateMachineAccountSubtypeV1RequestV1 +sidebar_label: CreateMachineAccountSubtypeV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateMachineAccountSubtypeV1RequestV1', 'v1CreateMachineAccountSubtypeV1RequestV1'] +slug: /tools/sdk/typescript/machine_accounts/models/create-machine-account-subtype-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateMachineAccountSubtypeV1RequestV1', 'v1CreateMachineAccountSubtypeV1RequestV1'] +--- + +# CreateMachineAccountSubtypeV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**technicalName** | **string** | Technical name of the subtype. | [default to undefined] +**displayName** | **string** | Display name of the subtype. | [default to undefined] +**description** | **string** | Description of the subtype. | [default to undefined] +**type** | **(optional)** **string** | Type of the subtype. | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/Errormessagedto.md b/sdk-output/machine_accounts/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..4cfbb6a2 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_accounts/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/Errorresponsedto.md b/sdk-output/machine_accounts/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..bdadf361 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_accounts/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/Index.md b/sdk-output/machine_accounts/docs/Models/Index.md new file mode 100644 index 00000000..512bb28c --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_accounts-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_accounts-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_accounts', 'models'] +slug: /tools/sdk/typescript/machine_accounts/models +tags: ['SDK', 'Software Development Kit', 'machine_accounts', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1401Response.md b/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1401Response.md new file mode 100644 index 00000000..910752e9 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-accounts-v1401-response-v1 +title: ListMachineAccountsV1401ResponseV1 +pagination_label: ListMachineAccountsV1401ResponseV1 +sidebar_label: ListMachineAccountsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineAccountsV1401ResponseV1', 'v1ListMachineAccountsV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_accounts/models/list-machine-accounts-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineAccountsV1401ResponseV1', 'v1ListMachineAccountsV1401ResponseV1'] +--- + +# ListMachineAccountsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1429Response.md b/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1429Response.md new file mode 100644 index 00000000..f3e612ad --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/ListMachineAccountsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-accounts-v1429-response-v1 +title: ListMachineAccountsV1429ResponseV1 +pagination_label: ListMachineAccountsV1429ResponseV1 +sidebar_label: ListMachineAccountsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineAccountsV1429ResponseV1', 'v1ListMachineAccountsV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_accounts/models/list-machine-accounts-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineAccountsV1429ResponseV1', 'v1ListMachineAccountsV1429ResponseV1'] +--- + +# ListMachineAccountsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/Localeorigin.md b/sdk-output/machine_accounts/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a3a0469a --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_accounts/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_accounts/docs/Models/Machineaccount.md b/sdk-output/machine_accounts/docs/Models/Machineaccount.md new file mode 100644 index 00000000..39c1ee61 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Machineaccount.md @@ -0,0 +1,39 @@ +--- +id: v1-machineaccount-v1 +title: MachineaccountV1 +pagination_label: MachineaccountV1 +sidebar_label: MachineaccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineaccountV1', 'v1MachineaccountV1'] +slug: /tools/sdk/typescript/machine_accounts/models/machineaccount-v1 +tags: ['SDK', 'Software Development Kit', 'MachineaccountV1', 'v1MachineaccountV1'] +--- + +# MachineaccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**description** | **(optional)** **string** | A description of the machine account | [default to undefined] +**nativeIdentity** | **string** | The unique ID of the machine account generated by the source system | [default to undefined] +**uuid** | **(optional)** **string** | The unique ID of the account as determined by the account schema | [default to undefined] +**classificationMethod** | **string** | Classification Method | [default to undefined] +**machineIdentity** | **(optional)** **any** | The machine identity this account is associated with | [default to undefined] +**ownerIdentity** | **(optional)** **any** | The identity who owns this account. | [default to undefined] +**accessType** | **(optional)** **string** | The connection type of the source this account is from | [default to undefined] +**subtype** | **(optional)** **string** | The sub-type | [default to undefined] +**environment** | **(optional)** **string** | Environment | [default to undefined] +**attributes** | **(optional)** | Custom attributes specific to the machine account | [default to undefined] +**connectorAttributes** | | The connector attributes for the account | [default to undefined] +**manuallyCorrelated** | **(optional)** **boolean** | Indicates if the account has been manually correlated to an identity | [default to false] +**manuallyEdited** | **boolean** | Indicates if the account has been manually edited | [default to false] +**locked** | **boolean** | Indicates if the account is currently locked | [default to undefined] +**enabled** | **boolean** | Indicates if the account is enabled | [default to false] +**hasEntitlements** | **boolean** | Indicates if the account has entitlements | [default to true] +**source** | **any** | The source this machine account belongs to. | [default to undefined] + diff --git a/sdk-output/machine_accounts/docs/Models/README.md b/sdk-output/machine_accounts/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_accounts/docs/Models/Sourcesubtype.md b/sdk-output/machine_accounts/docs/Models/Sourcesubtype.md new file mode 100644 index 00000000..47cf3091 --- /dev/null +++ b/sdk-output/machine_accounts/docs/Models/Sourcesubtype.md @@ -0,0 +1,26 @@ +--- +id: v1-sourcesubtype-v1 +title: SourcesubtypeV1 +pagination_label: SourcesubtypeV1 +sidebar_label: SourcesubtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcesubtypeV1', 'v1SourcesubtypeV1'] +slug: /tools/sdk/typescript/machine_accounts/models/sourcesubtype-v1 +tags: ['SDK', 'Software Development Kit', 'SourcesubtypeV1', 'v1SourcesubtypeV1'] +--- + +# SourcesubtypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the subtype. | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source. | [readonly] [default to undefined] +**technicalName** | **string** | Technical name of the subtype. | [default to undefined] +**displayName** | **string** | Display name of the subtype. | [default to undefined] +**description** | **string** | Description of the subtype. | [default to undefined] +**created** | **(optional)** **string** | Creation timestamp. | [default to undefined] +**modified** | **(optional)** **string** | Last modified timestamp. | [default to undefined] +**type** | **(optional)** **string** | Type of the subtype. Either MACHINE OR null. | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_classification_config/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..57f689c5 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,46 @@ +- path: /sources/v1/{sourceId}/machine-classification-config + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_classification_config/methods/machine-classification-config#delete-machine-classification-config-v1 + source: | + import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineClassificationConfigV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const result = await apiInstance.deleteMachineClassificationConfigV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/machine-classification-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_classification_config/methods/machine-classification-config#get-machine-classification-config-v1 + source: | + import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineClassificationConfigV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID (default to undefined) + const result = await apiInstance.getMachineClassificationConfigV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/machine-classification-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_classification_config/methods/machine-classification-config#set-machine-classification-config-v1 + source: | + import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineClassificationConfigV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const machineclassificationconfigV1: MachineclassificationconfigV1 = ; // MachineclassificationconfigV1 | + const result = await apiInstance.setMachineClassificationConfigV1(sourceId, machineclassificationconfigV1); + console.log(result); diff --git a/sdk-output/machine_classification_config/docs/Methods/Index.md b/sdk-output/machine_classification_config/docs/Methods/Index.md new file mode 100644 index 00000000..d394f748 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_classification_config-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_classification_config-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_classification_config', 'methods'] +slug: /tools/sdk/typescript/machine_classification_config/methods +tags: ['SDK', 'Software Development Kit', 'machine_classification_config', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_classification_config/docs/Methods/MachineClassificationConfigV1Api.md b/sdk-output/machine_classification_config/docs/Methods/MachineClassificationConfigV1Api.md new file mode 100644 index 00000000..4a74e061 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Methods/MachineClassificationConfigV1Api.md @@ -0,0 +1,139 @@ +--- +id: v1-machine-classification-config +title: MachineClassificationConfig +pagination_label: MachineClassificationConfig +sidebar_label: MachineClassificationConfig +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineClassificationConfig', 'v1MachineClassificationConfig'] +slug: /tools/sdk/typescript/machine_classification_config/methods/machine-classification-config +tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'v1MachineClassificationConfig'] +--- + +# MachineClassificationConfigV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-machine-classification-config-v1**](#delete-machine-classification-config-v1) | **DELETE** `/sources/v1/{sourceId}/machine-classification-config` | Delete source\'s classification config +[**get-machine-classification-config-v1**](#get-machine-classification-config-v1) | **GET** `/sources/v1/{sourceId}/machine-classification-config` | Machine classification config for source +[**set-machine-classification-config-v1**](#set-machine-classification-config-v1) | **PUT** `/sources/v1/{sourceId}/machine-classification-config` | Update source\'s classification config + + +## delete-machine-classification-config-v1 +Delete source\'s classification config +Use this API to remove Classification Config for a Source. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-machine-classification-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineClassificationConfigV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const result = await apiInstance.deleteMachineClassificationConfigV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-classification-config-v1 +Machine classification config for source +This API returns a Machine Classification Config for a Source using Source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-classification-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID | [default to undefined] + +### Return type + +**MachineclassificationconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineClassificationConfigV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID +const result = await apiInstance.getMachineClassificationConfigV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## set-machine-classification-config-v1 +Update source\'s classification config +Use this API to update Classification Config for a Source. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-machine-classification-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**machineclassificationconfigV1** | **MachineclassificationconfigV1** | | + +### Return type + +**MachineclassificationconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineClassificationConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineClassificationConfigV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const machineclassificationconfigV1: MachineclassificationconfigV1 = ; // +const result = await apiInstance.setMachineClassificationConfigV1(sourceId, machineclassificationconfigV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_classification_config/docs/Models/Errormessagedto.md b/sdk-output/machine_classification_config/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..9d046abf --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Errorresponsedto.md b/sdk-output/machine_classification_config/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..591cde88 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1401Response.md b/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1401Response.md new file mode 100644 index 00000000..724c68e5 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-machine-classification-config-v1401-response-v1 +title: GetMachineClassificationConfigV1401ResponseV1 +pagination_label: GetMachineClassificationConfigV1401ResponseV1 +sidebar_label: GetMachineClassificationConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMachineClassificationConfigV1401ResponseV1', 'v1GetMachineClassificationConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/get-machine-classification-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMachineClassificationConfigV1401ResponseV1', 'v1GetMachineClassificationConfigV1401ResponseV1'] +--- + +# GetMachineClassificationConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1429Response.md b/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1429Response.md new file mode 100644 index 00000000..0b96bd97 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/GetMachineClassificationConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-machine-classification-config-v1429-response-v1 +title: GetMachineClassificationConfigV1429ResponseV1 +pagination_label: GetMachineClassificationConfigV1429ResponseV1 +sidebar_label: GetMachineClassificationConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMachineClassificationConfigV1429ResponseV1', 'v1GetMachineClassificationConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/get-machine-classification-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMachineClassificationConfigV1429ResponseV1', 'v1GetMachineClassificationConfigV1429ResponseV1'] +--- + +# GetMachineClassificationConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Index.md b/sdk-output/machine_classification_config/docs/Models/Index.md new file mode 100644 index 00000000..63ab030b --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_classification_config-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_classification_config-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_classification_config', 'models'] +slug: /tools/sdk/typescript/machine_classification_config/models +tags: ['SDK', 'Software Development Kit', 'machine_classification_config', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_classification_config/docs/Models/Localeorigin.md b/sdk-output/machine_classification_config/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a46555c4 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_classification_config/docs/Models/Machineclassificationconfig.md b/sdk-output/machine_classification_config/docs/Models/Machineclassificationconfig.md new file mode 100644 index 00000000..4fb5b3a8 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Machineclassificationconfig.md @@ -0,0 +1,23 @@ +--- +id: v1-machineclassificationconfig-v1 +title: MachineclassificationconfigV1 +pagination_label: MachineclassificationconfigV1 +sidebar_label: MachineclassificationconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineclassificationconfigV1', 'v1MachineclassificationconfigV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/machineclassificationconfig-v1 +tags: ['SDK', 'Software Development Kit', 'MachineclassificationconfigV1', 'v1MachineclassificationconfigV1'] +--- + +# MachineclassificationconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates whether Classification is enabled for a Source | [default to false] +**classificationMethod** | **(optional)** **string** | Classification Method | [default to undefined] +**criteria** | **(optional)** **Machineclassificationcriterialevel1V1** | | [default to undefined] +**created** | **(optional)** **string** | Date the config was created | [default to undefined] +**modified** | **(optional)** **string** | Date the config was last updated | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel1.md b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel1.md new file mode 100644 index 00000000..bfe44661 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel1.md @@ -0,0 +1,24 @@ +--- +id: v1-machineclassificationcriterialevel1-v1 +title: Machineclassificationcriterialevel1V1 +pagination_label: Machineclassificationcriterialevel1V1 +sidebar_label: Machineclassificationcriterialevel1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Machineclassificationcriterialevel1V1', 'v1Machineclassificationcriterialevel1V1'] +slug: /tools/sdk/typescript/machine_classification_config/models/machineclassificationcriterialevel1-v1 +tags: ['SDK', 'Software Development Kit', 'Machineclassificationcriterialevel1V1', 'v1Machineclassificationcriterialevel1V1'] +--- + +# Machineclassificationcriterialevel1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **MachineclassificationcriteriaoperationV1** | | [default to undefined] +**caseSensitive** | **(optional)** **boolean** | Indicates whether case matters when evaluating the criteria | [default to false] +**dataType** | **(optional)** **string** | The data type of the attribute being evaluated | [default to undefined] +**attribute** | **(optional)** **string** | The attribute to evaluate in the classification criteria | [default to undefined] +**value** | **(optional)** **string** | The value to compare against the attribute in the classification criteria | [default to undefined] +**children** | **(optional)** **Array<Machineclassificationcriterialevel2V1>** | An array of child classification criteria objects | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel2.md b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel2.md new file mode 100644 index 00000000..bb613d6f --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel2.md @@ -0,0 +1,24 @@ +--- +id: v1-machineclassificationcriterialevel2-v1 +title: Machineclassificationcriterialevel2V1 +pagination_label: Machineclassificationcriterialevel2V1 +sidebar_label: Machineclassificationcriterialevel2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Machineclassificationcriterialevel2V1', 'v1Machineclassificationcriterialevel2V1'] +slug: /tools/sdk/typescript/machine_classification_config/models/machineclassificationcriterialevel2-v1 +tags: ['SDK', 'Software Development Kit', 'Machineclassificationcriterialevel2V1', 'v1Machineclassificationcriterialevel2V1'] +--- + +# Machineclassificationcriterialevel2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **MachineclassificationcriteriaoperationV1** | | [default to undefined] +**caseSensitive** | **(optional)** **boolean** | Indicates whether case matters when evaluating the criteria | [default to false] +**dataType** | **(optional)** **string** | The data type of the attribute being evaluated | [default to undefined] +**attribute** | **(optional)** **string** | The attribute to evaluate in the classification criteria | [default to undefined] +**value** | **(optional)** **string** | The value to compare against the attribute in the classification criteria | [default to undefined] +**children** | **(optional)** **Array<Machineclassificationcriterialevel3V1>** | An array of child classification criteria objects | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel3.md b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel3.md new file mode 100644 index 00000000..6cad9d4a --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriterialevel3.md @@ -0,0 +1,24 @@ +--- +id: v1-machineclassificationcriterialevel3-v1 +title: Machineclassificationcriterialevel3V1 +pagination_label: Machineclassificationcriterialevel3V1 +sidebar_label: Machineclassificationcriterialevel3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Machineclassificationcriterialevel3V1', 'v1Machineclassificationcriterialevel3V1'] +slug: /tools/sdk/typescript/machine_classification_config/models/machineclassificationcriterialevel3-v1 +tags: ['SDK', 'Software Development Kit', 'Machineclassificationcriterialevel3V1', 'v1Machineclassificationcriterialevel3V1'] +--- + +# Machineclassificationcriterialevel3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **MachineclassificationcriteriaoperationV1** | | [default to undefined] +**caseSensitive** | **(optional)** **boolean** | Indicates whether or not case matters when evaluating the criteria | [default to false] +**dataType** | **(optional)** **string** | The data type of the attribute being evaluated | [default to undefined] +**attribute** | **(optional)** **string** | The attribute to evaluate in the classification criteria | [default to undefined] +**value** | **(optional)** **string** | The value to compare against the attribute in the classification criteria | [default to undefined] +**children** | **(optional)** **Array<object>** | An array of child classification criteria objects | [default to undefined] + diff --git a/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriteriaoperation.md b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriteriaoperation.md new file mode 100644 index 00000000..b956f56e --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/Machineclassificationcriteriaoperation.md @@ -0,0 +1,31 @@ +--- +id: v1-machineclassificationcriteriaoperation-v1 +title: MachineclassificationcriteriaoperationV1 +pagination_label: MachineclassificationcriteriaoperationV1 +sidebar_label: MachineclassificationcriteriaoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineclassificationcriteriaoperationV1', 'v1MachineclassificationcriteriaoperationV1'] +slug: /tools/sdk/typescript/machine_classification_config/models/machineclassificationcriteriaoperation-v1 +tags: ['SDK', 'Software Development Kit', 'MachineclassificationcriteriaoperationV1', 'v1MachineclassificationcriteriaoperationV1'] +--- + +# MachineclassificationcriteriaoperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `NotEquals` (value: `'NOT_EQUALS'`) + +* `StartsWith` (value: `'STARTS_WITH'`) + +* `EndsWith` (value: `'ENDS_WITH'`) + +* `Contains` (value: `'CONTAINS'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/machine_classification_config/docs/Models/README.md b/sdk-output/machine_classification_config/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_classification_config/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_identities/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/machine_identities/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..49b6be4c --- /dev/null +++ b/sdk-output/machine_identities/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,122 @@ +- path: /machine-identities/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#create-machine-identity-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const machineidentityrequestV1: MachineidentityrequestV1 = ; // MachineidentityrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createMachineIdentityV1(machineidentityrequestV1); + console.log(result); +- path: /machine-identities/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#delete-machine-identity-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteMachineIdentityV1(id); + console.log(result); +- path: /machine-identities/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#get-machine-identity-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getMachineIdentityV1(id); + console.log(result); +- path: /machine-identities/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#list-machine-identities-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const filters: string = 'identityId eq "2c9180858082150f0180893dbaf44201"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional) (default to undefined) + const sorters: string = 'nativeIdentity'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listMachineIdentitiesV1(); + console.log(result); +- path: /machine-identity-user-entitlements/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#list-machine-identity-user-entitlements-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const filters: string = 'machineIdentityId eq "2c9180858082150f0180893dbaf44201"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* (optional) (default to undefined) + const sorters: string = 'machineIdentityName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **machineIdentityName, entitlement.name, source.name** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listMachineIdentityUserEntitlementsV1(); + console.log(result); +- path: /sources/v1/{sourceId}/aggregate-agents + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#start-machine-identity-aggregation-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source ID. (default to undefined) + const machineidentityaggregationrequestV1: MachineidentityaggregationrequestV1 = ; // MachineidentityaggregationrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.startMachineIdentityAggregationV1(sourceId, machineidentityaggregationrequestV1); + console.log(result); +- path: /machine-identities/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/machine_identities/methods/machine-identities#update-machine-identity-v1 + source: | + import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MachineIdentitiesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Machine Identity ID. (default to undefined) + const requestBody: Array<object> = [{"op":"add","path":"/attributes/securityRisk","value":"medium"}]; // Array | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateMachineIdentityV1(id, requestBody); + console.log(result); diff --git a/sdk-output/machine_identities/docs/Methods/Index.md b/sdk-output/machine_identities/docs/Methods/Index.md new file mode 100644 index 00000000..c2ade4d2 --- /dev/null +++ b/sdk-output/machine_identities/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: machine_identities-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: machine_identities-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_identities', 'methods'] +slug: /tools/sdk/typescript/machine_identities/methods +tags: ['SDK', 'Software Development Kit', 'machine_identities', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/machine_identities/docs/Methods/MachineIdentitiesV1Api.md b/sdk-output/machine_identities/docs/Methods/MachineIdentitiesV1Api.md new file mode 100644 index 00000000..f3fd7e50 --- /dev/null +++ b/sdk-output/machine_identities/docs/Methods/MachineIdentitiesV1Api.md @@ -0,0 +1,349 @@ +--- +id: v1-machine-identities +title: MachineIdentities +pagination_label: MachineIdentities +sidebar_label: MachineIdentities +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentities', 'v1MachineIdentities'] +slug: /tools/sdk/typescript/machine_identities/methods/machine-identities +tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'v1MachineIdentities'] +--- + +# MachineIdentitiesV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-machine-identity-v1**](#create-machine-identity-v1) | **POST** `/machine-identities/v1` | Create machine identity +[**delete-machine-identity-v1**](#delete-machine-identity-v1) | **DELETE** `/machine-identities/v1/{id}` | Delete machine identity +[**get-machine-identity-v1**](#get-machine-identity-v1) | **GET** `/machine-identities/v1/{id}` | Get machine identity details +[**list-machine-identities-v1**](#list-machine-identities-v1) | **GET** `/machine-identities/v1` | List machine identities +[**list-machine-identity-user-entitlements-v1**](#list-machine-identity-user-entitlements-v1) | **GET** `/machine-identity-user-entitlements/v1` | List machine identity\'s user entitlements +[**start-machine-identity-aggregation-v1**](#start-machine-identity-aggregation-v1) | **POST** `/sources/v1/{sourceId}/aggregate-agents` | Start machine identity aggregation +[**update-machine-identity-v1**](#update-machine-identity-v1) | **PATCH** `/machine-identities/v1/{id}` | Update machine identity details + + +## create-machine-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create machine identity +Use this API to create a machine identity. +The maximum supported length for the description field is 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-machine-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**machineidentityrequestV1** | **MachineidentityrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineidentityresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const machineidentityrequestV1: MachineidentityrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createMachineIdentityV1(machineidentityrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-machine-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete machine identity +The API returns successful response if the requested machine identity was deleted. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-machine-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Machine Identity ID | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteMachineIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get machine identity details +This API returns a single machine identity using the Machine Identity ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Machine Identity ID | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineidentityresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getMachineIdentityV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-machine-identities-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List machine identities +This API returns a list of machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-machine-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const filters: string = identityId eq "2c9180858082150f0180893dbaf44201"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* **subtype**: *eq, in* **owners.primaryIdentity.id**: *eq, in, sw* **owners.primaryIdentity.name**: *eq, in, isnull, pr* **owners.secondaryIdentity.id**: *eq, in, sw* **owners.secondaryIdentity.name**: *eq, in, isnull, pr* **source.name**: *eq, in, sw* **source.id**: *eq, in* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* (optional) +const sorters: string = nativeIdentity; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **nativeIdentity, name, owners.primaryIdentity.name, source.name, created, modified** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listMachineIdentitiesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-machine-identity-user-entitlements-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List machine identity\'s user entitlements +This API returns a list of user entitlements associated with machine identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-machine-identity-user-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **machineIdentityName, entitlement.name, source.name** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const filters: string = machineIdentityId eq "2c9180858082150f0180893dbaf44201"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **machineIdentityId**: *eq, in* **machineIdentityName**: *eq, in, sw* **entitlement.id**: *eq, in* **entitlement.name**: *eq, in, sw* **source.id**: *eq, in* **source.name**: *eq, in, sw* (optional) +const sorters: string = machineIdentityName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **machineIdentityName, entitlement.name, source.name** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listMachineIdentityUserEntitlementsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## start-machine-identity-aggregation-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Start machine identity aggregation +Starts a machine identity (AI Agents) aggregation on the specified source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-machine-identity-aggregation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**machineidentityaggregationrequestV1** | **MachineidentityaggregationrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineidentityaggregationresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source ID. +const machineidentityaggregationrequestV1: MachineidentityaggregationrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.startMachineIdentityAggregationV1(sourceId, machineidentityaggregationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-machine-identity-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update machine identity details +Use this API to update machine identity details. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-machine-identity-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Machine Identity ID. | [default to undefined] +**requestBody** | **Array<object>** | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**MachineidentityresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MachineIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MachineIdentitiesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Machine Identity ID. +const requestBody: Array<object> = [{"op":"add","path":"/attributes/securityRisk","value":"medium"}]; // A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateMachineIdentityV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/machine_identities/docs/Models/Basecommondto.md b/sdk-output/machine_identities/docs/Models/Basecommondto.md new file mode 100644 index 00000000..4a875f91 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/machine_identities/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Basereferencedto.md b/sdk-output/machine_identities/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..03ee6c8e --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/machine_identities/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Dtotype.md b/sdk-output/machine_identities/docs/Models/Dtotype.md new file mode 100644 index 00000000..111144ff --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/machine_identities/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/machine_identities/docs/Models/Errormessagedto.md b/sdk-output/machine_identities/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..63e07b4e --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/machine_identities/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Errorresponsedto.md b/sdk-output/machine_identities/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f163fc1a --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/machine_identities/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Index.md b/sdk-output/machine_identities/docs/Models/Index.md new file mode 100644 index 00000000..d830f2b4 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: machine_identities-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: machine_identities-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'machine_identities', 'models'] +slug: /tools/sdk/typescript/machine_identities/models +tags: ['SDK', 'Software Development Kit', 'machine_identities', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1401Response.md b/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1401Response.md new file mode 100644 index 00000000..3f08b452 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-identities-v1401-response-v1 +title: ListMachineIdentitiesV1401ResponseV1 +pagination_label: ListMachineIdentitiesV1401ResponseV1 +sidebar_label: ListMachineIdentitiesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineIdentitiesV1401ResponseV1', 'v1ListMachineIdentitiesV1401ResponseV1'] +slug: /tools/sdk/typescript/machine_identities/models/list-machine-identities-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineIdentitiesV1401ResponseV1', 'v1ListMachineIdentitiesV1401ResponseV1'] +--- + +# ListMachineIdentitiesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1429Response.md b/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1429Response.md new file mode 100644 index 00000000..d0dc414a --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/ListMachineIdentitiesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-machine-identities-v1429-response-v1 +title: ListMachineIdentitiesV1429ResponseV1 +pagination_label: ListMachineIdentitiesV1429ResponseV1 +sidebar_label: ListMachineIdentitiesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListMachineIdentitiesV1429ResponseV1', 'v1ListMachineIdentitiesV1429ResponseV1'] +slug: /tools/sdk/typescript/machine_identities/models/list-machine-identities-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListMachineIdentitiesV1429ResponseV1', 'v1ListMachineIdentitiesV1429ResponseV1'] +--- + +# ListMachineIdentitiesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Localeorigin.md b/sdk-output/machine_identities/docs/Models/Localeorigin.md new file mode 100644 index 00000000..725d8006 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/machine_identities/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/machine_identities/docs/Models/Localizedmessage.md b/sdk-output/machine_identities/docs/Models/Localizedmessage.md new file mode 100644 index 00000000..610487e0 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Localizedmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-localizedmessage-v1 +title: LocalizedmessageV1 +pagination_label: LocalizedmessageV1 +sidebar_label: LocalizedmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +slug: /tools/sdk/typescript/machine_identities/models/localizedmessage-v1 +tags: ['SDK', 'Software Development Kit', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +--- + +# LocalizedmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **string** | Message locale | [default to undefined] +**message** | **string** | Message text | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineIdentityDtoOwners.md b/sdk-output/machine_identities/docs/Models/MachineIdentityDtoOwners.md new file mode 100644 index 00000000..92ea3345 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineIdentityDtoOwners.md @@ -0,0 +1,20 @@ +--- +id: v1-machine-identity-dto-owners-v1 +title: MachineIdentityDtoOwnersV1 +pagination_label: MachineIdentityDtoOwnersV1 +sidebar_label: MachineIdentityDtoOwnersV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentityDtoOwnersV1', 'v1MachineIdentityDtoOwnersV1'] +slug: /tools/sdk/typescript/machine_identities/models/machine-identity-dto-owners-v1 +tags: ['SDK', 'Software Development Kit', 'MachineIdentityDtoOwnersV1', 'v1MachineIdentityDtoOwnersV1'] +--- + +# MachineIdentityDtoOwnersV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**primaryIdentity** | **object** | Defines the identity which is selected as the primary owner | [default to undefined] +**secondaryIdentities** | **Array<BasereferencedtoV1>** | Defines the identities which are selected as secondary owners | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineIdentityRequestUserEntitlements.md b/sdk-output/machine_identities/docs/Models/MachineIdentityRequestUserEntitlements.md new file mode 100644 index 00000000..6775ed20 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineIdentityRequestUserEntitlements.md @@ -0,0 +1,20 @@ +--- +id: v1-machine-identity-request-user-entitlements-v1 +title: MachineIdentityRequestUserEntitlementsV1 +pagination_label: MachineIdentityRequestUserEntitlementsV1 +sidebar_label: MachineIdentityRequestUserEntitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentityRequestUserEntitlementsV1', 'v1MachineIdentityRequestUserEntitlementsV1'] +slug: /tools/sdk/typescript/machine_identities/models/machine-identity-request-user-entitlements-v1 +tags: ['SDK', 'Software Development Kit', 'MachineIdentityRequestUserEntitlementsV1', 'v1MachineIdentityRequestUserEntitlementsV1'] +--- + +# MachineIdentityRequestUserEntitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementId** | **string** | The ID of the entitlement | [default to undefined] +**sourceId** | **string** | The source ID of the entitlement | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineIdentityResponseUserEntitlements.md b/sdk-output/machine_identities/docs/Models/MachineIdentityResponseUserEntitlements.md new file mode 100644 index 00000000..a72013b6 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineIdentityResponseUserEntitlements.md @@ -0,0 +1,22 @@ +--- +id: v1-machine-identity-response-user-entitlements-v1 +title: MachineIdentityResponseUserEntitlementsV1 +pagination_label: MachineIdentityResponseUserEntitlementsV1 +sidebar_label: MachineIdentityResponseUserEntitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineIdentityResponseUserEntitlementsV1', 'v1MachineIdentityResponseUserEntitlementsV1'] +slug: /tools/sdk/typescript/machine_identities/models/machine-identity-response-user-entitlements-v1 +tags: ['SDK', 'Software Development Kit', 'MachineIdentityResponseUserEntitlementsV1', 'v1MachineIdentityResponseUserEntitlementsV1'] +--- + +# MachineIdentityResponseUserEntitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **(optional)** **string** | The source ID of the entitlement | [default to undefined] +**entitlementId** | **(optional)** **string** | The ID of the entitlement | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the entitlement | [default to undefined] +**source** | **(optional)** **object** | The source of the entitlement | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentity.md b/sdk-output/machine_identities/docs/Models/Machineidentity.md new file mode 100644 index 00000000..0226f2ea --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentity.md @@ -0,0 +1,29 @@ +--- +id: v1-machineidentity-v1 +title: MachineidentityV1 +pagination_label: MachineidentityV1 +sidebar_label: MachineidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityV1', 'v1MachineidentityV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentity-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityV1', 'v1MachineidentityV1'] +--- + +# MachineidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**nativeIdentity** | **string** | The native identity associated to the machine identity directly aggregated from a source | [default to undefined] +**description** | **(optional)** **string** | Description of machine identity | [default to undefined] +**attributes** | **(optional)** **object** | A map of custom machine identity attributes | [default to undefined] +**subtype** | **string** | The subtype value associated to the machine identity | [default to undefined] +**owners** | **(optional)** **MachineIdentityDtoOwnersV1** | | [default to undefined] +**sourceId** | **(optional)** **string** | The source id associated to the machine identity | [default to undefined] +**uuid** | **(optional)** **string** | The UUID associated to the machine identity directly aggregated from a source | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentityaggregationrequest.md b/sdk-output/machine_identities/docs/Models/Machineidentityaggregationrequest.md new file mode 100644 index 00000000..58594097 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentityaggregationrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-machineidentityaggregationrequest-v1 +title: MachineidentityaggregationrequestV1 +pagination_label: MachineidentityaggregationrequestV1 +sidebar_label: MachineidentityaggregationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityaggregationrequestV1', 'v1MachineidentityaggregationrequestV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityaggregationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityaggregationrequestV1', 'v1MachineidentityaggregationrequestV1'] +--- + +# MachineidentityaggregationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**datasetIds** | **Array<string>** | List of dataset Ids to aggregate machine identities | [default to undefined] +**disableOptimization** | **(optional)** **boolean** | Flag to disable optimization for the aggregation. Defaults to false when not provided. When set to true, it disables aggregation optimizations and may increase processing time. | [default to false] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentityaggregationresponse.md b/sdk-output/machine_identities/docs/Models/Machineidentityaggregationresponse.md new file mode 100644 index 00000000..cc6fee24 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentityaggregationresponse.md @@ -0,0 +1,36 @@ +--- +id: v1-machineidentityaggregationresponse-v1 +title: MachineidentityaggregationresponseV1 +pagination_label: MachineidentityaggregationresponseV1 +sidebar_label: MachineidentityaggregationresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityaggregationresponseV1', 'v1MachineidentityaggregationresponseV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityaggregationresponse-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityaggregationresponseV1', 'v1MachineidentityaggregationresponseV1'] +--- + +# MachineidentityaggregationresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [default to undefined] +**type** | **(optional)** **string** | Type of task for aggregation | [default to undefined] +**uniqueName** | **(optional)** **string** | Name of the task for aggregation | [default to undefined] +**description** | **(optional)** **string** | Description of the aggregation | [default to undefined] +**parentName** | **(optional)** **string** | Name of the parent of the task for aggregation | [default to undefined] +**launcher** | **(optional)** **string** | Service to execute the aggregation | [default to undefined] +**target** | **(optional)** **MachineidentityaggregationresponseTargetV1** | | [default to undefined] +**created** | **(optional)** **string** | Creation date of the aggregation | [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the aggregation | [default to undefined] +**launched** | **(optional)** **string** | Launch date of the aggregation | [default to undefined] +**completed** | **(optional)** **string** | Completion date of the aggregation | [default to undefined] +**taskDefinitionSummary** | **(optional)** **TaskdefinitionsummaryV1** | | [default to undefined] +**completionStatus** | **(optional)** **string** | Completion status of the aggregation | [default to undefined] +**messages** | **(optional)** **Array<TaskstatusmessageV1>** | Messages associated with the aggregation | [default to undefined] +**returns** | **(optional)** **Array<TaskreturndetailsV1>** | Return values associated with the aggregation | [default to undefined] +**attributes** | **(optional)** | Attributes of the aggregation | [default to undefined] +**progress** | **(optional)** **string** | Current progress of aggregation | [default to undefined] +**percentComplete** | **(optional)** **number** | Current percentage completion of aggregation | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineidentityaggregationresponseTarget.md b/sdk-output/machine_identities/docs/Models/MachineidentityaggregationresponseTarget.md new file mode 100644 index 00000000..9592f47f --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineidentityaggregationresponseTarget.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityaggregationresponse-target-v1 +title: MachineidentityaggregationresponseTargetV1 +pagination_label: MachineidentityaggregationresponseTargetV1 +sidebar_label: MachineidentityaggregationresponseTargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityaggregationresponseTargetV1', 'v1MachineidentityaggregationresponseTargetV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityaggregationresponse-target-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityaggregationresponseTargetV1', 'v1MachineidentityaggregationresponseTargetV1'] +--- + +# MachineidentityaggregationresponseTargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentityrequest.md b/sdk-output/machine_identities/docs/Models/Machineidentityrequest.md new file mode 100644 index 00000000..ddcbf7a5 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentityrequest.md @@ -0,0 +1,30 @@ +--- +id: v1-machineidentityrequest-v1 +title: MachineidentityrequestV1 +pagination_label: MachineidentityrequestV1 +sidebar_label: MachineidentityrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityrequestV1', 'v1MachineidentityrequestV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityrequest-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityrequestV1', 'v1MachineidentityrequestV1'] +--- + +# MachineidentityrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**nativeIdentity** | **string** | The native identity associated to the machine identity directly aggregated from a source | [default to undefined] +**description** | **(optional)** **string** | Description of machine identity | [default to undefined] +**attributes** | **(optional)** **object** | A map of custom machine identity attributes | [default to undefined] +**subtype** | **string** | The subtype value associated to the machine identity | [default to undefined] +**owners** | **(optional)** **MachineIdentityDtoOwnersV1** | | [default to undefined] +**sourceId** | **(optional)** **string** | The source id associated to the machine identity | [default to undefined] +**uuid** | **(optional)** **string** | The UUID associated to the machine identity directly aggregated from a source | [default to undefined] +**userEntitlements** | **(optional)** **Array<MachineIdentityRequestUserEntitlementsV1>** | The user entitlements associated to the machine identity | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentityresponse.md b/sdk-output/machine_identities/docs/Models/Machineidentityresponse.md new file mode 100644 index 00000000..e69ca511 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentityresponse.md @@ -0,0 +1,34 @@ +--- +id: v1-machineidentityresponse-v1 +title: MachineidentityresponseV1 +pagination_label: MachineidentityresponseV1 +sidebar_label: MachineidentityresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityresponseV1', 'v1MachineidentityresponseV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityresponse-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityresponseV1', 'v1MachineidentityresponseV1'] +--- + +# MachineidentityresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**nativeIdentity** | **string** | The native identity associated to the machine identity directly aggregated from a source | [default to undefined] +**description** | **(optional)** **string** | Description of machine identity | [default to undefined] +**attributes** | **(optional)** **object** | A map of custom machine identity attributes | [default to undefined] +**subtype** | **string** | The subtype value associated to the machine identity | [default to undefined] +**owners** | **(optional)** **MachineIdentityDtoOwnersV1** | | [default to undefined] +**sourceId** | **(optional)** **string** | The source id associated to the machine identity | [default to undefined] +**uuid** | **(optional)** **string** | The UUID associated to the machine identity directly aggregated from a source | [default to undefined] +**manuallyEdited** | **(optional)** **boolean** | Indicates if the machine identity has been manually edited | [default to false] +**manuallyCreated** | **(optional)** **boolean** | Indicates if the machine identity has been manually created | [default to false] +**source** | **(optional)** **object** | The source of the machine identity | [default to undefined] +**datasetId** | **(optional)** **string** | The dataset id associated to the source in which the identity was retrieved from | [default to undefined] +**userEntitlements** | **(optional)** **Array<MachineIdentityResponseUserEntitlementsV1>** | The user entitlements associated to the machine identity | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Machineidentityuserentitlementresponse.md b/sdk-output/machine_identities/docs/Models/Machineidentityuserentitlementresponse.md new file mode 100644 index 00000000..3b6eaa28 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Machineidentityuserentitlementresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-machineidentityuserentitlementresponse-v1 +title: MachineidentityuserentitlementresponseV1 +pagination_label: MachineidentityuserentitlementresponseV1 +sidebar_label: MachineidentityuserentitlementresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityuserentitlementresponseV1', 'v1MachineidentityuserentitlementresponseV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityuserentitlementresponse-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityuserentitlementresponseV1', 'v1MachineidentityuserentitlementresponseV1'] +--- + +# MachineidentityuserentitlementresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [default to undefined] +**machineIdentityId** | **(optional)** **string** | System-generated unique ID of the Machine Identity | [default to undefined] +**source** | **(optional)** **MachineidentityuserentitlementresponseSourceV1** | | [default to undefined] +**entitlement** | **(optional)** **MachineidentityuserentitlementresponseEntitlementV1** | | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseEntitlement.md b/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseEntitlement.md new file mode 100644 index 00000000..81398dd3 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseEntitlement.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityuserentitlementresponse-entitlement-v1 +title: MachineidentityuserentitlementresponseEntitlementV1 +pagination_label: MachineidentityuserentitlementresponseEntitlementV1 +sidebar_label: MachineidentityuserentitlementresponseEntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityuserentitlementresponseEntitlementV1', 'v1MachineidentityuserentitlementresponseEntitlementV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityuserentitlementresponse-entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityuserentitlementresponseEntitlementV1', 'v1MachineidentityuserentitlementresponseEntitlementV1'] +--- + +# MachineidentityuserentitlementresponseEntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseSource.md b/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseSource.md new file mode 100644 index 00000000..367cf652 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/MachineidentityuserentitlementresponseSource.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityuserentitlementresponse-source-v1 +title: MachineidentityuserentitlementresponseSourceV1 +pagination_label: MachineidentityuserentitlementresponseSourceV1 +sidebar_label: MachineidentityuserentitlementresponseSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityuserentitlementresponseSourceV1', 'v1MachineidentityuserentitlementresponseSourceV1'] +slug: /tools/sdk/typescript/machine_identities/models/machineidentityuserentitlementresponse-source-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityuserentitlementresponseSourceV1', 'v1MachineidentityuserentitlementresponseSourceV1'] +--- + +# MachineidentityuserentitlementresponseSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/README.md b/sdk-output/machine_identities/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/machine_identities/docs/Models/Taskdefinitionsummary.md b/sdk-output/machine_identities/docs/Models/Taskdefinitionsummary.md new file mode 100644 index 00000000..c44e9c5a --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Taskdefinitionsummary.md @@ -0,0 +1,24 @@ +--- +id: v1-taskdefinitionsummary-v1 +title: TaskdefinitionsummaryV1 +pagination_label: TaskdefinitionsummaryV1 +sidebar_label: TaskdefinitionsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +slug: /tools/sdk/typescript/machine_identities/models/taskdefinitionsummary-v1 +tags: ['SDK', 'Software Development Kit', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +--- + +# TaskdefinitionsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the TaskDefinition | [default to undefined] +**uniqueName** | **string** | Name of the TaskDefinition | [default to undefined] +**description** | **string** | Description of the TaskDefinition | [default to undefined] +**parentName** | **string** | Name of the parent of the TaskDefinition | [default to undefined] +**executor** | **string** | Executor of the TaskDefinition | [default to undefined] +**arguments** | | Formal parameters of the TaskDefinition, without values | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Taskreturndetails.md b/sdk-output/machine_identities/docs/Models/Taskreturndetails.md new file mode 100644 index 00000000..1676e1fa --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Taskreturndetails.md @@ -0,0 +1,20 @@ +--- +id: v1-taskreturndetails-v1 +title: TaskreturndetailsV1 +pagination_label: TaskreturndetailsV1 +sidebar_label: TaskreturndetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +slug: /tools/sdk/typescript/machine_identities/models/taskreturndetails-v1 +tags: ['SDK', 'Software Development Kit', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +--- + +# TaskreturndetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Display name of the TaskReturnDetails | [default to undefined] +**attributeName** | **string** | Attribute the TaskReturnDetails is for | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/Taskstatusmessage.md b/sdk-output/machine_identities/docs/Models/Taskstatusmessage.md new file mode 100644 index 00000000..17417b03 --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/Taskstatusmessage.md @@ -0,0 +1,22 @@ +--- +id: v1-taskstatusmessage-v1 +title: TaskstatusmessageV1 +pagination_label: TaskstatusmessageV1 +sidebar_label: TaskstatusmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +slug: /tools/sdk/typescript/machine_identities/models/taskstatusmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +--- + +# TaskstatusmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of the message | [default to undefined] +**localizedText** | **LocalizedmessageV1** | | [default to undefined] +**key** | **string** | Key of the message | [default to undefined] +**parameters** | **Array<TaskstatusmessageParametersInnerV1>** | Message parameters for internationalization | [default to undefined] + diff --git a/sdk-output/machine_identities/docs/Models/TaskstatusmessageParametersInner.md b/sdk-output/machine_identities/docs/Models/TaskstatusmessageParametersInner.md new file mode 100644 index 00000000..2ab718ff --- /dev/null +++ b/sdk-output/machine_identities/docs/Models/TaskstatusmessageParametersInner.md @@ -0,0 +1,18 @@ +--- +id: v1-taskstatusmessage-parameters-inner-v1 +title: TaskstatusmessageParametersInnerV1 +pagination_label: TaskstatusmessageParametersInnerV1 +sidebar_label: TaskstatusmessageParametersInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +slug: /tools/sdk/typescript/machine_identities/models/taskstatusmessage-parameters-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +--- + +# TaskstatusmessageParametersInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_clients/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/managed_clients/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a8d88913 --- /dev/null +++ b/sdk-output/managed_clients/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,110 @@ +- path: /managed-clients/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#create-managed-client-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const managedclientrequestV1: ManagedclientrequestV1 = ; // ManagedclientrequestV1 | + const result = await apiInstance.createManagedClientV1(managedclientrequestV1); + console.log(result); +- path: /managed-clients/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#delete-managed-client-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const id: string = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7'; // string | Managed client ID. (default to undefined) + const result = await apiInstance.deleteManagedClientV1(id); + console.log(result); +- path: /managed-clients/v1/{id}/health-indicators + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#get-managed-client-health-indicators-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const id: string = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7'; // string | Managed client ID to get health indicators for. (default to undefined) + const result = await apiInstance.getManagedClientHealthIndicatorsV1(id); + console.log(result); +- path: /managed-clients/v1/{id}/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#get-managed-client-status-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const id: string = 'aClientId'; // string | Managed client ID to get status for. (default to undefined) + const type: ManagedclienttypeV1 = ; // ManagedclienttypeV1 | Managed client type to get status for. (default to undefined) + const result = await apiInstance.getManagedClientStatusV1(id, type); + console.log(result); +- path: /managed-clients/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#get-managed-client-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const id: string = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7'; // string | Managed client ID. (default to undefined) + const result = await apiInstance.getManagedClientV1(id); + console.log(result); +- path: /managed-clients/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#get-managed-clients-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq "client name"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) (default to undefined) + const result = await apiInstance.getManagedClientsV1(); + console.log(result); +- path: /managed-clients/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clients/methods/managed-clients#update-managed-client-v1 + source: | + import { ManagedClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClientsV1Api(configuration); + const id: string = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7'; // string | Managed client ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | JSONPatch payload used to update the object. + const result = await apiInstance.updateManagedClientV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/managed_clients/docs/Methods/Index.md b/sdk-output/managed_clients/docs/Methods/Index.md new file mode 100644 index 00000000..e7e31ac8 --- /dev/null +++ b/sdk-output/managed_clients/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: managed_clients-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: managed_clients-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_clients', 'methods'] +slug: /tools/sdk/typescript/managed_clients/methods +tags: ['SDK', 'Software Development Kit', 'managed_clients', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/managed_clients/docs/Methods/ManagedClientsV1Api.md b/sdk-output/managed_clients/docs/Methods/ManagedClientsV1Api.md new file mode 100644 index 00000000..f7c530a4 --- /dev/null +++ b/sdk-output/managed_clients/docs/Methods/ManagedClientsV1Api.md @@ -0,0 +1,305 @@ +--- +id: v1-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedClients', 'v1ManagedClients'] +slug: /tools/sdk/typescript/managed_clients/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'v1ManagedClients'] +--- + +# ManagedClientsV1Api + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-client-v1**](#create-managed-client-v1) | **POST** `/managed-clients/v1` | Create managed client +[**delete-managed-client-v1**](#delete-managed-client-v1) | **DELETE** `/managed-clients/v1/{id}` | Delete managed client +[**get-managed-client-health-indicators-v1**](#get-managed-client-health-indicators-v1) | **GET** `/managed-clients/v1/{id}/health-indicators` | Get managed client health indicators +[**get-managed-client-status-v1**](#get-managed-client-status-v1) | **GET** `/managed-clients/v1/{id}/status` | Get managed client status +[**get-managed-client-v1**](#get-managed-client-v1) | **GET** `/managed-clients/v1/{id}` | Get managed client +[**get-managed-clients-v1**](#get-managed-clients-v1) | **GET** `/managed-clients/v1` | Get managed clients +[**update-managed-client-v1**](#update-managed-client-v1) | **PATCH** `/managed-clients/v1/{id}` | Update managed client + + +## create-managed-client-v1 +Create managed client +Create a new managed client. +The API returns a result that includes the managed client ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-managed-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**managedclientrequestV1** | **ManagedclientrequestV1** | | + +### Return type + +**ManagedclientV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const managedclientrequestV1: ManagedclientrequestV1 = ; // +const result = await apiInstance.createManagedClientV1(managedclientrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-managed-client-v1 +Delete managed client +Delete an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-managed-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed client ID. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID. +const result = await apiInstance.deleteManagedClientV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-client-health-indicators-v1 +Get managed client health indicators +Get a managed client's health indicators, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-client-health-indicators-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed client ID to get health indicators for. | [default to undefined] + +### Return type + +**ManagedclienthealthindicatorsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID to get health indicators for. +const result = await apiInstance.getManagedClientHealthIndicatorsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-client-status-v1 +Get managed client status +Get a managed client's status, using its ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-client-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed client ID to get status for. | [default to undefined] +**type** | **ManagedclienttypeV1** | Managed client type to get status for. | [default to undefined] + +### Return type + +**ManagedclientstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const id: string = aClientId; // Managed client ID to get status for. +const type: ManagedclienttypeV1 = ; // Managed client type to get status for. +const result = await apiInstance.getManagedClientStatusV1(id, type); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-client-v1 +Get managed client +Get managed client by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed client ID. | [default to undefined] + +### Return type + +**ManagedclientV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID. +const result = await apiInstance.getManagedClientV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-clients-v1 +Get managed clients +List managed clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-clients-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "client name"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) +const result = await apiInstance.getManagedClientsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-managed-client-v1 +Update managed client +Update an existing managed client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-managed-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed client ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | JSONPatch payload used to update the object. | + +### Return type + +**ManagedclientV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClientsV1Api(configuration); +const id: string = 4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7; // Managed client ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // JSONPatch payload used to update the object. +const result = await apiInstance.updateManagedClientV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/managed_clients/docs/Models/ArrayInner.md b/sdk-output/managed_clients/docs/Models/ArrayInner.md new file mode 100644 index 00000000..30cd54d4 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/managed_clients/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_clients/docs/Models/Errormessagedto.md b/sdk-output/managed_clients/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8ea69458 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/managed_clients/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Errorresponsedto.md b/sdk-output/managed_clients/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e2e8de02 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/managed_clients/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/GetManagedClientsV1401Response.md b/sdk-output/managed_clients/docs/Models/GetManagedClientsV1401Response.md new file mode 100644 index 00000000..2ed53483 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/GetManagedClientsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-clients-v1401-response-v1 +title: GetManagedClientsV1401ResponseV1 +pagination_label: GetManagedClientsV1401ResponseV1 +sidebar_label: GetManagedClientsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClientsV1401ResponseV1', 'v1GetManagedClientsV1401ResponseV1'] +slug: /tools/sdk/typescript/managed_clients/models/get-managed-clients-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClientsV1401ResponseV1', 'v1GetManagedClientsV1401ResponseV1'] +--- + +# GetManagedClientsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/GetManagedClientsV1429Response.md b/sdk-output/managed_clients/docs/Models/GetManagedClientsV1429Response.md new file mode 100644 index 00000000..80cbe075 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/GetManagedClientsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-clients-v1429-response-v1 +title: GetManagedClientsV1429ResponseV1 +pagination_label: GetManagedClientsV1429ResponseV1 +sidebar_label: GetManagedClientsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClientsV1429ResponseV1', 'v1GetManagedClientsV1429ResponseV1'] +slug: /tools/sdk/typescript/managed_clients/models/get-managed-clients-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClientsV1429ResponseV1', 'v1GetManagedClientsV1429ResponseV1'] +--- + +# GetManagedClientsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Healthevent.md b/sdk-output/managed_clients/docs/Models/Healthevent.md new file mode 100644 index 00000000..7dd86fb5 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Healthevent.md @@ -0,0 +1,25 @@ +--- +id: v1-healthevent-v1 +title: HealtheventV1 +pagination_label: HealtheventV1 +sidebar_label: HealtheventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HealtheventV1', 'v1HealtheventV1'] +slug: /tools/sdk/typescript/managed_clients/models/healthevent-v1 +tags: ['SDK', 'Software Development Kit', 'HealtheventV1', 'v1HealtheventV1'] +--- + +# HealtheventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailedMessage** | **(optional)** **string** | Description of the issue | [default to undefined] +**uuid** | **(optional)** **string** | Unique identifier for the health event | [default to undefined] +**url** | **(optional)** **string** | Optional URL associated with the issue | [default to undefined] +**timestamp** | **(optional)** **string** | Time when the event occurred | [default to undefined] +**lastNotifiedTimeStamp** | **(optional)** **string** | Last time notification was sent for this issue | [default to undefined] +**cpuUtilizationPercentage** | **(optional)** **number** | CPU usage percentage | [default to undefined] +**freeSpacePercentage** | **(optional)** **number** | Free memory percentage | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Healthindicatorcategory.md b/sdk-output/managed_clients/docs/Models/Healthindicatorcategory.md new file mode 100644 index 00000000..e31a686e --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Healthindicatorcategory.md @@ -0,0 +1,20 @@ +--- +id: v1-healthindicatorcategory-v1 +title: HealthindicatorcategoryV1 +pagination_label: HealthindicatorcategoryV1 +sidebar_label: HealthindicatorcategoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HealthindicatorcategoryV1', 'v1HealthindicatorcategoryV1'] +slug: /tools/sdk/typescript/managed_clients/models/healthindicatorcategory-v1 +tags: ['SDK', 'Software Development Kit', 'HealthindicatorcategoryV1', 'v1HealthindicatorcategoryV1'] +--- + +# HealthindicatorcategoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | **(optional)** **Array<HealtheventV1>** | List of error events for this category | [default to undefined] +**warnings** | **(optional)** **Array<HealtheventV1>** | List of warning events for this category | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Index.md b/sdk-output/managed_clients/docs/Models/Index.md new file mode 100644 index 00000000..5377d1ea --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: managed_clients-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: managed_clients-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_clients', 'models'] +slug: /tools/sdk/typescript/managed_clients/models +tags: ['SDK', 'Software Development Kit', 'managed_clients', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/managed_clients/docs/Models/Jsonpatchoperation.md b/sdk-output/managed_clients/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..e04f6f93 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/managed_clients/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/JsonpatchoperationValue.md b/sdk-output/managed_clients/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..990898fd --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/managed_clients/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_clients/docs/Models/Localeorigin.md b/sdk-output/managed_clients/docs/Models/Localeorigin.md new file mode 100644 index 00000000..799262a7 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/managed_clients/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/managed_clients/docs/Models/Managedclient.md b/sdk-output/managed_clients/docs/Models/Managedclient.md new file mode 100644 index 00000000..47e196d3 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclient.md @@ -0,0 +1,39 @@ +--- +id: v1-managedclient-v1 +title: ManagedclientV1 +pagination_label: ManagedclientV1 +sidebar_label: ManagedclientV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclientV1', 'v1ManagedclientV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclient-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclientV1', 'v1ManagedclientV1'] +--- + +# ManagedclientV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ManagedClient ID | [readonly] [default to undefined] +**alertKey** | **(optional)** **string** | ManagedClient alert key | [readonly] [default to undefined] +**apiGatewayBaseUrl** | **(optional)** **string** | | [default to undefined] +**cookbook** | **(optional)** **string** | | [default to undefined] +**ccId** | **(optional)** **number** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [default to undefined] +**clientId** | **string** | The client ID used in API management | [default to undefined] +**clusterId** | **string** | Cluster ID that the ManagedClient is linked to | [default to undefined] +**description** | **string** | ManagedClient description | [default to ''] +**ipAddress** | **(optional)** **string** | The public IP address of the ManagedClient | [readonly] [default to undefined] +**lastSeen** | **(optional)** **string** | When the ManagedClient was last seen by the server | [readonly] [default to undefined] +**name** | **(optional)** **string** | ManagedClient name | [default to 'VA-$clientId'] +**sinceLastSeen** | **(optional)** **string** | Milliseconds since the ManagedClient has polled the server | [readonly] [default to undefined] +**status** | **(optional)** **string** | Status of the ManagedClient | [readonly] [default to undefined] +**type** | **string** | Type of the ManagedClient (VA, CCG) | [default to undefined] +**clusterType** | **(optional)** **string** | Cluster Type of the ManagedClient | [readonly] [default to undefined] +**vaDownloadUrl** | **(optional)** **string** | ManagedClient VA download URL | [readonly] [default to undefined] +**vaVersion** | **(optional)** **string** | Version that the ManagedClient\'s VA is running | [readonly] [default to undefined] +**secret** | **(optional)** **string** | Client\'s apiKey | [default to undefined] +**createdAt** | **(optional)** **string** | The date/time this ManagedClient was created | [default to undefined] +**updatedAt** | **(optional)** **string** | The date/time this ManagedClient was last updated | [default to undefined] +**provisionStatus** | **(optional)** **string** | The provisioning status of the ManagedClient | [readonly] [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Managedclienthealthindicators.md b/sdk-output/managed_clients/docs/Models/Managedclienthealthindicators.md new file mode 100644 index 00000000..dd1ee8d3 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclienthealthindicators.md @@ -0,0 +1,22 @@ +--- +id: v1-managedclienthealthindicators-v1 +title: ManagedclienthealthindicatorsV1 +pagination_label: ManagedclienthealthindicatorsV1 +sidebar_label: ManagedclienthealthindicatorsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclienthealthindicatorsV1', 'v1ManagedclienthealthindicatorsV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclienthealthindicators-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclienthealthindicatorsV1', 'v1ManagedclienthealthindicatorsV1'] +--- + +# ManagedclienthealthindicatorsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **ManagedclienthealthindicatorsBodyV1** | | [default to undefined] +**status** | **string** | Top-level status of the Managed Client | [default to undefined] +**type** | **string** | Type of the Managed Client | [default to undefined] +**timestamp** | **string** | Timestamp when this report was generated | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBody.md b/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBody.md new file mode 100644 index 00000000..d26f7957 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBody.md @@ -0,0 +1,45 @@ +--- +id: v1-managedclienthealthindicators-body-v1 +title: ManagedclienthealthindicatorsBodyV1 +pagination_label: ManagedclienthealthindicatorsBodyV1 +sidebar_label: ManagedclienthealthindicatorsBodyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclienthealthindicatorsBodyV1', 'v1ManagedclienthealthindicatorsBodyV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclienthealthindicators-body-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclienthealthindicatorsBodyV1', 'v1ManagedclienthealthindicatorsBodyV1'] +--- + +# ManagedclienthealthindicatorsBodyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alertKey** | **(optional)** **string** | Health indicator alert key | [readonly] [default to undefined] +**id** | **string** | Unique identifier for the health report | [default to undefined] +**clusterId** | **string** | Cluster ID the health report belongs to | [default to undefined] +**apiUser** | **string** | API user ID sending the health data | [default to undefined] +**ccg_etag** | **(optional)** **string** | ETag value for CCG version control | [default to undefined] +**ccg_pin** | **(optional)** **string** | PIN value for CCG validation | [default to undefined] +**cookbook_etag** | **(optional)** **string** | ETag for cookbook version | [default to undefined] +**hostname** | **string** | Hostname of the Managed Client | [default to undefined] +**internal_ip** | **(optional)** **string** | Internal IP address of the Managed Client | [default to undefined] +**lastSeen** | **(optional)** **string** | Epoch timestamp (in millis) when last seen | [default to undefined] +**sinceSeen** | **(optional)** **string** | Seconds since last seen | [default to undefined] +**sinceSeenMillis** | **(optional)** **string** | Milliseconds since last seen | [default to undefined] +**localDev** | **(optional)** **boolean** | Indicates if this is a local development instance | [default to false] +**stacktrace** | **(optional)** **string** | Stacktrace associated with any error, if available | [default to undefined] +**state** | **(optional)** **string** | Optional state value from the client | [default to undefined] +**status** | **string** | Status of the client at the time of report | [default to undefined] +**uuid** | **(optional)** **string** | Optional UUID from the client | [default to undefined] +**product** | **string** | Product type (e.g., idn) | [default to undefined] +**va_version** | **(optional)** **string** | VA version installed on the client | [default to undefined] +**platform_version** | **string** | Version of the platform on which VA is running | [default to undefined] +**os_version** | **string** | Operating system version | [default to undefined] +**os_type** | **string** | Operating system type | [default to undefined] +**hypervisor** | **string** | Virtualization platform used | [default to undefined] +**consolidatedHealthIndicatorsStatus** | **string** | Consolidated health indicator status | [default to undefined] +**lastNotifiedCcgVersion** | **(optional)** **string** | The last CCG version for which notification was sent | [default to undefined] +**deployed_processes** | **(optional)** **string** | Information about deployed processes | [default to undefined] +**health_indicators** | **ManagedclienthealthindicatorsBodyHealthIndicatorsV1** | | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBodyHealthIndicators.md b/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBodyHealthIndicators.md new file mode 100644 index 00000000..a8fca4b6 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/ManagedclienthealthindicatorsBodyHealthIndicators.md @@ -0,0 +1,21 @@ +--- +id: v1-managedclienthealthindicators-body-health-indicators-v1 +title: ManagedclienthealthindicatorsBodyHealthIndicatorsV1 +pagination_label: ManagedclienthealthindicatorsBodyHealthIndicatorsV1 +sidebar_label: ManagedclienthealthindicatorsBodyHealthIndicatorsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclienthealthindicatorsBodyHealthIndicatorsV1', 'v1ManagedclienthealthindicatorsBodyHealthIndicatorsV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclienthealthindicators-body-health-indicators-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclienthealthindicatorsBodyHealthIndicatorsV1', 'v1ManagedclienthealthindicatorsBodyHealthIndicatorsV1'] +--- + +# ManagedclienthealthindicatorsBodyHealthIndicatorsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**container** | **(optional)** **HealthindicatorcategoryV1** | | [default to undefined] +**memory** | **(optional)** **HealthindicatorcategoryV1** | | [default to undefined] +**cpu** | **(optional)** **HealthindicatorcategoryV1** | | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Managedclientrequest.md b/sdk-output/managed_clients/docs/Models/Managedclientrequest.md new file mode 100644 index 00000000..17fee100 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclientrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-managedclientrequest-v1 +title: ManagedclientrequestV1 +pagination_label: ManagedclientrequestV1 +sidebar_label: ManagedclientrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclientrequestV1', 'v1ManagedclientrequestV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclientrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclientrequestV1', 'v1ManagedclientrequestV1'] +--- + +# ManagedclientrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clusterId** | **string** | Cluster ID that the ManagedClient is linked to | [default to undefined] +**description** | **(optional)** **string** | description for the ManagedClient to create | [default to undefined] +**name** | **(optional)** **string** | name for the ManagedClient to create | [default to undefined] +**type** | **(optional)** **string** | Type of the ManagedClient (VA, CCG) to create | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Managedclientstatus.md b/sdk-output/managed_clients/docs/Models/Managedclientstatus.md new file mode 100644 index 00000000..e967b763 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclientstatus.md @@ -0,0 +1,22 @@ +--- +id: v1-managedclientstatus-v1 +title: ManagedclientstatusV1 +pagination_label: ManagedclientstatusV1 +sidebar_label: ManagedclientstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclientstatusV1', 'v1ManagedclientstatusV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclientstatus-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclientstatusV1', 'v1ManagedclientstatusV1'] +--- + +# ManagedclientstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | **object** | ManagedClientStatus body information | [default to undefined] +**status** | **ManagedclientstatuscodeV1** | | [default to undefined] +**type** | **ManagedclienttypeV1** | | [default to undefined] +**timestamp** | **string** | timestamp on the Client Status update | [default to undefined] + diff --git a/sdk-output/managed_clients/docs/Models/Managedclientstatuscode.md b/sdk-output/managed_clients/docs/Models/Managedclientstatuscode.md new file mode 100644 index 00000000..95bc4217 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclientstatuscode.md @@ -0,0 +1,31 @@ +--- +id: v1-managedclientstatuscode-v1 +title: ManagedclientstatuscodeV1 +pagination_label: ManagedclientstatuscodeV1 +sidebar_label: ManagedclientstatuscodeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclientstatuscodeV1', 'v1ManagedclientstatuscodeV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclientstatuscode-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclientstatuscodeV1', 'v1ManagedclientstatuscodeV1'] +--- + +# ManagedclientstatuscodeV1 + +## Enum + + +* `Normal` (value: `'NORMAL'`) + +* `Undefined` (value: `'UNDEFINED'`) + +* `NotConfigured` (value: `'NOT_CONFIGURED'`) + +* `Configuring` (value: `'CONFIGURING'`) + +* `Warning` (value: `'WARNING'`) + +* `Error` (value: `'ERROR'`) + +* `Failed` (value: `'FAILED'`) + + diff --git a/sdk-output/managed_clients/docs/Models/Managedclienttype.md b/sdk-output/managed_clients/docs/Models/Managedclienttype.md new file mode 100644 index 00000000..4dd48a00 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/Managedclienttype.md @@ -0,0 +1,25 @@ +--- +id: v1-managedclienttype-v1 +title: ManagedclienttypeV1 +pagination_label: ManagedclienttypeV1 +sidebar_label: ManagedclienttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclienttypeV1', 'v1ManagedclienttypeV1'] +slug: /tools/sdk/typescript/managed_clients/models/managedclienttype-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclienttypeV1', 'v1ManagedclienttypeV1'] +--- + +# ManagedclienttypeV1 + +## Enum + + +* `Ccg` (value: `'CCG'`) + +* `Va` (value: `'VA'`) + +* `Internal` (value: `'INTERNAL'`) + +* `IiqHarvester` (value: `'IIQ_HARVESTER'`) + + diff --git a/sdk-output/managed_clients/docs/Models/README.md b/sdk-output/managed_clients/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_clients/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_cluster_types/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/managed_cluster_types/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f6cedbed --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,80 @@ +- path: /managed-cluster-types/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types#create-managed-cluster-type-v1 + source: | + import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClusterTypesV1Api(configuration); + const managedclustertypeV1: ManagedclustertypeV1 = ; // ManagedclustertypeV1 | + const result = await apiInstance.createManagedClusterTypeV1(managedclustertypeV1); + console.log(result); +- path: /managed-cluster-types/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types#delete-managed-cluster-type-v1 + source: | + import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClusterTypesV1Api(configuration); + const id: string = 'aClusterTypeId'; // string | The Managed Cluster Type ID (default to undefined) + const result = await apiInstance.deleteManagedClusterTypeV1(id); + console.log(result); +- path: /managed-cluster-types/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types#get-managed-cluster-type-v1 + source: | + import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClusterTypesV1Api(configuration); + const id: string = 'aClusterTypeId'; // string | The Managed Cluster Type ID (default to undefined) + const result = await apiInstance.getManagedClusterTypeV1(id); + console.log(result); +- path: /managed-cluster-types/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types#get-managed-cluster-types-v1 + source: | + import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClusterTypesV1Api(configuration); + const type: string = 'IDN'; // string | Type descriptor (optional) (default to undefined) + const pod: string = 'megapod-useast1'; // string | Pinned pod (or default) (optional) (default to undefined) + const org: string = 'denali-xyz'; // string | Pinned org (or default) (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.getManagedClusterTypesV1(); + console.log(result); +- path: /managed-cluster-types/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types#update-managed-cluster-type-v1 + source: | + import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClusterTypesV1Api(configuration); + const id: string = 'aClusterTypeId'; // string | The Managed Cluster Type ID (default to undefined) + const jsonpatchV1: JsonpatchV1 = ; // JsonpatchV1 | The JSONPatch payload used to update the schema. + const result = await apiInstance.updateManagedClusterTypeV1(id, jsonpatchV1); + console.log(result); diff --git a/sdk-output/managed_cluster_types/docs/Methods/Index.md b/sdk-output/managed_cluster_types/docs/Methods/Index.md new file mode 100644 index 00000000..84e015f0 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: managed_cluster_types-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: managed_cluster_types-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_cluster_types', 'methods'] +slug: /tools/sdk/typescript/managed_cluster_types/methods +tags: ['SDK', 'Software Development Kit', 'managed_cluster_types', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/managed_cluster_types/docs/Methods/ManagedClusterTypesV1Api.md b/sdk-output/managed_cluster_types/docs/Methods/ManagedClusterTypesV1Api.md new file mode 100644 index 00000000..2a29dbca --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Methods/ManagedClusterTypesV1Api.md @@ -0,0 +1,228 @@ +--- +id: v1-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedClusterTypes', 'v1ManagedClusterTypes'] +slug: /tools/sdk/typescript/managed_cluster_types/methods/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'v1ManagedClusterTypes'] +--- + +# ManagedClusterTypesV1Api + Use this API to implement managed cluster types functionality. +With this functionality in place, administrators can modify and delete existing managed cluster types and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster-type-v1**](#create-managed-cluster-type-v1) | **POST** `/managed-cluster-types/v1` | Create new managed cluster type +[**delete-managed-cluster-type-v1**](#delete-managed-cluster-type-v1) | **DELETE** `/managed-cluster-types/v1/{id}` | Delete a managed cluster type +[**get-managed-cluster-type-v1**](#get-managed-cluster-type-v1) | **GET** `/managed-cluster-types/v1/{id}` | Get a managed cluster type +[**get-managed-cluster-types-v1**](#get-managed-cluster-types-v1) | **GET** `/managed-cluster-types/v1` | List managed cluster types +[**update-managed-cluster-type-v1**](#update-managed-cluster-type-v1) | **PATCH** `/managed-cluster-types/v1/{id}` | Update a managed cluster type + + +## create-managed-cluster-type-v1 +Create new managed cluster type +Create a new Managed Cluster Type. + +The API returns a result that includes the Managed Cluster Type ID + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-managed-cluster-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**managedclustertypeV1** | **ManagedclustertypeV1** | | + +### Return type + +**ManagedclustertypeV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClusterTypesV1Api(configuration); +const managedclustertypeV1: ManagedclustertypeV1 = ; // +const result = await apiInstance.createManagedClusterTypeV1(managedclustertypeV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-managed-cluster-type-v1 +Delete a managed cluster type +Delete an existing Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-managed-cluster-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Managed Cluster Type ID | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClusterTypesV1Api(configuration); +const id: string = aClusterTypeId; // The Managed Cluster Type ID +const result = await apiInstance.deleteManagedClusterTypeV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-cluster-type-v1 +Get a managed cluster type +Get a Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-cluster-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Managed Cluster Type ID | [default to undefined] + +### Return type + +**ManagedclustertypeV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClusterTypesV1Api(configuration); +const id: string = aClusterTypeId; // The Managed Cluster Type ID +const result = await apiInstance.getManagedClusterTypeV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-cluster-types-v1 +List managed cluster types +Get a list of Managed Cluster Types. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-cluster-types-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **string** | Type descriptor | [optional] [default to undefined] +**pod** | **string** | Pinned pod (or default) | [optional] [default to undefined] +**org** | **string** | Pinned org (or default) | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClusterTypesV1Api(configuration); +const type: string = IDN; // Type descriptor (optional) +const pod: string = megapod-useast1; // Pinned pod (or default) (optional) +const org: string = denali-xyz; // Pinned org (or default) (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getManagedClusterTypesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-managed-cluster-type-v1 +Update a managed cluster type +Update an existing Managed Cluster Type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-managed-cluster-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Managed Cluster Type ID | [default to undefined] +**jsonpatchV1** | **JsonpatchV1** | The JSONPatch payload used to update the schema. | + +### Return type + +**ManagedclustertypeV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClusterTypesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClusterTypesV1Api(configuration); +const id: string = aClusterTypeId; // The Managed Cluster Type ID +const jsonpatchV1: JsonpatchV1 = ; // The JSONPatch payload used to update the schema. +const result = await apiInstance.updateManagedClusterTypeV1(id, jsonpatchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/managed_cluster_types/docs/Models/ArrayInner.md b/sdk-output/managed_cluster_types/docs/Models/ArrayInner.md new file mode 100644 index 00000000..8b5a304d --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_cluster_types/docs/Models/Errormessagedto.md b/sdk-output/managed_cluster_types/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..c32c36ea --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/Errorresponsedto.md b/sdk-output/managed_cluster_types/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..1fbb013e --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1401Response.md b/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1401Response.md new file mode 100644 index 00000000..18224216 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-cluster-types-v1401-response-v1 +title: GetManagedClusterTypesV1401ResponseV1 +pagination_label: GetManagedClusterTypesV1401ResponseV1 +sidebar_label: GetManagedClusterTypesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClusterTypesV1401ResponseV1', 'v1GetManagedClusterTypesV1401ResponseV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/get-managed-cluster-types-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClusterTypesV1401ResponseV1', 'v1GetManagedClusterTypesV1401ResponseV1'] +--- + +# GetManagedClusterTypesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1429Response.md b/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1429Response.md new file mode 100644 index 00000000..fc718515 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/GetManagedClusterTypesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-cluster-types-v1429-response-v1 +title: GetManagedClusterTypesV1429ResponseV1 +pagination_label: GetManagedClusterTypesV1429ResponseV1 +sidebar_label: GetManagedClusterTypesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClusterTypesV1429ResponseV1', 'v1GetManagedClusterTypesV1429ResponseV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/get-managed-cluster-types-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClusterTypesV1429ResponseV1', 'v1GetManagedClusterTypesV1429ResponseV1'] +--- + +# GetManagedClusterTypesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/Index.md b/sdk-output/managed_cluster_types/docs/Models/Index.md new file mode 100644 index 00000000..677f74d9 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: managed_cluster_types-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: managed_cluster_types-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_cluster_types', 'models'] +slug: /tools/sdk/typescript/managed_cluster_types/models +tags: ['SDK', 'Software Development Kit', 'managed_cluster_types', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/managed_cluster_types/docs/Models/Jsonpatch.md b/sdk-output/managed_cluster_types/docs/Models/Jsonpatch.md new file mode 100644 index 00000000..5878cc32 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Jsonpatch.md @@ -0,0 +1,19 @@ +--- +id: v1-jsonpatch-v1 +title: JsonpatchV1 +pagination_label: JsonpatchV1 +sidebar_label: JsonpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchV1', 'v1JsonpatchV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/jsonpatch-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchV1', 'v1JsonpatchV1'] +--- + +# JsonpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | **(optional)** **Array<JsonpatchoperationV1>** | Operations to be applied | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/Jsonpatchoperation.md b/sdk-output/managed_cluster_types/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..9da92709 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/JsonpatchoperationValue.md b/sdk-output/managed_cluster_types/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..2b6f9de1 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_cluster_types/docs/Models/Localeorigin.md b/sdk-output/managed_cluster_types/docs/Models/Localeorigin.md new file mode 100644 index 00000000..9c9c4ca9 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/managed_cluster_types/docs/Models/Managedclustertype.md b/sdk-output/managed_cluster_types/docs/Models/Managedclustertype.md new file mode 100644 index 00000000..1e75eb39 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/Managedclustertype.md @@ -0,0 +1,23 @@ +--- +id: v1-managedclustertype-v1 +title: ManagedclustertypeV1 +pagination_label: ManagedclustertypeV1 +sidebar_label: ManagedclustertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclustertypeV1', 'v1ManagedclustertypeV1'] +slug: /tools/sdk/typescript/managed_cluster_types/models/managedclustertype-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclustertypeV1', 'v1ManagedclustertypeV1'] +--- + +# ManagedclustertypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ManagedClusterType ID | [readonly] [default to undefined] +**type** | **string** | ManagedClusterType type name | [default to undefined] +**pod** | **string** | ManagedClusterType pod | [default to undefined] +**org** | **string** | ManagedClusterType org | [default to undefined] +**managedProcessIds** | **(optional)** **Array<string>** | List of processes for the cluster type | [default to undefined] + diff --git a/sdk-output/managed_cluster_types/docs/Models/README.md b/sdk-output/managed_cluster_types/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_cluster_types/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_clusters/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/managed_clusters/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f34d37fd --- /dev/null +++ b/sdk-output/managed_clusters/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,126 @@ +- path: /managed-clusters/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#create-managed-cluster-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const managedclusterrequestV1: ManagedclusterrequestV1 = ; // ManagedclusterrequestV1 | + const result = await apiInstance.createManagedClusterV1(managedclusterrequestV1); + console.log(result); +- path: /managed-clusters/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#delete-managed-cluster-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2c9180897de347a2017de8859e8c5039'; // string | Managed cluster ID. (default to undefined) + const removeClients: boolean = false; // boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to false) + const result = await apiInstance.deleteManagedClusterV1(id); + console.log(result); +- path: /managed-clusters/v1/{id}/log-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#get-client-log-configuration-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | ID of managed cluster to get log configuration for. (default to undefined) + const result = await apiInstance.getClientLogConfigurationV1(id); + console.log(result); +- path: /managed-clusters/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#get-managed-cluster-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2c9180897de347a2017de8859e8c5039'; // string | Managed cluster ID. (default to undefined) + const result = await apiInstance.getManagedClusterV1(id); + console.log(result); +- path: /managed-clusters/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#get-managed-clusters-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'operational eq "operation"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) (default to undefined) + const result = await apiInstance.getManagedClustersV1(); + console.log(result); +- path: /managed-clusters/v1/{id}/log-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#put-client-log-configuration-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | ID of the managed cluster to update the log configuration for. (default to undefined) + const putClientLogConfigurationV1RequestV1: PutClientLogConfigurationV1RequestV1 = ; // PutClientLogConfigurationV1RequestV1 | Client log configuration for the given managed cluster. + const result = await apiInstance.putClientLogConfigurationV1(id, putClientLogConfigurationV1RequestV1); + console.log(result); +- path: /managed-clusters/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#update-managed-cluster-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2c9180897de347a2017de8859e8c5039'; // string | Managed cluster ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | JSONPatch payload used to update the object. + const result = await apiInstance.updateManagedClusterV1(id, jsonpatchoperationV1); + console.log(result); +- path: /managed-clusters/v1/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/managed_clusters/methods/managed-clusters#update-v1 + source: | + import { ManagedClustersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ManagedClustersV1Api(configuration); + const id: string = '2b838de9-db9b-abcf-e646-d4f274ad4238'; // string | ID of managed cluster to trigger manual upgrade. (default to undefined) + const result = await apiInstance.updateV1(id); + console.log(result); diff --git a/sdk-output/managed_clusters/docs/Methods/Index.md b/sdk-output/managed_clusters/docs/Methods/Index.md new file mode 100644 index 00000000..107ca225 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: managed_clusters-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: managed_clusters-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_clusters', 'methods'] +slug: /tools/sdk/typescript/managed_clusters/methods +tags: ['SDK', 'Software Development Kit', 'managed_clusters', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/managed_clusters/docs/Methods/ManagedClustersV1Api.md b/sdk-output/managed_clusters/docs/Methods/ManagedClustersV1Api.md new file mode 100644 index 00000000..8aa86cc2 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Methods/ManagedClustersV1Api.md @@ -0,0 +1,347 @@ +--- +id: v1-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedClusters', 'v1ManagedClusters'] +slug: /tools/sdk/typescript/managed_clusters/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'v1ManagedClusters'] +--- + +# ManagedClustersV1Api + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-managed-cluster-v1**](#create-managed-cluster-v1) | **POST** `/managed-clusters/v1` | Create create managed cluster +[**delete-managed-cluster-v1**](#delete-managed-cluster-v1) | **DELETE** `/managed-clusters/v1/{id}` | Delete managed cluster +[**get-client-log-configuration-v1**](#get-client-log-configuration-v1) | **GET** `/managed-clusters/v1/{id}/log-config` | Get managed cluster log configuration +[**get-managed-cluster-v1**](#get-managed-cluster-v1) | **GET** `/managed-clusters/v1/{id}` | Get managed cluster +[**get-managed-clusters-v1**](#get-managed-clusters-v1) | **GET** `/managed-clusters/v1` | Get managed clusters +[**put-client-log-configuration-v1**](#put-client-log-configuration-v1) | **PUT** `/managed-clusters/v1/{id}/log-config` | Update managed cluster log configuration +[**update-managed-cluster-v1**](#update-managed-cluster-v1) | **PATCH** `/managed-clusters/v1/{id}` | Update managed cluster +[**update-v1**](#update-v1) | **POST** `/managed-clusters/v1/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster + + +## create-managed-cluster-v1 +Create create managed cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-managed-cluster-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**managedclusterrequestV1** | **ManagedclusterrequestV1** | | + +### Return type + +**ManagedclusterV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const managedclusterrequestV1: ManagedclusterrequestV1 = ; // +const result = await apiInstance.createManagedClusterV1(managedclusterrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-managed-cluster-v1 +Delete managed cluster +Delete an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-managed-cluster-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed cluster ID. | [default to undefined] +**removeClients** | **boolean** | Flag to determine the need to delete a cluster with clients. | [optional] [default to false] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID. +const removeClients: boolean = false; // Flag to determine the need to delete a cluster with clients. (optional) +const result = await apiInstance.deleteManagedClusterV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-client-log-configuration-v1 +Get managed cluster log configuration +Get a managed cluster's log configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-client-log-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of managed cluster to get log configuration for. | [default to undefined] + +### Return type + +**ClientlogconfigurationV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of managed cluster to get log configuration for. +const result = await apiInstance.getClientLogConfigurationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-cluster-v1 +Get managed cluster +Get a managed cluster by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-cluster-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed cluster ID. | [default to undefined] + +### Return type + +**ManagedclusterV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID. +const result = await apiInstance.getManagedClusterV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-managed-clusters-v1 +Get managed clusters +List current organization's managed clusters, based on request context. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-managed-clusters-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = operational eq "operation"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) +const result = await apiInstance.getManagedClustersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-client-log-configuration-v1 +Update managed cluster log configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-client-log-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the managed cluster to update the log configuration for. | [default to undefined] +**putClientLogConfigurationV1RequestV1** | **PutClientLogConfigurationV1RequestV1** | Client log configuration for the given managed cluster. | + +### Return type + +**ClientlogconfigurationV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of the managed cluster to update the log configuration for. +const putClientLogConfigurationV1RequestV1: PutClientLogConfigurationV1RequestV1 = ; // Client log configuration for the given managed cluster. +const result = await apiInstance.putClientLogConfigurationV1(id, putClientLogConfigurationV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-managed-cluster-v1 +Update managed cluster +Update an existing managed cluster. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-managed-cluster-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Managed cluster ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | JSONPatch payload used to update the object. | + +### Return type + +**ManagedclusterV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2c9180897de347a2017de8859e8c5039; // Managed cluster ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // JSONPatch payload used to update the object. +const result = await apiInstance.updateManagedClusterV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-v1 +Trigger manual upgrade for managed cluster +Trigger Manual Upgrade for Managed Cluster. +AMS Security: API, Internal A token with SYSTEM_ADMINISTRATOR authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of managed cluster to trigger manual upgrade. | [default to undefined] + +### Return type + +**ClustermanualupgradeV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ManagedClustersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ManagedClustersV1Api(configuration); +const id: string = 2b838de9-db9b-abcf-e646-d4f274ad4238; // ID of managed cluster to trigger manual upgrade. +const result = await apiInstance.updateV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/managed_clusters/docs/Models/ArrayInner.md b/sdk-output/managed_clusters/docs/Models/ArrayInner.md new file mode 100644 index 00000000..60a429fd --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/managed_clusters/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_clusters/docs/Models/Clientlogconfiguration.md b/sdk-output/managed_clusters/docs/Models/Clientlogconfiguration.md new file mode 100644 index 00000000..f37d64bb --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Clientlogconfiguration.md @@ -0,0 +1,23 @@ +--- +id: v1-clientlogconfiguration-v1 +title: ClientlogconfigurationV1 +pagination_label: ClientlogconfigurationV1 +sidebar_label: ClientlogconfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClientlogconfigurationV1', 'v1ClientlogconfigurationV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clientlogconfiguration-v1 +tags: ['SDK', 'Software Development Kit', 'ClientlogconfigurationV1', 'v1ClientlogconfigurationV1'] +--- + +# ClientlogconfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientId** | **(optional)** **string** | Log configuration\'s client ID | [default to undefined] +**durationMinutes** | **(optional)** **number** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [default to 240] +**expiration** | **(optional)** **string** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [default to undefined] +**rootLevel** | **StandardlevelV1** | | [default to undefined] +**logLevels** | **(optional)** | Mapping of identifiers to Standard Log Level values | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationdurationminutes.md b/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationdurationminutes.md new file mode 100644 index 00000000..8542f535 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationdurationminutes.md @@ -0,0 +1,22 @@ +--- +id: v1-clientlogconfigurationdurationminutes-v1 +title: ClientlogconfigurationdurationminutesV1 +pagination_label: ClientlogconfigurationdurationminutesV1 +sidebar_label: ClientlogconfigurationdurationminutesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClientlogconfigurationdurationminutesV1', 'v1ClientlogconfigurationdurationminutesV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clientlogconfigurationdurationminutes-v1 +tags: ['SDK', 'Software Development Kit', 'ClientlogconfigurationdurationminutesV1', 'v1ClientlogconfigurationdurationminutesV1'] +--- + +# ClientlogconfigurationdurationminutesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientId** | **(optional)** **string** | Log configuration\'s client ID | [default to undefined] +**durationMinutes** | **(optional)** **number** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [default to 240] +**rootLevel** | **StandardlevelV1** | | [default to undefined] +**logLevels** | **(optional)** | Mapping of identifiers to Standard Log Level values | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationexpiration.md b/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationexpiration.md new file mode 100644 index 00000000..f9a5b12f --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Clientlogconfigurationexpiration.md @@ -0,0 +1,22 @@ +--- +id: v1-clientlogconfigurationexpiration-v1 +title: ClientlogconfigurationexpirationV1 +pagination_label: ClientlogconfigurationexpirationV1 +sidebar_label: ClientlogconfigurationexpirationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClientlogconfigurationexpirationV1', 'v1ClientlogconfigurationexpirationV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clientlogconfigurationexpiration-v1 +tags: ['SDK', 'Software Development Kit', 'ClientlogconfigurationexpirationV1', 'v1ClientlogconfigurationexpirationV1'] +--- + +# ClientlogconfigurationexpirationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientId** | **(optional)** **string** | Log configuration\'s client ID | [default to undefined] +**expiration** | **(optional)** **string** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [default to undefined] +**rootLevel** | **StandardlevelV1** | | [default to undefined] +**logLevels** | **(optional)** | Mapping of identifiers to Standard Log Level values | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Clustermanualupgrade.md b/sdk-output/managed_clusters/docs/Models/Clustermanualupgrade.md new file mode 100644 index 00000000..4f0a05d6 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Clustermanualupgrade.md @@ -0,0 +1,19 @@ +--- +id: v1-clustermanualupgrade-v1 +title: ClustermanualupgradeV1 +pagination_label: ClustermanualupgradeV1 +sidebar_label: ClustermanualupgradeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeV1', 'v1ClustermanualupgradeV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeV1', 'v1ClustermanualupgradeV1'] +--- + +# ClustermanualupgradeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobs** | **(optional)** **Array<ClustermanualupgradeJobsInnerV1>** | List of job objects for the upgrade request. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInner.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInner.md new file mode 100644 index 00000000..6fe26aea --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInner.md @@ -0,0 +1,24 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-v1 +title: ClustermanualupgradeJobsInnerV1 +pagination_label: ClustermanualupgradeJobsInnerV1 +sidebar_label: ClustermanualupgradeJobsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerV1', 'v1ClustermanualupgradeJobsInnerV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerV1', 'v1ClustermanualupgradeJobsInnerV1'] +--- + +# ClustermanualupgradeJobsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | Unique identifier for the upgrade job. | [default to undefined] +**cookbook** | **string** | Identifier for the cookbook used in the upgrade job. | [default to undefined] +**state** | **string** | Current state of the upgrade job. | [default to undefined] +**type** | **string** | The type of upgrade job (e.g., VA_UPGRADE). | [default to undefined] +**targetId** | **string** | Unique identifier of the target for the upgrade job. | [default to undefined] +**managedProcessConfiguration** | **ClustermanualupgradeJobsInnerManagedProcessConfigurationV1** | | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfiguration.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfiguration.md new file mode 100644 index 00000000..5938e6cf --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfiguration.md @@ -0,0 +1,23 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**charon** | **(optional)** **ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1** | | [default to undefined] +**ccg** | **(optional)** **ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1** | | [default to undefined] +**otel_agent** | **(optional)** **ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1** | | [default to undefined] +**relay** | **(optional)** **ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1** | | [default to undefined] +**toolbox** | **(optional)** **ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1** | | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCcg.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCcg.md new file mode 100644 index 00000000..2548a40e --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCcg.md @@ -0,0 +1,23 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-ccg-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-ccg-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationCcgV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of the \'ccg\' process. | [default to undefined] +**path** | **string** | Path to the \'ccg\' process. | [default to undefined] +**description** | **string** | A brief description of the \'ccg\' process. | [default to undefined] +**restartNeeded** | **boolean** | Indicates whether the process needs to be restarted. | [default to undefined] +**dependencies** | | A map of dependencies for the \'ccg\' process. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCharon.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCharon.md new file mode 100644 index 00000000..97d4eb54 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationCharon.md @@ -0,0 +1,22 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-charon-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-charon-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationCharonV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of the \'charon\' process. | [default to undefined] +**path** | **string** | Path to the \'charon\' process. | [default to undefined] +**description** | **string** | A brief description of the \'charon\' process. | [default to undefined] +**restartNeeded** | **boolean** | Indicates whether the process needs to be restarted. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgent.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgent.md new file mode 100644 index 00000000..bbdba23b --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgent.md @@ -0,0 +1,22 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-otel-agent-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-otel-agent-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationOtelAgentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of the \'otel_agent\' process. | [default to undefined] +**path** | **string** | Path to the \'otel_agent\' process. | [default to undefined] +**description** | **string** | A brief description of the \'otel_agent\' process. | [default to undefined] +**restartNeeded** | **boolean** | Indicates whether the process needs to be restarted. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationRelay.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationRelay.md new file mode 100644 index 00000000..c047bd54 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationRelay.md @@ -0,0 +1,22 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-relay-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-relay-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationRelayV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of the \'relay\' process. | [default to undefined] +**path** | **string** | Path to the \'relay\' process. | [default to undefined] +**description** | **string** | A brief description of the \'relay\' process. | [default to undefined] +**restartNeeded** | **boolean** | Indicates whether the process needs to be restarted. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationToolbox.md b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationToolbox.md new file mode 100644 index 00000000..8ac1ebc1 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ClustermanualupgradeJobsInnerManagedProcessConfigurationToolbox.md @@ -0,0 +1,22 @@ +--- +id: v1-clustermanualupgrade-jobs-inner-managed-process-configuration-toolbox-v1 +title: ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 +pagination_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 +sidebar_label: ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1'] +slug: /tools/sdk/typescript/managed_clusters/models/clustermanualupgrade-jobs-inner-managed-process-configuration-toolbox-v1 +tags: ['SDK', 'Software Development Kit', 'ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1', 'v1ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1'] +--- + +# ClustermanualupgradeJobsInnerManagedProcessConfigurationToolboxV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **string** | Version of the \'toolbox\' process. | [default to undefined] +**path** | **string** | Path to the \'toolbox\' process. | [default to undefined] +**description** | **string** | A brief description of the \'toolbox\' process. | [default to undefined] +**restartNeeded** | **boolean** | Indicates whether the process needs to be restarted. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Errormessagedto.md b/sdk-output/managed_clusters/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..568f346c --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/managed_clusters/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Errorresponsedto.md b/sdk-output/managed_clusters/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e0a3988f --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/managed_clusters/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1401Response.md b/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1401Response.md new file mode 100644 index 00000000..32529c87 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-clusters-v1401-response-v1 +title: GetManagedClustersV1401ResponseV1 +pagination_label: GetManagedClustersV1401ResponseV1 +sidebar_label: GetManagedClustersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClustersV1401ResponseV1', 'v1GetManagedClustersV1401ResponseV1'] +slug: /tools/sdk/typescript/managed_clusters/models/get-managed-clusters-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClustersV1401ResponseV1', 'v1GetManagedClustersV1401ResponseV1'] +--- + +# GetManagedClustersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1429Response.md b/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1429Response.md new file mode 100644 index 00000000..042dabe8 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/GetManagedClustersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-managed-clusters-v1429-response-v1 +title: GetManagedClustersV1429ResponseV1 +pagination_label: GetManagedClustersV1429ResponseV1 +sidebar_label: GetManagedClustersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetManagedClustersV1429ResponseV1', 'v1GetManagedClustersV1429ResponseV1'] +slug: /tools/sdk/typescript/managed_clusters/models/get-managed-clusters-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetManagedClustersV1429ResponseV1', 'v1GetManagedClustersV1429ResponseV1'] +--- + +# GetManagedClustersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Index.md b/sdk-output/managed_clusters/docs/Models/Index.md new file mode 100644 index 00000000..0dd3327c --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: managed_clusters-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: managed_clusters-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'managed_clusters', 'models'] +slug: /tools/sdk/typescript/managed_clusters/models +tags: ['SDK', 'Software Development Kit', 'managed_clusters', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/managed_clusters/docs/Models/Jsonpatchoperation.md b/sdk-output/managed_clusters/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..87bc7009 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/managed_clusters/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/JsonpatchoperationValue.md b/sdk-output/managed_clusters/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..7a7e2980 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/managed_clusters/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/managed_clusters/docs/Models/Localeorigin.md b/sdk-output/managed_clusters/docs/Models/Localeorigin.md new file mode 100644 index 00000000..0410d653 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/managed_clusters/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclienttype.md b/sdk-output/managed_clusters/docs/Models/Managedclienttype.md new file mode 100644 index 00000000..1cdabddf --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclienttype.md @@ -0,0 +1,25 @@ +--- +id: v1-managedclienttype-v1 +title: ManagedclienttypeV1 +pagination_label: ManagedclienttypeV1 +sidebar_label: ManagedclienttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclienttypeV1', 'v1ManagedclienttypeV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclienttype-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclienttypeV1', 'v1ManagedclienttypeV1'] +--- + +# ManagedclienttypeV1 + +## Enum + + +* `Ccg` (value: `'CCG'`) + +* `Va` (value: `'VA'`) + +* `Internal` (value: `'INTERNAL'`) + +* `IiqHarvester` (value: `'IIQ_HARVESTER'`) + + diff --git a/sdk-output/managed_clusters/docs/Models/Managedcluster.md b/sdk-output/managed_clusters/docs/Models/Managedcluster.md new file mode 100644 index 00000000..ca3370ee --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedcluster.md @@ -0,0 +1,50 @@ +--- +id: v1-managedcluster-v1 +title: ManagedclusterV1 +pagination_label: ManagedclusterV1 +sidebar_label: ManagedclusterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterV1', 'v1ManagedclusterV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedcluster-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterV1', 'v1ManagedclusterV1'] +--- + +# ManagedclusterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ManagedCluster ID | [default to undefined] +**name** | **(optional)** **string** | ManagedCluster name | [default to undefined] +**pod** | **(optional)** **string** | ManagedCluster pod | [default to undefined] +**org** | **(optional)** **string** | ManagedCluster org | [default to undefined] +**type** | **(optional)** **ManagedclustertypesV1** | | [default to undefined] +**configuration** | **(optional)** | ManagedProcess configuration map | [default to undefined] +**keyPair** | **(optional)** **ManagedclusterkeypairV1** | | [default to undefined] +**attributes** | **(optional)** **ManagedclusterattributesV1** | | [default to undefined] +**description** | **(optional)** **string** | ManagedCluster description | [default to 'q'] +**redis** | **(optional)** **ManagedclusterredisV1** | | [default to undefined] +**clientType** | **ManagedclienttypeV1** | | [default to undefined] +**ccgVersion** | **string** | CCG version used by the ManagedCluster | [default to undefined] +**pinnedConfig** | **(optional)** **boolean** | boolean flag indicating whether or not the cluster configuration is pinned | [default to false] +**logConfiguration** | **(optional)** **ClientlogconfigurationV1** | | [default to undefined] +**operational** | **(optional)** **boolean** | Whether or not the cluster is operational or not | [default to false] +**status** | **(optional)** **string** | Cluster status | [default to undefined] +**publicKeyCertificate** | **(optional)** **string** | Public key certificate | [default to undefined] +**publicKeyThumbprint** | **(optional)** **string** | Public key thumbprint | [default to undefined] +**publicKey** | **(optional)** **string** | Public key | [default to undefined] +**encryptionConfiguration** | **(optional)** **ManagedclusterencryptionconfigV1** | | [default to undefined] +**alertKey** | **(optional)** **string** | Key describing any immediate cluster alerts | [default to undefined] +**clientIds** | **(optional)** **Array<string>** | List of clients in a cluster | [default to undefined] +**serviceCount** | **(optional)** **number** | Number of services bound to a cluster | [default to 0] +**ccId** | **(optional)** **string** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [default to '0'] +**createdAt** | **(optional)** **string** | The date/time this cluster was created | [default to undefined] +**updatedAt** | **(optional)** **string** | The date/time this cluster was last updated | [default to undefined] +**lastReleaseNotifiedAt** | **(optional)** **string** | The date/time this cluster was notified for the last release | [default to undefined] +**updatePreferences** | **(optional)** **ManagedclusterUpdatePreferencesV1** | | [default to undefined] +**currentInstalledReleaseVersion** | **(optional)** **string** | The current installed release on the Managed cluster | [default to undefined] +**updatePackage** | **(optional)** **string** | New available updates for the Managed cluster | [default to undefined] +**isOutOfDateNotifiedAt** | **(optional)** **string** | The time at which out of date notification was sent for the Managed cluster | [default to undefined] +**consolidatedHealthIndicatorsStatus** | **(optional)** **string** | The consolidated Health Status for the Managed cluster | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/ManagedclusterUpdatePreferences.md b/sdk-output/managed_clusters/docs/Models/ManagedclusterUpdatePreferences.md new file mode 100644 index 00000000..5a4711a9 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/ManagedclusterUpdatePreferences.md @@ -0,0 +1,21 @@ +--- +id: v1-managedcluster-update-preferences-v1 +title: ManagedclusterUpdatePreferencesV1 +pagination_label: ManagedclusterUpdatePreferencesV1 +sidebar_label: ManagedclusterUpdatePreferencesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterUpdatePreferencesV1', 'v1ManagedclusterUpdatePreferencesV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedcluster-update-preferences-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterUpdatePreferencesV1', 'v1ManagedclusterUpdatePreferencesV1'] +--- + +# ManagedclusterUpdatePreferencesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processGroups** | **(optional)** **string** | The processGroups for updatePreferences | [default to undefined] +**updateState** | **(optional)** **string** | The current updateState for the cluster | [default to undefined] +**notificationEmail** | **(optional)** **string** | The mail id to which new releases will be notified | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterattributes.md b/sdk-output/managed_clusters/docs/Models/Managedclusterattributes.md new file mode 100644 index 00000000..91b8fd22 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterattributes.md @@ -0,0 +1,20 @@ +--- +id: v1-managedclusterattributes-v1 +title: ManagedclusterattributesV1 +pagination_label: ManagedclusterattributesV1 +sidebar_label: ManagedclusterattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterattributesV1', 'v1ManagedclusterattributesV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterattributes-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterattributesV1', 'v1ManagedclusterattributesV1'] +--- + +# ManagedclusterattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**queue** | **(optional)** **ManagedclusterqueueV1** | | [default to undefined] +**keystore** | **(optional)** **string** | ManagedCluster keystore for spConnectCluster type | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterencryptionconfig.md b/sdk-output/managed_clusters/docs/Models/Managedclusterencryptionconfig.md new file mode 100644 index 00000000..bf71c7e6 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterencryptionconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-managedclusterencryptionconfig-v1 +title: ManagedclusterencryptionconfigV1 +pagination_label: ManagedclusterencryptionconfigV1 +sidebar_label: ManagedclusterencryptionconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterencryptionconfigV1', 'v1ManagedclusterencryptionconfigV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterencryptionconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterencryptionconfigV1', 'v1ManagedclusterencryptionconfigV1'] +--- + +# ManagedclusterencryptionconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | **(optional)** **string** | Specifies the format used for encrypted data, such as secrets. The format determines how the encrypted data is structured and processed. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterkeypair.md b/sdk-output/managed_clusters/docs/Models/Managedclusterkeypair.md new file mode 100644 index 00000000..51568117 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterkeypair.md @@ -0,0 +1,21 @@ +--- +id: v1-managedclusterkeypair-v1 +title: ManagedclusterkeypairV1 +pagination_label: ManagedclusterkeypairV1 +sidebar_label: ManagedclusterkeypairV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterkeypairV1', 'v1ManagedclusterkeypairV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterkeypair-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterkeypairV1', 'v1ManagedclusterkeypairV1'] +--- + +# ManagedclusterkeypairV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**publicKey** | **(optional)** **string** | ManagedCluster publicKey | [default to undefined] +**publicKeyThumbprint** | **(optional)** **string** | ManagedCluster publicKeyThumbprint | [default to undefined] +**publicKeyCertificate** | **(optional)** **string** | ManagedCluster publicKeyCertificate | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterqueue.md b/sdk-output/managed_clusters/docs/Models/Managedclusterqueue.md new file mode 100644 index 00000000..e8925c0a --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterqueue.md @@ -0,0 +1,20 @@ +--- +id: v1-managedclusterqueue-v1 +title: ManagedclusterqueueV1 +pagination_label: ManagedclusterqueueV1 +sidebar_label: ManagedclusterqueueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterqueueV1', 'v1ManagedclusterqueueV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterqueue-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterqueueV1', 'v1ManagedclusterqueueV1'] +--- + +# ManagedclusterqueueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | ManagedCluster queue name | [default to undefined] +**region** | **(optional)** **string** | ManagedCluster queue aws region | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterredis.md b/sdk-output/managed_clusters/docs/Models/Managedclusterredis.md new file mode 100644 index 00000000..30456851 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterredis.md @@ -0,0 +1,20 @@ +--- +id: v1-managedclusterredis-v1 +title: ManagedclusterredisV1 +pagination_label: ManagedclusterredisV1 +sidebar_label: ManagedclusterredisV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterredisV1', 'v1ManagedclusterredisV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterredis-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterredisV1', 'v1ManagedclusterredisV1'] +--- + +# ManagedclusterredisV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**redisHost** | **(optional)** **string** | ManagedCluster redisHost | [default to undefined] +**redisPort** | **(optional)** **number** | ManagedCluster redisPort | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclusterrequest.md b/sdk-output/managed_clusters/docs/Models/Managedclusterrequest.md new file mode 100644 index 00000000..2f579374 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclusterrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-managedclusterrequest-v1 +title: ManagedclusterrequestV1 +pagination_label: ManagedclusterrequestV1 +sidebar_label: ManagedclusterrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclusterrequestV1', 'v1ManagedclusterrequestV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclusterrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclusterrequestV1', 'v1ManagedclusterrequestV1'] +--- + +# ManagedclusterrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | ManagedCluster name | [default to undefined] +**type** | **(optional)** **ManagedclustertypesV1** | | [default to undefined] +**configuration** | **(optional)** | ManagedProcess configuration map | [default to undefined] +**description** | **(optional)** **string** | ManagedCluster description | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/Managedclustertypes.md b/sdk-output/managed_clusters/docs/Models/Managedclustertypes.md new file mode 100644 index 00000000..60500f64 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Managedclustertypes.md @@ -0,0 +1,37 @@ +--- +id: v1-managedclustertypes-v1 +title: ManagedclustertypesV1 +pagination_label: ManagedclustertypesV1 +sidebar_label: ManagedclustertypesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagedclustertypesV1', 'v1ManagedclustertypesV1'] +slug: /tools/sdk/typescript/managed_clusters/models/managedclustertypes-v1 +tags: ['SDK', 'Software Development Kit', 'ManagedclustertypesV1', 'v1ManagedclustertypesV1'] +--- + +# ManagedclustertypesV1 + +## Enum + + +* `Idn` (value: `'idn'`) + +* `Iai` (value: `'iai'`) + +* `SpConnectCluster` (value: `'spConnectCluster'`) + +* `SqsCluster` (value: `'sqsCluster'`) + +* `DasRc` (value: `'das-rc'`) + +* `DasPc` (value: `'das-pc'`) + +* `DasDc` (value: `'das-dc'`) + +* `Pag` (value: `'pag'`) + +* `DasAm` (value: `'das-am'`) + +* `Standard` (value: `'standard'`) + + diff --git a/sdk-output/managed_clusters/docs/Models/PutClientLogConfigurationV1Request.md b/sdk-output/managed_clusters/docs/Models/PutClientLogConfigurationV1Request.md new file mode 100644 index 00000000..5dcb27cd --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/PutClientLogConfigurationV1Request.md @@ -0,0 +1,23 @@ +--- +id: v1-put-client-log-configuration-v1-request-v1 +title: PutClientLogConfigurationV1RequestV1 +pagination_label: PutClientLogConfigurationV1RequestV1 +sidebar_label: PutClientLogConfigurationV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutClientLogConfigurationV1RequestV1', 'v1PutClientLogConfigurationV1RequestV1'] +slug: /tools/sdk/typescript/managed_clusters/models/put-client-log-configuration-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationV1RequestV1', 'v1PutClientLogConfigurationV1RequestV1'] +--- + +# PutClientLogConfigurationV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientId** | **(optional)** **string** | Log configuration\'s client ID | [default to undefined] +**durationMinutes** | **(optional)** **number** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [default to 240] +**rootLevel** | **StandardlevelV1** | | [default to undefined] +**logLevels** | **(optional)** | Mapping of identifiers to Standard Log Level values | [default to undefined] +**expiration** | **(optional)** **string** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [default to undefined] + diff --git a/sdk-output/managed_clusters/docs/Models/README.md b/sdk-output/managed_clusters/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/managed_clusters/docs/Models/Standardlevel.md b/sdk-output/managed_clusters/docs/Models/Standardlevel.md new file mode 100644 index 00000000..8b074109 --- /dev/null +++ b/sdk-output/managed_clusters/docs/Models/Standardlevel.md @@ -0,0 +1,31 @@ +--- +id: v1-standardlevel-v1 +title: StandardlevelV1 +pagination_label: StandardlevelV1 +sidebar_label: StandardlevelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StandardlevelV1', 'v1StandardlevelV1'] +slug: /tools/sdk/typescript/managed_clusters/models/standardlevel-v1 +tags: ['SDK', 'Software Development Kit', 'StandardlevelV1', 'v1StandardlevelV1'] +--- + +# StandardlevelV1 + +## Enum + + +* `Off` (value: `'OFF'`) + +* `Fatal` (value: `'FATAL'`) + +* `Error` (value: `'ERROR'`) + +* `Warn` (value: `'WARN'`) + +* `Info` (value: `'INFO'`) + +* `Debug` (value: `'DEBUG'`) + +* `Trace` (value: `'TRACE'`) + + diff --git a/sdk-output/mfa_configuration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/mfa_configuration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bc3248a3 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,103 @@ +- path: /mfa/v1/duo-web/config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#get-mfa-duo-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const result = await apiInstance.getMFADuoConfigV1(); + console.log(result); +- path: /mfa/v1/kba/config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#get-mfa-kba-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const allLanguages: boolean = allLanguages=true; // boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) (default to undefined) + const result = await apiInstance.getMFAKbaConfigV1(); + console.log(result); +- path: /mfa/v1/okta-verify/config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#get-mfa-okta-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const result = await apiInstance.getMFAOktaConfigV1(); + console.log(result); +- path: /mfa/v1/duo-web/config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#set-mfa-duo-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const mfaduoconfigV1: MfaduoconfigV1 = {"mfaMethod":"duo-web","enabled":true,"host":"www.example.com","accessKey":"qw123Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email","configProperties":{"skey":"12q3WERlcUHWJmiMqyCXI3uOF7EaDJTbdeOp6E2B","ikey":"Q123WE45R6TY7890ZXCV"}}; // MfaduoconfigV1 | + const result = await apiInstance.setMFADuoConfigV1(mfaduoconfigV1); + console.log(result); +- path: /mfa/v1/kba/config/answers + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#set-mfakba-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const kbaanswerrequestitemV1: Array<KbaanswerrequestitemV1> = [{"id":"173423","answer":"822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34"},{"id":"c54fee53-2d63-4fc5-9259-3e93b9994135","answer":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"}]; // Array | + const result = await apiInstance.setMFAKBAConfigV1(kbaanswerrequestitemV1); + console.log(result); +- path: /mfa/v1/okta-verify/config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#set-mfa-okta-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const mfaoktaconfigV1: MfaoktaconfigV1 = {"mfaMethod":"okta-verify","enabled":true,"host":"www.example.com","accessKey":"dk778Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email"}; // MfaoktaconfigV1 | + const result = await apiInstance.setMFAOktaConfigV1(mfaoktaconfigV1); + console.log(result); +- path: /mfa/v1/{method}/test + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/mfa_configuration/methods/mfa-configuration#test-mfa-config-v1 + source: | + import { MFAConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MFAConfigurationV1Api(configuration); + const method: string = 'okta-verify'; // 'okta-verify' | 'duo-web' | The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. (default to undefined) + const result = await apiInstance.testMFAConfigV1(method); + console.log(result); diff --git a/sdk-output/mfa_configuration/docs/Methods/Index.md b/sdk-output/mfa_configuration/docs/Methods/Index.md new file mode 100644 index 00000000..04e13099 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: mfa_configuration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: mfa_configuration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'mfa_configuration', 'methods'] +slug: /tools/sdk/typescript/mfa_configuration/methods +tags: ['SDK', 'Software Development Kit', 'mfa_configuration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/mfa_configuration/docs/Methods/MFAConfigurationV1Api.md b/sdk-output/mfa_configuration/docs/Methods/MFAConfigurationV1Api.md new file mode 100644 index 00000000..acc71e20 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Methods/MFAConfigurationV1Api.md @@ -0,0 +1,284 @@ +--- +id: v1-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MFAConfiguration', 'v1MFAConfiguration'] +slug: /tools/sdk/typescript/mfa_configuration/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'v1MFAConfiguration'] +--- + +# MFAConfigurationV1Api + Configure and test multifactor authentication (MFA) methods +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-mfa-duo-config-v1**](#get-mfa-duo-config-v1) | **GET** `/mfa/v1/duo-web/config` | Configuration of duo mfa method +[**get-mfa-kba-config-v1**](#get-mfa-kba-config-v1) | **GET** `/mfa/v1/kba/config` | Configuration of kba mfa method +[**get-mfa-okta-config-v1**](#get-mfa-okta-config-v1) | **GET** `/mfa/v1/okta-verify/config` | Configuration of okta mfa method +[**set-mfa-duo-config-v1**](#set-mfa-duo-config-v1) | **PUT** `/mfa/v1/duo-web/config` | Set duo mfa configuration +[**set-mfakba-config-v1**](#set-mfakba-config-v1) | **POST** `/mfa/v1/kba/config/answers` | Set mfa kba configuration +[**set-mfa-okta-config-v1**](#set-mfa-okta-config-v1) | **PUT** `/mfa/v1/okta-verify/config` | Set okta mfa configuration +[**test-mfa-config-v1**](#test-mfa-config-v1) | **GET** `/mfa/v1/{method}/test` | Mfa method\'s test configuration + + +## get-mfa-duo-config-v1 +Configuration of duo mfa method +This API returns the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-mfa-duo-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**MfaduoconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const result = await apiInstance.getMFADuoConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-mfa-kba-config-v1 +Configuration of kba mfa method +This API returns the KBA configuration for MFA. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-mfa-kba-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**allLanguages** | **boolean** | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const allLanguages: boolean = allLanguages=true; // Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) +const result = await apiInstance.getMFAKbaConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-mfa-okta-config-v1 +Configuration of okta mfa method +This API returns the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-mfa-okta-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**MfaoktaconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const result = await apiInstance.getMFAOktaConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## set-mfa-duo-config-v1 +Set duo mfa configuration +This API sets the configuration of an Duo MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-mfa-duo-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**mfaduoconfigV1** | **MfaduoconfigV1** | | + +### Return type + +**MfaduoconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const mfaduoconfigV1: MfaduoconfigV1 = {"mfaMethod":"duo-web","enabled":true,"host":"www.example.com","accessKey":"qw123Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email","configProperties":{"skey":"12q3WERlcUHWJmiMqyCXI3uOF7EaDJTbdeOp6E2B","ikey":"Q123WE45R6TY7890ZXCV"}}; // +const result = await apiInstance.setMFADuoConfigV1(mfaduoconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-mfakba-config-v1 +Set mfa kba configuration +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-mfakba-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**kbaanswerrequestitemV1** | **Array<KbaanswerrequestitemV1>** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const kbaanswerrequestitemV1: Array<KbaanswerrequestitemV1> = [{"id":"173423","answer":"822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34"},{"id":"c54fee53-2d63-4fc5-9259-3e93b9994135","answer":"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"}]; // +const result = await apiInstance.setMFAKBAConfigV1(kbaanswerrequestitemV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-mfa-okta-config-v1 +Set okta mfa configuration +This API sets the configuration of an Okta MFA method. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-mfa-okta-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**mfaoktaconfigV1** | **MfaoktaconfigV1** | | + +### Return type + +**MfaoktaconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const mfaoktaconfigV1: MfaoktaconfigV1 = {"mfaMethod":"okta-verify","enabled":true,"host":"www.example.com","accessKey":"dk778Y3QlA5UqocYpdU3rEkzrK2D497y","identityAttribute":"email"}; // +const result = await apiInstance.setMFAOktaConfigV1(mfaoktaconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## test-mfa-config-v1 +Mfa method\'s test configuration +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-mfa-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**method** | **'okta-verify' | 'duo-web'** | The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. | [default to undefined] + +### Return type + +**MfaconfigtestresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MFAConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MFAConfigurationV1Api(configuration); +const method: string = okta-verify; // The name of the MFA method. The currently supported method names are \'okta-verify\' and \'duo-web\'. +const result = await apiInstance.testMFAConfigV1(method); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/mfa_configuration/docs/Models/Errormessagedto.md b/sdk-output/mfa_configuration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..3c80e460 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Errorresponsedto.md b/sdk-output/mfa_configuration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..aebe38f9 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1401Response.md b/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1401Response.md new file mode 100644 index 00000000..74d3dc58 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-mfa-okta-config-v1401-response-v1 +title: GetMFAOktaConfigV1401ResponseV1 +pagination_label: GetMFAOktaConfigV1401ResponseV1 +sidebar_label: GetMFAOktaConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMFAOktaConfigV1401ResponseV1', 'v1GetMFAOktaConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/get-mfa-okta-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMFAOktaConfigV1401ResponseV1', 'v1GetMFAOktaConfigV1401ResponseV1'] +--- + +# GetMFAOktaConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1429Response.md b/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1429Response.md new file mode 100644 index 00000000..b41dfe03 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/GetMFAOktaConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-mfa-okta-config-v1429-response-v1 +title: GetMFAOktaConfigV1429ResponseV1 +pagination_label: GetMFAOktaConfigV1429ResponseV1 +sidebar_label: GetMFAOktaConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMFAOktaConfigV1429ResponseV1', 'v1GetMFAOktaConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/get-mfa-okta-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMFAOktaConfigV1429ResponseV1', 'v1GetMFAOktaConfigV1429ResponseV1'] +--- + +# GetMFAOktaConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Index.md b/sdk-output/mfa_configuration/docs/Models/Index.md new file mode 100644 index 00000000..340b2436 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: mfa_configuration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: mfa_configuration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'mfa_configuration', 'models'] +slug: /tools/sdk/typescript/mfa_configuration/models +tags: ['SDK', 'Software Development Kit', 'mfa_configuration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/mfa_configuration/docs/Models/Kbaanswerrequestitem.md b/sdk-output/mfa_configuration/docs/Models/Kbaanswerrequestitem.md new file mode 100644 index 00000000..ce676d60 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Kbaanswerrequestitem.md @@ -0,0 +1,20 @@ +--- +id: v1-kbaanswerrequestitem-v1 +title: KbaanswerrequestitemV1 +pagination_label: KbaanswerrequestitemV1 +sidebar_label: KbaanswerrequestitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'KbaanswerrequestitemV1', 'v1KbaanswerrequestitemV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/kbaanswerrequestitem-v1 +tags: ['SDK', 'Software Development Kit', 'KbaanswerrequestitemV1', 'v1KbaanswerrequestitemV1'] +--- + +# KbaanswerrequestitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Question Id | [default to undefined] +**answer** | **string** | An answer for the KBA question | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Kbaanswerresponseitem.md b/sdk-output/mfa_configuration/docs/Models/Kbaanswerresponseitem.md new file mode 100644 index 00000000..757c4cd3 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Kbaanswerresponseitem.md @@ -0,0 +1,21 @@ +--- +id: v1-kbaanswerresponseitem-v1 +title: KbaanswerresponseitemV1 +pagination_label: KbaanswerresponseitemV1 +sidebar_label: KbaanswerresponseitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'KbaanswerresponseitemV1', 'v1KbaanswerresponseitemV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/kbaanswerresponseitem-v1 +tags: ['SDK', 'Software Development Kit', 'KbaanswerresponseitemV1', 'v1KbaanswerresponseitemV1'] +--- + +# KbaanswerresponseitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Question Id | [default to undefined] +**question** | **string** | Question description | [default to undefined] +**hasAnswer** | **boolean** | Denotes whether the KBA question has an answer configured for the current user | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Kbaquestion.md b/sdk-output/mfa_configuration/docs/Models/Kbaquestion.md new file mode 100644 index 00000000..fb5bb352 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Kbaquestion.md @@ -0,0 +1,22 @@ +--- +id: v1-kbaquestion-v1 +title: KbaquestionV1 +pagination_label: KbaquestionV1 +sidebar_label: KbaquestionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'KbaquestionV1', 'v1KbaquestionV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/kbaquestion-v1 +tags: ['SDK', 'Software Development Kit', 'KbaquestionV1', 'v1KbaquestionV1'] +--- + +# KbaquestionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | KBA Question Id | [default to undefined] +**text** | **string** | KBA Question description | [default to undefined] +**hasAnswer** | **boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [default to undefined] +**numAnswers** | **number** | Denotes the number of KBA configurations for this question | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Localeorigin.md b/sdk-output/mfa_configuration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..304baff4 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/mfa_configuration/docs/Models/Mfaconfigtestresponse.md b/sdk-output/mfa_configuration/docs/Models/Mfaconfigtestresponse.md new file mode 100644 index 00000000..3bd643e4 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Mfaconfigtestresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-mfaconfigtestresponse-v1 +title: MfaconfigtestresponseV1 +pagination_label: MfaconfigtestresponseV1 +sidebar_label: MfaconfigtestresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MfaconfigtestresponseV1', 'v1MfaconfigtestresponseV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/mfaconfigtestresponse-v1 +tags: ['SDK', 'Software Development Kit', 'MfaconfigtestresponseV1', 'v1MfaconfigtestresponseV1'] +--- + +# MfaconfigtestresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **(optional)** **string** | The configuration test result. | [readonly] [default to undefined] +**error** | **(optional)** **string** | The error message to indicate the failure of configuration test. | [readonly] [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Mfaduoconfig.md b/sdk-output/mfa_configuration/docs/Models/Mfaduoconfig.md new file mode 100644 index 00000000..9bdaa514 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Mfaduoconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-mfaduoconfig-v1 +title: MfaduoconfigV1 +pagination_label: MfaduoconfigV1 +sidebar_label: MfaduoconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MfaduoconfigV1', 'v1MfaduoconfigV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/mfaduoconfig-v1 +tags: ['SDK', 'Software Development Kit', 'MfaduoconfigV1', 'v1MfaduoconfigV1'] +--- + +# MfaduoconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfaMethod** | **(optional)** **string** | Mfa method name | [default to undefined] +**enabled** | **(optional)** **boolean** | If MFA method is enabled. | [default to false] +**host** | **(optional)** **string** | The server host name or IP address of the MFA provider. | [default to undefined] +**accessKey** | **(optional)** **string** | The secret key for authenticating requests to the MFA provider. | [default to undefined] +**identityAttribute** | **(optional)** **string** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [default to undefined] +**configProperties** | **(optional)** | A map with additional config properties for the given MFA method - duo-web. | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/Mfaoktaconfig.md b/sdk-output/mfa_configuration/docs/Models/Mfaoktaconfig.md new file mode 100644 index 00000000..94fb9806 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/Mfaoktaconfig.md @@ -0,0 +1,23 @@ +--- +id: v1-mfaoktaconfig-v1 +title: MfaoktaconfigV1 +pagination_label: MfaoktaconfigV1 +sidebar_label: MfaoktaconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MfaoktaconfigV1', 'v1MfaoktaconfigV1'] +slug: /tools/sdk/typescript/mfa_configuration/models/mfaoktaconfig-v1 +tags: ['SDK', 'Software Development Kit', 'MfaoktaconfigV1', 'v1MfaoktaconfigV1'] +--- + +# MfaoktaconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mfaMethod** | **(optional)** **string** | Mfa method name | [default to undefined] +**enabled** | **(optional)** **boolean** | If MFA method is enabled. | [default to false] +**host** | **(optional)** **string** | The server host name or IP address of the MFA provider. | [default to undefined] +**accessKey** | **(optional)** **string** | The secret key for authenticating requests to the MFA provider. | [default to undefined] +**identityAttribute** | **(optional)** **string** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [default to undefined] + diff --git a/sdk-output/mfa_configuration/docs/Models/README.md b/sdk-output/mfa_configuration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/mfa_configuration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/multi_host_integration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/multi_host_integration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e309cb74 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,227 @@ +- path: /multihosts/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#create-multi-host-integration-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostintegrationscreateV1: MultihostintegrationscreateV1 = ; // MultihostintegrationscreateV1 | The specifics of the Multi-Host Integration to create + const result = await apiInstance.createMultiHostIntegrationV1(multihostintegrationscreateV1); + console.log(result); +- path: /multihosts/v1/{multihostId} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#create-sources-within-multi-host-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = '2c91808568c529c60168cca6f90c1326'; // string | ID of the Multi-Host Integration. (default to undefined) + const multihostintegrationscreatesourcesV1: Array<MultihostintegrationscreatesourcesV1> = ; // Array | The specifics of the sources to create within Multi-Host Integration. + const result = await apiInstance.createSourcesWithinMultiHostV1(multihostId, multihostintegrationscreatesourcesV1); + console.log(result); +- path: /multihosts/v1/{multiHostId}/sources/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#delete-multi-host-sources-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multiHostId: string = '004091cb79b04636b88662afa50a4440'; // string | ID of the Multi-Host Integration (default to undefined) + const requestBody: Array<string> = ; // Array | The delete bulk sources within multi-host integration request body + const result = await apiInstance.deleteMultiHostSourcesV1(multiHostId, requestBody); + console.log(result); +- path: /multihosts/v1/{multihostId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#delete-multi-host-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = '2c91808568c529c60168cca6f90c1326'; // string | ID of Multi-Host Integration to delete. (default to undefined) + const result = await apiInstance.deleteMultiHostV1(multihostId); + console.log(result); +- path: /multihosts/v1/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-acct-aggregation-groups-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = 'aMultiHostId'; // string | ID of the Multi-Host Integration to update (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.getAcctAggregationGroupsV1(multihostId); + console.log(result); +- path: /multihosts/v1/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-entitlement-aggregation-groups-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multiHostId: string = 'aMultiHostId'; // string | ID of the Multi-Host Integration to update (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.getEntitlementAggregationGroupsV1(multiHostId); + console.log(result); +- path: /multihosts/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-multi-host-integrations-list-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const filters: string = 'id eq 2c91808b6ef1d43e016efba0ce470904'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) (default to undefined) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const forSubadmin: string = '5168015d32f890ca15812c9180835d2e'; // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) (default to undefined) + const result = await apiInstance.getMultiHostIntegrationsListV1(); + console.log(result); +- path: /multihosts/v1/{multihostId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-multi-host-integrations-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = '2c91808568c529c60168cca6f90c1326'; // string | ID of the Multi-Host Integration. (default to undefined) + const result = await apiInstance.getMultiHostIntegrationsV1(multihostId); + console.log(result); +- path: /multihosts/v1/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-multi-host-source-creation-errors-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multiHostId: string = '004091cb79b04636b88662afa50a4440'; // string | ID of the Multi-Host Integration (default to undefined) + const result = await apiInstance.getMultiHostSourceCreationErrorsV1(multiHostId); + console.log(result); +- path: /multihosts/v1/types + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-multihost-integration-types-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const result = await apiInstance.getMultihostIntegrationTypesV1(); + console.log(result); +- path: /multihosts/v1/{multihostId}/sources + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#get-sources-within-multi-host-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = 'aMultiHostId'; // string | ID of the Multi-Host Integration to update (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const filters: string = 'id eq 2c91808b6ef1d43e016efba0ce470904'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) (default to undefined) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getSourcesWithinMultiHostV1(multihostId); + console.log(result); +- path: /multihosts/v1/{multihostId}/sources/testConnection + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#test-connection-multi-host-sources-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = '2c91808568c529c60168cca6f90c1324'; // string | ID of the Multi-Host Integration (default to undefined) + const result = await apiInstance.testConnectionMultiHostSourcesV1(multihostId); + console.log(result); +- path: /multihosts/v1/{multihostId}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#test-source-connection-multihost-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = '2c91808568c529c60168cca6f90c1326'; // string | ID of the Multi-Host Integration (default to undefined) + const sourceId: string = '2c91808568c529f60168cca6f90c1324'; // string | ID of the source within the Multi-Host Integration (default to undefined) + const result = await apiInstance.testSourceConnectionMultihostV1(multihostId, sourceId); + console.log(result); +- path: /multihosts/v1/{multihostId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/multi_host_integration/methods/multi-host-integration#update-multi-host-sources-v1 + source: | + import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new MultiHostIntegrationV1Api(configuration); + const multihostId: string = 'anId'; // string | ID of the Multi-Host Integration to update. (default to undefined) + const updateMultiHostSourcesV1RequestInnerV1: Array<UpdateMultiHostSourcesV1RequestInnerV1> = [{"op":"add","path":"/description","value":"MDK Multi-Host Integration 222 description"}]; // Array | This endpoint allows you to update a Multi-Host Integration. + const result = await apiInstance.updateMultiHostSourcesV1(multihostId, updateMultiHostSourcesV1RequestInnerV1); + console.log(result); diff --git a/sdk-output/multi_host_integration/docs/Methods/Index.md b/sdk-output/multi_host_integration/docs/Methods/Index.md new file mode 100644 index 00000000..e0b1d514 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: multi_host_integration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: multi_host_integration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'multi_host_integration', 'methods'] +slug: /tools/sdk/typescript/multi_host_integration/methods +tags: ['SDK', 'Software Development Kit', 'multi_host_integration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/multi_host_integration/docs/Methods/MultiHostIntegrationV1Api.md b/sdk-output/multi_host_integration/docs/Methods/MultiHostIntegrationV1Api.md new file mode 100644 index 00000000..721b2f26 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Methods/MultiHostIntegrationV1Api.md @@ -0,0 +1,627 @@ +--- +id: v1-multi-host-integration +title: MultiHostIntegration +pagination_label: MultiHostIntegration +sidebar_label: MultiHostIntegration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultiHostIntegration', 'v1MultiHostIntegration'] +slug: /tools/sdk/typescript/multi_host_integration/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'v1MultiHostIntegration'] +--- + +# MultiHostIntegrationV1Api + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-multi-host-integration-v1**](#create-multi-host-integration-v1) | **POST** `/multihosts/v1` | Create multi-host integration +[**create-sources-within-multi-host-v1**](#create-sources-within-multi-host-v1) | **POST** `/multihosts/v1/{multihostId}` | Create sources within multi-host integration +[**delete-multi-host-sources-v1**](#delete-multi-host-sources-v1) | **POST** `/multihosts/v1/{multiHostId}/sources/bulk-delete` | Delete sources within multi-host integration +[**delete-multi-host-v1**](#delete-multi-host-v1) | **DELETE** `/multihosts/v1/{multihostId}` | Delete multi-host integration +[**get-acct-aggregation-groups-v1**](#get-acct-aggregation-groups-v1) | **GET** `/multihosts/v1/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id +[**get-entitlement-aggregation-groups-v1**](#get-entitlement-aggregation-groups-v1) | **GET** `/multihosts/v1/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id +[**get-multi-host-integrations-list-v1**](#get-multi-host-integrations-list-v1) | **GET** `/multihosts/v1` | List all existing multi-host integrations +[**get-multi-host-integrations-v1**](#get-multi-host-integrations-v1) | **GET** `/multihosts/v1/{multihostId}` | Get multi-host integration by id +[**get-multi-host-source-creation-errors-v1**](#get-multi-host-source-creation-errors-v1) | **GET** `/multihosts/v1/{multiHostId}/sources/errors` | List multi-host source creation errors +[**get-multihost-integration-types-v1**](#get-multihost-integration-types-v1) | **GET** `/multihosts/v1/types` | List multi-host integration types +[**get-sources-within-multi-host-v1**](#get-sources-within-multi-host-v1) | **GET** `/multihosts/v1/{multihostId}/sources` | List sources within multi-host integration +[**test-connection-multi-host-sources-v1**](#test-connection-multi-host-sources-v1) | **POST** `/multihosts/v1/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**test-source-connection-multihost-v1**](#test-source-connection-multihost-v1) | **GET** `/multihosts/v1/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration\'s single source +[**update-multi-host-sources-v1**](#update-multi-host-sources-v1) | **PATCH** `/multihosts/v1/{multihostId}` | Update multi-host integration + + +## create-multi-host-integration-v1 +Create multi-host integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-multi-host-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostintegrationscreateV1** | **MultihostintegrationscreateV1** | The specifics of the Multi-Host Integration to create | + +### Return type + +**MultihostintegrationsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostintegrationscreateV1: MultihostintegrationscreateV1 = ; // The specifics of the Multi-Host Integration to create +const result = await apiInstance.createMultiHostIntegrationV1(multihostintegrationscreateV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-sources-within-multi-host-v1 +Create sources within multi-host integration +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-sources-within-multi-host-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration. | [default to undefined] +**multihostintegrationscreatesourcesV1** | **Array<MultihostintegrationscreatesourcesV1>** | The specifics of the sources to create within Multi-Host Integration. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = 2c91808568c529c60168cca6f90c1326; // ID of the Multi-Host Integration. +const multihostintegrationscreatesourcesV1: Array<MultihostintegrationscreatesourcesV1> = ; // The specifics of the sources to create within Multi-Host Integration. +const result = await apiInstance.createSourcesWithinMultiHostV1(multihostId, multihostintegrationscreatesourcesV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-multi-host-sources-v1 +Delete sources within multi-host integration +This endpoint performs bulk sources delete within Multi-Host Integration via a list of supplied IDs. + +The following rights are required to access this endpoint: idn:multihosts:delete, idn:sources:delete + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-multi-host-sources-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multiHostId** | **string** | ID of the Multi-Host Integration | [default to undefined] +**requestBody** | **Array<string>** | The delete bulk sources within multi-host integration request body | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multiHostId: string = 004091cb79b04636b88662afa50a4440; // ID of the Multi-Host Integration +const requestBody: Array<string> = ; // The delete bulk sources within multi-host integration request body +const result = await apiInstance.deleteMultiHostSourcesV1(multiHostId, requestBody); +console.log(result); +``` + +[[Back to top]](#) + +## delete-multi-host-v1 +Delete multi-host integration +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-multi-host-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of Multi-Host Integration to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = 2c91808568c529c60168cca6f90c1326; // ID of Multi-Host Integration to delete. +const result = await apiInstance.deleteMultiHostV1(multihostId); +console.log(result); +``` + +[[Back to top]](#) + +## get-acct-aggregation-groups-v1 +List account-aggregation-groups by multi-host id +This API will return array of account aggregation groups within provided Multi-Host Integration ID. +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-acct-aggregation-groups-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration to update | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = aMultiHostId; // ID of the Multi-Host Integration to update +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getAcctAggregationGroupsV1(multihostId); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-aggregation-groups-v1 +List entitlement-aggregation-groups by integration id +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-aggregation-groups-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multiHostId** | **string** | ID of the Multi-Host Integration to update | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multiHostId: string = aMultiHostId; // ID of the Multi-Host Integration to update +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getEntitlementAggregationGroupsV1(multiHostId); +console.log(result); +``` + +[[Back to top]](#) + +## get-multi-host-integrations-list-v1 +List all existing multi-host integrations +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-multi-host-integrations-list-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* | [optional] [default to undefined] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const filters: string = id eq 2c91808b6ef1d43e016efba0ce470904; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const forSubadmin: string = 5168015d32f890ca15812c9180835d2e; // If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +const result = await apiInstance.getMultiHostIntegrationsListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-multi-host-integrations-v1 +Get multi-host integration by id +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-multi-host-integrations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration. | [default to undefined] + +### Return type + +**MultihostintegrationsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = 2c91808568c529c60168cca6f90c1326; // ID of the Multi-Host Integration. +const result = await apiInstance.getMultiHostIntegrationsV1(multihostId); +console.log(result); +``` + +[[Back to top]](#) + +## get-multi-host-source-creation-errors-v1 +List multi-host source creation errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-multi-host-source-creation-errors-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multiHostId** | **string** | ID of the Multi-Host Integration | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multiHostId: string = 004091cb79b04636b88662afa50a4440; // ID of the Multi-Host Integration +const result = await apiInstance.getMultiHostSourceCreationErrorsV1(multiHostId); +console.log(result); +``` + +[[Back to top]](#) + +## get-multihost-integration-types-v1 +List multi-host integration types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-multihost-integration-types-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const result = await apiInstance.getMultihostIntegrationTypesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-sources-within-multi-host-v1 +List sources within multi-host integration +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sources-within-multi-host-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration to update | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* | [optional] [default to undefined] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = aMultiHostId; // ID of the Multi-Host Integration to update +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const filters: string = id eq 2c91808b6ef1d43e016efba0ce470904; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getSourcesWithinMultiHostV1(multihostId); +console.log(result); +``` + +[[Back to top]](#) + +## test-connection-multi-host-sources-v1 +Test configuration for multi-host integration +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-connection-multi-host-sources-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = 2c91808568c529c60168cca6f90c1324; // ID of the Multi-Host Integration +const result = await apiInstance.testConnectionMultiHostSourcesV1(multihostId); +console.log(result); +``` + +[[Back to top]](#) + +## test-source-connection-multihost-v1 +Test configuration for multi-host integration\'s single source +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-source-connection-multihost-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration | [default to undefined] +**sourceId** | **string** | ID of the source within the Multi-Host Integration | [default to undefined] + +### Return type + +**TestSourceConnectionMultihostV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = 2c91808568c529c60168cca6f90c1326; // ID of the Multi-Host Integration +const sourceId: string = 2c91808568c529f60168cca6f90c1324; // ID of the source within the Multi-Host Integration +const result = await apiInstance.testSourceConnectionMultihostV1(multihostId, sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## update-multi-host-sources-v1 +Update multi-host integration +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-multi-host-sources-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multihostId** | **string** | ID of the Multi-Host Integration to update. | [default to undefined] +**updateMultiHostSourcesV1RequestInnerV1** | **Array<UpdateMultiHostSourcesV1RequestInnerV1>** | This endpoint allows you to update a Multi-Host Integration. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { MultiHostIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new MultiHostIntegrationV1Api(configuration); +const multihostId: string = anId; // ID of the Multi-Host Integration to update. +const updateMultiHostSourcesV1RequestInnerV1: Array<UpdateMultiHostSourcesV1RequestInnerV1> = [{"op":"add","path":"/description","value":"MDK Multi-Host Integration 222 description"}]; // This endpoint allows you to update a Multi-Host Integration. +const result = await apiInstance.updateMultiHostSourcesV1(multihostId, updateMultiHostSourcesV1RequestInnerV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/multi_host_integration/docs/Models/ArrayInner.md b/sdk-output/multi_host_integration/docs/Models/ArrayInner.md new file mode 100644 index 00000000..622e7147 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/multi_host_integration/docs/Models/Errormessagedto.md b/sdk-output/multi_host_integration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..97a06f40 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Errorresponsedto.md b/sdk-output/multi_host_integration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..4792906e --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1401Response.md b/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1401Response.md new file mode 100644 index 00000000..a3b49a49 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-multi-host-integrations-list-v1401-response-v1 +title: GetMultiHostIntegrationsListV1401ResponseV1 +pagination_label: GetMultiHostIntegrationsListV1401ResponseV1 +sidebar_label: GetMultiHostIntegrationsListV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMultiHostIntegrationsListV1401ResponseV1', 'v1GetMultiHostIntegrationsListV1401ResponseV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/get-multi-host-integrations-list-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMultiHostIntegrationsListV1401ResponseV1', 'v1GetMultiHostIntegrationsListV1401ResponseV1'] +--- + +# GetMultiHostIntegrationsListV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1429Response.md b/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1429Response.md new file mode 100644 index 00000000..25f55b7a --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/GetMultiHostIntegrationsListV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-multi-host-integrations-list-v1429-response-v1 +title: GetMultiHostIntegrationsListV1429ResponseV1 +pagination_label: GetMultiHostIntegrationsListV1429ResponseV1 +sidebar_label: GetMultiHostIntegrationsListV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetMultiHostIntegrationsListV1429ResponseV1', 'v1GetMultiHostIntegrationsListV1429ResponseV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/get-multi-host-integrations-list-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetMultiHostIntegrationsListV1429ResponseV1', 'v1GetMultiHostIntegrationsListV1429ResponseV1'] +--- + +# GetMultiHostIntegrationsListV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Index.md b/sdk-output/multi_host_integration/docs/Models/Index.md new file mode 100644 index 00000000..070a568d --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: multi_host_integration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: multi_host_integration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'multi_host_integration', 'models'] +slug: /tools/sdk/typescript/multi_host_integration/models +tags: ['SDK', 'Software Development Kit', 'multi_host_integration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/multi_host_integration/docs/Models/Localeorigin.md b/sdk-output/multi_host_integration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..0e6ba637 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/multi_host_integration/docs/Models/Managercorrelationmapping.md b/sdk-output/multi_host_integration/docs/Models/Managercorrelationmapping.md new file mode 100644 index 00000000..a6caa96d --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Managercorrelationmapping.md @@ -0,0 +1,20 @@ +--- +id: v1-managercorrelationmapping-v1 +title: ManagercorrelationmappingV1 +pagination_label: ManagercorrelationmappingV1 +sidebar_label: ManagercorrelationmappingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagercorrelationmappingV1', 'v1ManagercorrelationmappingV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/managercorrelationmapping-v1 +tags: ['SDK', 'Software Development Kit', 'ManagercorrelationmappingV1', 'v1ManagercorrelationmappingV1'] +--- + +# ManagercorrelationmappingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountAttributeName** | **(optional)** **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. | [default to undefined] +**identityAttributeName** | **(optional)** **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostintegrations.md b/sdk-output/multi_host_integration/docs/Models/Multihostintegrations.md new file mode 100644 index 00000000..e5e0ff95 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostintegrations.md @@ -0,0 +1,50 @@ +--- +id: v1-multihostintegrations-v1 +title: MultihostintegrationsV1 +pagination_label: MultihostintegrationsV1 +sidebar_label: MultihostintegrationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsV1', 'v1MultihostintegrationsV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsV1', 'v1MultihostintegrationsV1'] +--- + +# MultihostintegrationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Multi-Host Integration ID. | [readonly] [default to undefined] +**name** | **string** | Multi-Host Integration\'s human-readable name. | [default to undefined] +**description** | **string** | Multi-Host Integration\'s human-readable description. | [default to undefined] +**owner** | **MultihostintegrationsOwnerV1** | | [default to undefined] +**cluster** | **(optional)** **MultihostintegrationsClusterV1** | | [default to undefined] +**accountCorrelationConfig** | **(optional)** **MultihostintegrationsAccountCorrelationConfigV1** | | [default to undefined] +**accountCorrelationRule** | **(optional)** **MultihostintegrationsAccountCorrelationRuleV1** | | [default to undefined] +**managerCorrelationMapping** | **(optional)** **MultihostintegrationsManagerCorrelationMappingV1** | | [default to undefined] +**managerCorrelationRule** | **(optional)** **MultihostintegrationsManagerCorrelationRuleV1** | | [default to undefined] +**beforeProvisioningRule** | **(optional)** **MultihostintegrationsBeforeProvisioningRuleV1** | | [default to undefined] +**schemas** | **(optional)** **Array<MultihostintegrationsSchemasInnerV1>** | List of references to schema objects. | [default to undefined] +**passwordPolicies** | **(optional)** **Array<MultihostintegrationsPasswordPoliciesInnerV1>** | List of references to the associated PasswordPolicy objects. | [default to undefined] +**features** | **(optional)** **Array<string>** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [default to undefined] +**type** | **(optional)** **string** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [default to undefined] +**connector** | **string** | Connector script name. | [default to undefined] +**connectorClass** | **(optional)** **string** | Fully qualified name of the Java class that implements the connector interface. | [default to undefined] +**connectorAttributes** | **(optional)** **MultihostintegrationsConnectorAttributesV1** | | [default to undefined] +**deleteThreshold** | **(optional)** **number** | Number from 0 to 100 that specifies when to skip the delete phase. | [default to undefined] +**authoritative** | **(optional)** **boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [default to false] +**managementWorkgroup** | **(optional)** **MultihostintegrationsManagementWorkgroupV1** | | [default to undefined] +**healthy** | **(optional)** **boolean** | When this is true, it indicates that the source is healthy. | [default to false] +**status** | **(optional)** **string** | Status identifier that gives specific information about why a source is or isn\'t healthy. | [default to undefined] +**since** | **(optional)** **string** | Timestamp that shows when a source health check was last performed. | [default to undefined] +**connectorId** | **(optional)** **string** | Connector ID | [default to undefined] +**connectorName** | **(optional)** **string** | Name of the connector that was chosen during source creation. | [default to undefined] +**connectionType** | **(optional)** **string** | Type of connection (direct or file). | [default to undefined] +**connectorImplementationId** | **(optional)** **string** | Connector implementation ID. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the source was created | [default to undefined] +**modified** | **(optional)** **string** | Date-time when the source was last modified. | [default to undefined] +**credentialProviderEnabled** | **(optional)** **boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [default to false] +**category** | **(optional)** **string** | Source category (e.g. null, CredentialProvider). | [default to undefined] +**accountsFile** | **(optional)** **MultihostintegrationsAccountsFileV1** | | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationConfig.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationConfig.md new file mode 100644 index 00000000..86fd1220 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationConfig.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-account-correlation-config-v1 +title: MultihostintegrationsAccountCorrelationConfigV1 +pagination_label: MultihostintegrationsAccountCorrelationConfigV1 +sidebar_label: MultihostintegrationsAccountCorrelationConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsAccountCorrelationConfigV1', 'v1MultihostintegrationsAccountCorrelationConfigV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-account-correlation-config-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsAccountCorrelationConfigV1', 'v1MultihostintegrationsAccountCorrelationConfigV1'] +--- + +# MultihostintegrationsAccountCorrelationConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Account correlation config ID. | [default to undefined] +**name** | **(optional)** **string** | Account correlation config\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationRule.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationRule.md new file mode 100644 index 00000000..7436fd4b --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountCorrelationRule.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-account-correlation-rule-v1 +title: MultihostintegrationsAccountCorrelationRuleV1 +pagination_label: MultihostintegrationsAccountCorrelationRuleV1 +sidebar_label: MultihostintegrationsAccountCorrelationRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsAccountCorrelationRuleV1', 'v1MultihostintegrationsAccountCorrelationRuleV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-account-correlation-rule-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsAccountCorrelationRuleV1', 'v1MultihostintegrationsAccountCorrelationRuleV1'] +--- + +# MultihostintegrationsAccountCorrelationRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountsFile.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountsFile.md new file mode 100644 index 00000000..c17c5bf6 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsAccountsFile.md @@ -0,0 +1,23 @@ +--- +id: v1-multihostintegrations-accounts-file-v1 +title: MultihostintegrationsAccountsFileV1 +pagination_label: MultihostintegrationsAccountsFileV1 +sidebar_label: MultihostintegrationsAccountsFileV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsAccountsFileV1', 'v1MultihostintegrationsAccountsFileV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-accounts-file-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsAccountsFileV1', 'v1MultihostintegrationsAccountsFileV1'] +--- + +# MultihostintegrationsAccountsFileV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the accounts file. | [default to undefined] +**key** | **(optional)** **string** | The accounts file key. | [default to undefined] +**uploadTime** | **(optional)** **string** | Date-time when the file was uploaded | [default to undefined] +**expiry** | **(optional)** **string** | Date-time when the accounts file expired. | [default to undefined] +**expired** | **(optional)** **boolean** | If this is true, it indicates that the accounts file has expired. | [default to false] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsBeforeProvisioningRule.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsBeforeProvisioningRule.md new file mode 100644 index 00000000..382f3e01 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsBeforeProvisioningRule.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-before-provisioning-rule-v1 +title: MultihostintegrationsBeforeProvisioningRuleV1 +pagination_label: MultihostintegrationsBeforeProvisioningRuleV1 +sidebar_label: MultihostintegrationsBeforeProvisioningRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsBeforeProvisioningRuleV1', 'v1MultihostintegrationsBeforeProvisioningRuleV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-before-provisioning-rule-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsBeforeProvisioningRuleV1', 'v1MultihostintegrationsBeforeProvisioningRuleV1'] +--- + +# MultihostintegrationsBeforeProvisioningRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsCluster.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsCluster.md new file mode 100644 index 00000000..d3db3a09 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsCluster.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-cluster-v1 +title: MultihostintegrationsClusterV1 +pagination_label: MultihostintegrationsClusterV1 +sidebar_label: MultihostintegrationsClusterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsClusterV1', 'v1MultihostintegrationsClusterV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-cluster-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsClusterV1', 'v1MultihostintegrationsClusterV1'] +--- + +# MultihostintegrationsClusterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of object being referenced. | [default to undefined] +**id** | **string** | Cluster ID. | [default to undefined] +**name** | **string** | Cluster\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributes.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributes.md new file mode 100644 index 00000000..d21dcf8c --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributes.md @@ -0,0 +1,25 @@ +--- +id: v1-multihostintegrations-connector-attributes-v1 +title: MultihostintegrationsConnectorAttributesV1 +pagination_label: MultihostintegrationsConnectorAttributesV1 +sidebar_label: MultihostintegrationsConnectorAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsConnectorAttributesV1', 'v1MultihostintegrationsConnectorAttributesV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-connector-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsConnectorAttributesV1', 'v1MultihostintegrationsConnectorAttributesV1'] +--- + +# MultihostintegrationsConnectorAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maxAllowedSources** | **(optional)** **number** | Maximum sources allowed count of a Multi-Host Integration | [default to undefined] +**lastSourceUploadCount** | **(optional)** **number** | Last upload sources count of a Multi-Host Integration | [default to undefined] +**connectorFileUploadHistory** | **(optional)** **MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1** | | [default to undefined] +**multihost_status** | **(optional)** **string** | Multi-Host integration status. | [default to undefined] +**showAccountSchema** | **(optional)** **boolean** | Show account schema | [default to true] +**showEntitlementSchema** | **(optional)** **boolean** | Show entitlement schema | [default to true] +**multiHostAttributes** | **(optional)** **MultihostintegrationsConnectorAttributesMultiHostAttributesV1** | | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesConnectorFileUploadHistory.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 00000000..d39b34a0 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,19 @@ +--- +id: v1-multihostintegrations-connector-attributes-connector-file-upload-history-v1 +title: MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 +pagination_label: MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 +sidebar_label: MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1', 'v1MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-connector-attributes-connector-file-upload-history-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1', 'v1MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1'] +--- + +# MultihostintegrationsConnectorAttributesConnectorFileUploadHistoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connectorFileNameUploadedDate** | **(optional)** **string** | File name of the connector JAR | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesMultiHostAttributes.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 00000000..6a4978ae --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,22 @@ +--- +id: v1-multihostintegrations-connector-attributes-multi-host-attributes-v1 +title: MultihostintegrationsConnectorAttributesMultiHostAttributesV1 +pagination_label: MultihostintegrationsConnectorAttributesMultiHostAttributesV1 +sidebar_label: MultihostintegrationsConnectorAttributesMultiHostAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsConnectorAttributesMultiHostAttributesV1', 'v1MultihostintegrationsConnectorAttributesMultiHostAttributesV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-connector-attributes-multi-host-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsConnectorAttributesMultiHostAttributesV1', 'v1MultihostintegrationsConnectorAttributesMultiHostAttributesV1'] +--- + +# MultihostintegrationsConnectorAttributesMultiHostAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**password** | **(optional)** **string** | Password. | [default to undefined] +**connector_files** | **(optional)** **string** | Connector file. | [default to undefined] +**authType** | **(optional)** **string** | Authentication type. | [default to undefined] +**user** | **(optional)** **string** | Username. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagementWorkgroup.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagementWorkgroup.md new file mode 100644 index 00000000..feef9229 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagementWorkgroup.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-management-workgroup-v1 +title: MultihostintegrationsManagementWorkgroupV1 +pagination_label: MultihostintegrationsManagementWorkgroupV1 +sidebar_label: MultihostintegrationsManagementWorkgroupV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsManagementWorkgroupV1', 'v1MultihostintegrationsManagementWorkgroupV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-management-workgroup-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsManagementWorkgroupV1', 'v1MultihostintegrationsManagementWorkgroupV1'] +--- + +# MultihostintegrationsManagementWorkgroupV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Management workgroup ID. | [default to undefined] +**name** | **(optional)** **string** | Management workgroup\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationMapping.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationMapping.md new file mode 100644 index 00000000..c2d792c2 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationMapping.md @@ -0,0 +1,20 @@ +--- +id: v1-multihostintegrations-manager-correlation-mapping-v1 +title: MultihostintegrationsManagerCorrelationMappingV1 +pagination_label: MultihostintegrationsManagerCorrelationMappingV1 +sidebar_label: MultihostintegrationsManagerCorrelationMappingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsManagerCorrelationMappingV1', 'v1MultihostintegrationsManagerCorrelationMappingV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-manager-correlation-mapping-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsManagerCorrelationMappingV1', 'v1MultihostintegrationsManagerCorrelationMappingV1'] +--- + +# MultihostintegrationsManagerCorrelationMappingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountAttributeName** | **(optional)** **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. | [default to undefined] +**identityAttributeName** | **(optional)** **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationRule.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationRule.md new file mode 100644 index 00000000..8f02e120 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsManagerCorrelationRule.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-manager-correlation-rule-v1 +title: MultihostintegrationsManagerCorrelationRuleV1 +pagination_label: MultihostintegrationsManagerCorrelationRuleV1 +sidebar_label: MultihostintegrationsManagerCorrelationRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsManagerCorrelationRuleV1', 'v1MultihostintegrationsManagerCorrelationRuleV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-manager-correlation-rule-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsManagerCorrelationRuleV1', 'v1MultihostintegrationsManagerCorrelationRuleV1'] +--- + +# MultihostintegrationsManagerCorrelationRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsOwner.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsOwner.md new file mode 100644 index 00000000..e9c39917 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-owner-v1 +title: MultihostintegrationsOwnerV1 +pagination_label: MultihostintegrationsOwnerV1 +sidebar_label: MultihostintegrationsOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsOwnerV1', 'v1MultihostintegrationsOwnerV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-owner-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsOwnerV1', 'v1MultihostintegrationsOwnerV1'] +--- + +# MultihostintegrationsOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Owner identity\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Owner identity\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsPasswordPoliciesInner.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsPasswordPoliciesInner.md new file mode 100644 index 00000000..a81d60fb --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsPasswordPoliciesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-password-policies-inner-v1 +title: MultihostintegrationsPasswordPoliciesInnerV1 +pagination_label: MultihostintegrationsPasswordPoliciesInnerV1 +sidebar_label: MultihostintegrationsPasswordPoliciesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsPasswordPoliciesInnerV1', 'v1MultihostintegrationsPasswordPoliciesInnerV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-password-policies-inner-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsPasswordPoliciesInnerV1', 'v1MultihostintegrationsPasswordPoliciesInnerV1'] +--- + +# MultihostintegrationsPasswordPoliciesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Policy ID. | [default to undefined] +**name** | **(optional)** **string** | Policy\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsSchemasInner.md b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsSchemasInner.md new file mode 100644 index 00000000..618727f3 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostintegrationsSchemasInner.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrations-schemas-inner-v1 +title: MultihostintegrationsSchemasInnerV1 +pagination_label: MultihostintegrationsSchemasInnerV1 +sidebar_label: MultihostintegrationsSchemasInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsSchemasInnerV1', 'v1MultihostintegrationsSchemasInnerV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrations-schemas-inner-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsSchemasInnerV1', 'v1MultihostintegrationsSchemasInnerV1'] +--- + +# MultihostintegrationsSchemasInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Schema ID. | [default to undefined] +**name** | **(optional)** **string** | Schema\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostintegrationsaggscheduleupdate.md b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationsaggscheduleupdate.md new file mode 100644 index 00000000..92e15ef9 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationsaggscheduleupdate.md @@ -0,0 +1,26 @@ +--- +id: v1-multihostintegrationsaggscheduleupdate-v1 +title: MultihostintegrationsaggscheduleupdateV1 +pagination_label: MultihostintegrationsaggscheduleupdateV1 +sidebar_label: MultihostintegrationsaggscheduleupdateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationsaggscheduleupdateV1', 'v1MultihostintegrationsaggscheduleupdateV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrationsaggscheduleupdate-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationsaggscheduleupdateV1', 'v1MultihostintegrationsaggscheduleupdateV1'] +--- + +# MultihostintegrationsaggscheduleupdateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**multihostId** | **string** | Multi-Host Integration ID. The ID must be unique | [default to undefined] +**aggregation_grp_id** | **string** | Multi-Host Integration aggregation group ID | [default to undefined] +**aggregation_grp_name** | **string** | Multi-Host Integration name | [default to undefined] +**aggregation_cron_schedule** | **string** | Cron expression to schedule aggregation | [default to undefined] +**enableSchedule** | **boolean** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [default to false] +**source_id_list** | **Array<string>** | Source IDs of the Multi-Host Integration | [default to undefined] +**created** | **(optional)** **string** | Created date of Multi-Host Integration aggregation schedule | [default to undefined] +**modified** | **(optional)** **string** | Modified date of Multi-Host Integration aggregation schedule | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreate.md b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreate.md new file mode 100644 index 00000000..88cec385 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreate.md @@ -0,0 +1,27 @@ +--- +id: v1-multihostintegrationscreate-v1 +title: MultihostintegrationscreateV1 +pagination_label: MultihostintegrationscreateV1 +sidebar_label: MultihostintegrationscreateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationscreateV1', 'v1MultihostintegrationscreateV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrationscreate-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationscreateV1', 'v1MultihostintegrationscreateV1'] +--- + +# MultihostintegrationscreateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Multi-Host Integration\'s human-readable name. | [default to undefined] +**description** | **string** | Multi-Host Integration\'s human-readable description. | [default to undefined] +**owner** | **MultihostintegrationsOwnerV1** | | [default to undefined] +**cluster** | **(optional)** **MultihostintegrationsClusterV1** | | [default to undefined] +**connector** | **string** | Connector script name. | [default to undefined] +**connectorAttributes** | **(optional)** | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [default to undefined] +**managementWorkgroup** | **(optional)** **MultihostintegrationsManagementWorkgroupV1** | | [default to undefined] +**created** | **(optional)** **string** | Date-time when the source was created | [default to undefined] +**modified** | **(optional)** **string** | Date-time when the source was last modified. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreatesources.md b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreatesources.md new file mode 100644 index 00000000..8d8c4452 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationscreatesources.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrationscreatesources-v1 +title: MultihostintegrationscreatesourcesV1 +pagination_label: MultihostintegrationscreatesourcesV1 +sidebar_label: MultihostintegrationscreatesourcesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationscreatesourcesV1', 'v1MultihostintegrationscreatesourcesV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrationscreatesources-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationscreatesourcesV1', 'v1MultihostintegrationscreatesourcesV1'] +--- + +# MultihostintegrationscreatesourcesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Source\'s human-readable name. | [default to undefined] +**description** | **(optional)** **string** | Source\'s human-readable description. | [default to undefined] +**connectorAttributes** | **(optional)** | Connector specific configuration. This configuration will differ from type to type. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostintegrationtemplatetype.md b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationtemplatetype.md new file mode 100644 index 00000000..1c65b4bf --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostintegrationtemplatetype.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostintegrationtemplatetype-v1 +title: MultihostintegrationtemplatetypeV1 +pagination_label: MultihostintegrationtemplatetypeV1 +sidebar_label: MultihostintegrationtemplatetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostintegrationtemplatetypeV1', 'v1MultihostintegrationtemplatetypeV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostintegrationtemplatetype-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostintegrationtemplatetypeV1', 'v1MultihostintegrationtemplatetypeV1'] +--- + +# MultihostintegrationtemplatetypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | This is the name of the type. | [default to undefined] +**type** | **string** | This is the type value for the type. | [default to undefined] +**scriptName** | **string** | This is the scriptName attribute value for the type. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/Multihostsources.md b/sdk-output/multi_host_integration/docs/Models/Multihostsources.md new file mode 100644 index 00000000..8a547e47 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Multihostsources.md @@ -0,0 +1,49 @@ +--- +id: v1-multihostsources-v1 +title: MultihostsourcesV1 +pagination_label: MultihostsourcesV1 +sidebar_label: MultihostsourcesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostsourcesV1', 'v1MultihostsourcesV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostsources-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostsourcesV1', 'v1MultihostsourcesV1'] +--- + +# MultihostsourcesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Source ID. | [readonly] [default to undefined] +**name** | **string** | Source\'s human-readable name. | [default to undefined] +**description** | **(optional)** **string** | Source\'s human-readable description. | [default to undefined] +**owner** | **MultihostintegrationsOwnerV1** | | [default to undefined] +**cluster** | **(optional)** **MultihostintegrationsClusterV1** | | [default to undefined] +**accountCorrelationConfig** | **(optional)** **MultihostintegrationsAccountCorrelationConfigV1** | | [default to undefined] +**accountCorrelationRule** | **(optional)** **MultihostintegrationsAccountCorrelationRuleV1** | | [default to undefined] +**managerCorrelationMapping** | **(optional)** **ManagercorrelationmappingV1** | | [default to undefined] +**managerCorrelationRule** | **(optional)** **MultihostintegrationsManagerCorrelationRuleV1** | | [default to undefined] +**beforeProvisioningRule** | **(optional)** **MultihostsourcesBeforeProvisioningRuleV1** | | [default to undefined] +**schemas** | **(optional)** **Array<MultihostintegrationsSchemasInnerV1>** | List of references to schema objects. | [default to undefined] +**passwordPolicies** | **(optional)** **Array<MultihostintegrationsPasswordPoliciesInnerV1>** | List of references to the associated PasswordPolicy objects. | [default to undefined] +**features** | **(optional)** **Array<string>** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [default to undefined] +**type** | **(optional)** **string** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [default to undefined] +**connector** | **string** | Connector script name. | [default to undefined] +**connectorClass** | **(optional)** **string** | Fully qualified name of the Java class that implements the connector interface. | [default to undefined] +**connectorAttributes** | **(optional)** | Connector specific configuration. This configuration will differ from type to type. | [default to undefined] +**deleteThreshold** | **(optional)** **number** | Number from 0 to 100 that specifies when to skip the delete phase. | [default to undefined] +**authoritative** | **(optional)** **boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [default to false] +**managementWorkgroup** | **(optional)** **MultihostintegrationsManagementWorkgroupV1** | | [default to undefined] +**healthy** | **(optional)** **boolean** | When this is true, it indicates that the source is healthy. | [default to false] +**status** | **(optional)** **string** | Status identifier that gives specific information about why a source is or isn\'t healthy. | [default to undefined] +**since** | **(optional)** **string** | Timestamp that shows when a source health check was last performed. | [default to undefined] +**connectorId** | **(optional)** **string** | Connector ID | [default to undefined] +**connectorName** | **string** | Name of the connector that was chosen during source creation. | [default to undefined] +**connectionType** | **(optional)** **string** | Type of connection (direct or file). | [default to undefined] +**connectorImplementationId** | **(optional)** **string** | Connector implementation ID. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the source was created | [default to undefined] +**modified** | **(optional)** **string** | Date-time when the source was last modified. | [default to undefined] +**credentialProviderEnabled** | **(optional)** **boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [default to false] +**category** | **(optional)** **string** | Source category (e.g. null, CredentialProvider). | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/MultihostsourcesBeforeProvisioningRule.md b/sdk-output/multi_host_integration/docs/Models/MultihostsourcesBeforeProvisioningRule.md new file mode 100644 index 00000000..63b8b619 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/MultihostsourcesBeforeProvisioningRule.md @@ -0,0 +1,21 @@ +--- +id: v1-multihostsources-before-provisioning-rule-v1 +title: MultihostsourcesBeforeProvisioningRuleV1 +pagination_label: MultihostsourcesBeforeProvisioningRuleV1 +sidebar_label: MultihostsourcesBeforeProvisioningRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultihostsourcesBeforeProvisioningRuleV1', 'v1MultihostsourcesBeforeProvisioningRuleV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/multihostsources-before-provisioning-rule-v1 +tags: ['SDK', 'Software Development Kit', 'MultihostsourcesBeforeProvisioningRuleV1', 'v1MultihostsourcesBeforeProvisioningRuleV1'] +--- + +# MultihostsourcesBeforeProvisioningRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/README.md b/sdk-output/multi_host_integration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/multi_host_integration/docs/Models/Sourcecreationerrors.md b/sdk-output/multi_host_integration/docs/Models/Sourcecreationerrors.md new file mode 100644 index 00000000..8e0e83d3 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/Sourcecreationerrors.md @@ -0,0 +1,24 @@ +--- +id: v1-sourcecreationerrors-v1 +title: SourcecreationerrorsV1 +pagination_label: SourcecreationerrorsV1 +sidebar_label: SourcecreationerrorsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcecreationerrorsV1', 'v1SourcecreationerrorsV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/sourcecreationerrors-v1 +tags: ['SDK', 'Software Development Kit', 'SourcecreationerrorsV1', 'v1SourcecreationerrorsV1'] +--- + +# SourcecreationerrorsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**multihostId** | **(optional)** **string** | Multi-Host Integration ID. | [readonly] [default to undefined] +**source_name** | **(optional)** **string** | Source\'s human-readable name. | [default to undefined] +**source_error** | **(optional)** **string** | Source\'s human-readable description. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the source was created | [default to undefined] +**modified** | **(optional)** **string** | Date-time when the source was last modified. | [default to undefined] +**operation** | **(optional)** **string** | operation category (e.g. DELETE). | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/TestSourceConnectionMultihostV1200Response.md b/sdk-output/multi_host_integration/docs/Models/TestSourceConnectionMultihostV1200Response.md new file mode 100644 index 00000000..6fa2cada --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/TestSourceConnectionMultihostV1200Response.md @@ -0,0 +1,23 @@ +--- +id: v1-test-source-connection-multihost-v1200-response-v1 +title: TestSourceConnectionMultihostV1200ResponseV1 +pagination_label: TestSourceConnectionMultihostV1200ResponseV1 +sidebar_label: TestSourceConnectionMultihostV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestSourceConnectionMultihostV1200ResponseV1', 'v1TestSourceConnectionMultihostV1200ResponseV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/test-source-connection-multihost-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihostV1200ResponseV1', 'v1TestSourceConnectionMultihostV1200ResponseV1'] +--- + +# TestSourceConnectionMultihostV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **(optional)** **boolean** | Source\'s test connection status. | [default to undefined] +**message** | **(optional)** **string** | Source\'s test connection message. | [default to undefined] +**timing** | **(optional)** **number** | Source\'s test connection timing. | [default to undefined] +**resultType** | **(optional)** **string** | Source\'s human-readable result type. | [default to undefined] +**testConnectionDetails** | **(optional)** **string** | Source\'s human-readable test connection details. | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInner.md b/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInner.md new file mode 100644 index 00000000..9fc8e277 --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInner.md @@ -0,0 +1,21 @@ +--- +id: v1-update-multi-host-sources-v1-request-inner-v1 +title: UpdateMultiHostSourcesV1RequestInnerV1 +pagination_label: UpdateMultiHostSourcesV1RequestInnerV1 +sidebar_label: UpdateMultiHostSourcesV1RequestInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdateMultiHostSourcesV1RequestInnerV1', 'v1UpdateMultiHostSourcesV1RequestInnerV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/update-multi-host-sources-v1-request-inner-v1 +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesV1RequestInnerV1', 'v1UpdateMultiHostSourcesV1RequestInnerV1'] +--- + +# UpdateMultiHostSourcesV1RequestInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **UpdateMultiHostSourcesV1RequestInnerValueV1** | | [default to undefined] + diff --git a/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInnerValue.md b/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInnerValue.md new file mode 100644 index 00000000..35ea9c6b --- /dev/null +++ b/sdk-output/multi_host_integration/docs/Models/UpdateMultiHostSourcesV1RequestInnerValue.md @@ -0,0 +1,18 @@ +--- +id: v1-update-multi-host-sources-v1-request-inner-value-v1 +title: UpdateMultiHostSourcesV1RequestInnerValueV1 +pagination_label: UpdateMultiHostSourcesV1RequestInnerValueV1 +sidebar_label: UpdateMultiHostSourcesV1RequestInnerValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdateMultiHostSourcesV1RequestInnerValueV1', 'v1UpdateMultiHostSourcesV1RequestInnerValueV1'] +slug: /tools/sdk/typescript/multi_host_integration/models/update-multi-host-sources-v1-request-inner-value-v1 +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesV1RequestInnerValueV1', 'v1UpdateMultiHostSourcesV1RequestInnerValueV1'] +--- + +# UpdateMultiHostSourcesV1RequestInnerValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/non_employee_lifecycle_management/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..3d2713b2 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,511 @@ +- path: /non-employee-approvals/v1/{id}/approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#approve-non-employee-request-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Non-Employee approval item id (UUID) (default to undefined) + const nonemployeeapprovaldecisionV1: NonemployeeapprovaldecisionV1 = ; // NonemployeeapprovaldecisionV1 | + const result = await apiInstance.approveNonEmployeeRequestV1(id, nonemployeeapprovaldecisionV1); + console.log(result); +- path: /non-employee-records/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#create-non-employee-record-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // NonemployeerequestbodyV1 | Non-Employee record creation request body. + const result = await apiInstance.createNonEmployeeRecordV1(nonemployeerequestbodyV1); + console.log(result); +- path: /non-employee-requests/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#create-non-employee-request-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // NonemployeerequestbodyV1 | Non-Employee creation request body + const result = await apiInstance.createNonEmployeeRequestV1(nonemployeerequestbodyV1); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const nonemployeeschemaattributebodyV1: NonemployeeschemaattributebodyV1 = ; // NonemployeeschemaattributebodyV1 | + const result = await apiInstance.createNonEmployeeSourceSchemaAttributesV1(sourceId, nonemployeeschemaattributebodyV1); + console.log(result); +- path: /non-employee-sources/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#create-non-employee-source-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const nonemployeesourcerequestbodyV1: NonemployeesourcerequestbodyV1 = ; // NonemployeesourcerequestbodyV1 | Non-Employee source creation request body. + const result = await apiInstance.createNonEmployeeSourceV1(nonemployeesourcerequestbodyV1); + console.log(result); +- path: /non-employee-records/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-record-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-Employee record id (UUID) (default to undefined) + const result = await apiInstance.deleteNonEmployeeRecordV1(id); + console.log(result); +- path: /non-employee-records/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const deleteNonEmployeeRecordsInBulkV1RequestV1: DeleteNonEmployeeRecordsInBulkV1RequestV1 = ; // DeleteNonEmployeeRecordsInBulkV1RequestV1 | Non-Employee bulk delete request body. + const result = await apiInstance.deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1RequestV1); + console.log(result); +- path: /non-employee-requests/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-request-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ac110005-7156-1150-8171-5b292e3e0084'; // string | Non-Employee request id in the UUID format (default to undefined) + const result = await apiInstance.deleteNonEmployeeRequestV1(id); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const attributeId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Schema Attribute Id (UUID) (default to undefined) + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const result = await apiInstance.deleteNonEmployeeSchemaAttributeV1(attributeId, sourceId); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const result = await apiInstance.deleteNonEmployeeSourceSchemaAttributesV1(sourceId); + console.log(result); +- path: /non-employee-sources/v1/{sourceId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#delete-non-employee-source-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Source Id (default to undefined) + const result = await apiInstance.deleteNonEmployeeSourceV1(sourceId); + console.log(result); +- path: /non-employee-sources/v1/{id}/non-employees/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#export-non-employee-records-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Source Id (UUID) (default to undefined) + const result = await apiInstance.exportNonEmployeeRecordsV1(id); + console.log(result); +- path: /non-employee-sources/v1/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source Id (UUID) (default to undefined) + const result = await apiInstance.exportNonEmployeeSourceSchemaTemplateV1(id); + console.log(result); +- path: /non-employee-approvals/v1/summary/{requested-for} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-approval-summary-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const requestedFor: string = '2c91808280430dfb0180431a59440460'; // string | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. (default to undefined) + const result = await apiInstance.getNonEmployeeApprovalSummaryV1(requestedFor); + console.log(result); +- path: /non-employee-approvals/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-approval-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Non-Employee approval item id (UUID) (default to undefined) + const includeDetail: boolean = true; // boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) (default to undefined) + const result = await apiInstance.getNonEmployeeApprovalV1(id); + console.log(result); +- path: /non-employee-sources/v1/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Source ID (UUID) (default to undefined) + const result = await apiInstance.getNonEmployeeBulkUploadStatusV1(id); + console.log(result); +- path: /non-employee-records/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-record-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-Employee record id (UUID) (default to undefined) + const result = await apiInstance.getNonEmployeeRecordV1(id); + console.log(result); +- path: /non-employee-requests/v1/summary/{requested-for} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-request-summary-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const requestedFor: string = '2c91808280430dfb0180431a59440460'; // string | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. (default to undefined) + const result = await apiInstance.getNonEmployeeRequestSummaryV1(requestedFor); + console.log(result); +- path: /non-employee-requests/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-request-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ac110005-7156-1150-8171-5b292e3e0084'; // string | Non-Employee request id (UUID) (default to undefined) + const result = await apiInstance.getNonEmployeeRequestV1(id); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const attributeId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Schema Attribute Id (UUID) (default to undefined) + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const result = await apiInstance.getNonEmployeeSchemaAttributeV1(attributeId, sourceId); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const result = await apiInstance.getNonEmployeeSourceSchemaAttributesV1(sourceId); + console.log(result); +- path: /non-employee-sources/v1/{sourceId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#get-non-employee-source-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = '2c91808b7c28b350017c2a2ec5790aa1'; // string | Source Id (default to undefined) + const result = await apiInstance.getNonEmployeeSourceV1(sourceId); + console.log(result); +- path: /non-employee-sources/v1/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Source Id (UUID) (default to undefined) + const data: File = BINARY_DATA_HERE; // File | (default to undefined) + const result = await apiInstance.importNonEmployeeRecordsInBulkV1(id, data); + console.log(result); +- path: /non-employee-approvals/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#list-non-employee-approvals-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const requestedFor: string = '2c91808280430dfb0180431a59440460'; // string | The identity for whom the request was made. *me* indicates the current user. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'approvalStatus eq "Pending"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) (default to undefined) + const sorters: string = 'created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) (default to undefined) + const result = await apiInstance.listNonEmployeeApprovalsV1(); + console.log(result); +- path: /non-employee-records/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#list-non-employee-records-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'accountName,sourceId'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) (default to undefined) + const filters: string = 'sourceId eq "2c91808568c529c60168cca6f90c1313"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) (default to undefined) + const result = await apiInstance.listNonEmployeeRecordsV1(); + console.log(result); +- path: /non-employee-requests/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#list-non-employee-requests-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const requestedFor: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | The identity for whom the request was made. *me* indicates the current user. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'created,approvalStatus'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) (default to undefined) + const filters: string = 'sourceId eq "2c91808568c529c60168cca6f90c1313"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) (default to undefined) + const result = await apiInstance.listNonEmployeeRequestsV1(requestedFor); + console.log(result); +- path: /non-employee-sources/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#list-non-employee-sources-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const requestedFor: string = 'me'; // string | Identity the request was made for. Use \'me\' to indicate the current user. (optional) (default to undefined) + const nonEmployeeCount: boolean = true; // boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to false) + const sorters: string = 'name,created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) (default to undefined) + const result = await apiInstance.listNonEmployeeSourcesV1(); + console.log(result); +- path: /non-employee-records/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#patch-non-employee-record-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-employee record id (UUID) (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/endDate","value":"2019-08-23T18:40:35.772Z"}]; // Array | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + const result = await apiInstance.patchNonEmployeeRecordV1(id, jsonpatchoperationV1); + console.log(result); +- path: /non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const attributeId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Schema Attribute Id (UUID) (default to undefined) + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Source id (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/label","value":{"new attribute label":null}}]; // Array | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. + const result = await apiInstance.patchNonEmployeeSchemaAttributeV1(attributeId, sourceId, jsonpatchoperationV1); + console.log(result); +- path: /non-employee-sources/v1/{sourceId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#patch-non-employee-source-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const sourceId: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Source Id (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":{"new name":null}},{"op":"replace","path":"/approvers","value":["2c91809f703bb37a017040a2fe8748c7","48b1f463c9e8427db5a5071bd81914b8"]}]; // Array | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.patchNonEmployeeSourceV1(sourceId, jsonpatchoperationV1); + console.log(result); +- path: /non-employee-approvals/v1/{id}/reject + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#reject-non-employee-request-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'e136567de87e4d029e60b3c3c55db56d'; // string | Non-Employee approval item id (UUID) (default to undefined) + const nonemployeerejectapprovaldecisionV1: NonemployeerejectapprovaldecisionV1 = ; // NonemployeerejectapprovaldecisionV1 | + const result = await apiInstance.rejectNonEmployeeRequestV1(id, nonemployeerejectapprovaldecisionV1); + console.log(result); +- path: /non-employee-records/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management#update-non-employee-record-v1 + source: | + import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Non-employee record id (UUID) (default to undefined) + const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // NonemployeerequestbodyV1 | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + const result = await apiInstance.updateNonEmployeeRecordV1(id, nonemployeerequestbodyV1); + console.log(result); diff --git a/sdk-output/non_employee_lifecycle_management/docs/Methods/Index.md b/sdk-output/non_employee_lifecycle_management/docs/Methods/Index.md new file mode 100644 index 00000000..4b1349b8 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: non_employee_lifecycle_management-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: non_employee_lifecycle_management-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'non_employee_lifecycle_management', 'methods'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/methods +tags: ['SDK', 'Software Development Kit', 'non_employee_lifecycle_management', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementV1Api.md b/sdk-output/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementV1Api.md new file mode 100644 index 00000000..70a9a66b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementV1Api.md @@ -0,0 +1,1411 @@ +--- +id: v1-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonEmployeeLifecycleManagement', 'v1NonEmployeeLifecycleManagement'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'v1NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagementV1Api + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-non-employee-request-v1**](#approve-non-employee-request-v1) | **POST** `/non-employee-approvals/v1/{id}/approve` | Approve a non-employee request +[**create-non-employee-record-v1**](#create-non-employee-record-v1) | **POST** `/non-employee-records/v1` | Create non-employee record +[**create-non-employee-request-v1**](#create-non-employee-request-v1) | **POST** `/non-employee-requests/v1` | Create non-employee request +[**create-non-employee-source-schema-attributes-v1**](#create-non-employee-source-schema-attributes-v1) | **POST** `/non-employee-sources/v1/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**create-non-employee-source-v1**](#create-non-employee-source-v1) | **POST** `/non-employee-sources/v1` | Create non-employee source +[**delete-non-employee-record-v1**](#delete-non-employee-record-v1) | **DELETE** `/non-employee-records/v1/{id}` | Delete non-employee record +[**delete-non-employee-records-in-bulk-v1**](#delete-non-employee-records-in-bulk-v1) | **POST** `/non-employee-records/v1/bulk-delete` | Delete multiple non-employee records +[**delete-non-employee-request-v1**](#delete-non-employee-request-v1) | **DELETE** `/non-employee-requests/v1/{id}` | Delete non-employee request +[**delete-non-employee-schema-attribute-v1**](#delete-non-employee-schema-attribute-v1) | **DELETE** `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**delete-non-employee-source-schema-attributes-v1**](#delete-non-employee-source-schema-attributes-v1) | **DELETE** `/non-employee-sources/v1/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**delete-non-employee-source-v1**](#delete-non-employee-source-v1) | **DELETE** `/non-employee-sources/v1/{sourceId}` | Delete non-employee source +[**export-non-employee-records-v1**](#export-non-employee-records-v1) | **GET** `/non-employee-sources/v1/{id}/non-employees/download` | Exports non-employee records to csv +[**export-non-employee-source-schema-template-v1**](#export-non-employee-source-schema-template-v1) | **GET** `/non-employee-sources/v1/{id}/schema-attributes-template/download` | Exports source schema template +[**get-non-employee-approval-summary-v1**](#get-non-employee-approval-summary-v1) | **GET** `/non-employee-approvals/v1/summary/{requested-for}` | Get summary of non-employee approval requests +[**get-non-employee-approval-v1**](#get-non-employee-approval-v1) | **GET** `/non-employee-approvals/v1/{id}` | Get a non-employee approval item detail +[**get-non-employee-bulk-upload-status-v1**](#get-non-employee-bulk-upload-status-v1) | **GET** `/non-employee-sources/v1/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**get-non-employee-record-v1**](#get-non-employee-record-v1) | **GET** `/non-employee-records/v1/{id}` | Get a non-employee record +[**get-non-employee-request-summary-v1**](#get-non-employee-request-summary-v1) | **GET** `/non-employee-requests/v1/summary/{requested-for}` | Get summary of non-employee requests +[**get-non-employee-request-v1**](#get-non-employee-request-v1) | **GET** `/non-employee-requests/v1/{id}` | Get a non-employee request +[**get-non-employee-schema-attribute-v1**](#get-non-employee-schema-attribute-v1) | **GET** `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**get-non-employee-source-schema-attributes-v1**](#get-non-employee-source-schema-attributes-v1) | **GET** `/non-employee-sources/v1/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**get-non-employee-source-v1**](#get-non-employee-source-v1) | **GET** `/non-employee-sources/v1/{sourceId}` | Get a non-employee source +[**import-non-employee-records-in-bulk-v1**](#import-non-employee-records-in-bulk-v1) | **POST** `/non-employee-sources/v1/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**list-non-employee-approvals-v1**](#list-non-employee-approvals-v1) | **GET** `/non-employee-approvals/v1` | Get list of non-employee approval requests +[**list-non-employee-records-v1**](#list-non-employee-records-v1) | **GET** `/non-employee-records/v1` | List non-employee records +[**list-non-employee-requests-v1**](#list-non-employee-requests-v1) | **GET** `/non-employee-requests/v1` | List non-employee requests +[**list-non-employee-sources-v1**](#list-non-employee-sources-v1) | **GET** `/non-employee-sources/v1` | List non-employee sources +[**patch-non-employee-record-v1**](#patch-non-employee-record-v1) | **PATCH** `/non-employee-records/v1/{id}` | Patch non-employee record +[**patch-non-employee-schema-attribute-v1**](#patch-non-employee-schema-attribute-v1) | **PATCH** `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**patch-non-employee-source-v1**](#patch-non-employee-source-v1) | **PATCH** `/non-employee-sources/v1/{sourceId}` | Patch a non-employee source +[**reject-non-employee-request-v1**](#reject-non-employee-request-v1) | **POST** `/non-employee-approvals/v1/{id}/reject` | Reject a non-employee request +[**update-non-employee-record-v1**](#update-non-employee-record-v1) | **PUT** `/non-employee-records/v1/{id}` | Update non-employee record + + +## approve-non-employee-request-v1 +Approve a non-employee request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-non-employee-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee approval item id (UUID) | [default to undefined] +**nonemployeeapprovaldecisionV1** | **NonemployeeapprovaldecisionV1** | | + +### Return type + +**NonemployeeapprovalitemV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Non-Employee approval item id (UUID) +const nonemployeeapprovaldecisionV1: NonemployeeapprovaldecisionV1 = ; // +const result = await apiInstance.approveNonEmployeeRequestV1(id, nonemployeeapprovaldecisionV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-non-employee-record-v1 +Create non-employee record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-non-employee-record-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**nonemployeerequestbodyV1** | **NonemployeerequestbodyV1** | Non-Employee record creation request body. | + +### Return type + +**NonemployeerecordV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // Non-Employee record creation request body. +const result = await apiInstance.createNonEmployeeRecordV1(nonemployeerequestbodyV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-non-employee-request-v1 +Create non-employee request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-non-employee-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**nonemployeerequestbodyV1** | **NonemployeerequestbodyV1** | Non-Employee creation request body | + +### Return type + +**NonemployeerequestV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // Non-Employee creation request body +const result = await apiInstance.createNonEmployeeRequestV1(nonemployeerequestbodyV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-non-employee-source-schema-attributes-v1 +Create a new schema attribute for non-employee source +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-non-employee-source-schema-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] +**nonemployeeschemaattributebodyV1** | **NonemployeeschemaattributebodyV1** | | + +### Return type + +**NonemployeeschemaattributeV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const nonemployeeschemaattributebodyV1: NonemployeeschemaattributebodyV1 = ; // +const result = await apiInstance.createNonEmployeeSourceSchemaAttributesV1(sourceId, nonemployeeschemaattributebodyV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-non-employee-source-v1 +Create non-employee source +Create a non-employee source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-non-employee-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**nonemployeesourcerequestbodyV1** | **NonemployeesourcerequestbodyV1** | Non-Employee source creation request body. | + +### Return type + +**NonemployeesourcewithcloudexternalidV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const nonemployeesourcerequestbodyV1: NonemployeesourcerequestbodyV1 = ; // Non-Employee source creation request body. +const result = await apiInstance.createNonEmployeeSourceV1(nonemployeesourcerequestbodyV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-record-v1 +Delete non-employee record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-record-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee record id (UUID) | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-Employee record id (UUID) +const result = await apiInstance.deleteNonEmployeeRecordV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-records-in-bulk-v1 +Delete multiple non-employee records +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-records-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**deleteNonEmployeeRecordsInBulkV1RequestV1** | **DeleteNonEmployeeRecordsInBulkV1RequestV1** | Non-Employee bulk delete request body. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const deleteNonEmployeeRecordsInBulkV1RequestV1: DeleteNonEmployeeRecordsInBulkV1RequestV1 = ; // Non-Employee bulk delete request body. +const result = await apiInstance.deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-request-v1 +Delete non-employee request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee request id in the UUID format | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ac110005-7156-1150-8171-5b292e3e0084; // Non-Employee request id in the UUID format +const result = await apiInstance.deleteNonEmployeeRequestV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-schema-attribute-v1 +Delete a schema attribute for non-employee source +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-schema-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**attributeId** | **string** | The Schema Attribute Id (UUID) | [default to undefined] +**sourceId** | **string** | The Source id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const attributeId: string = ef38f94347e94562b5bb8424a56397d8; // The Schema Attribute Id (UUID) +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const result = await apiInstance.deleteNonEmployeeSchemaAttributeV1(attributeId, sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-source-schema-attributes-v1 +Delete all custom schema attributes for non-employee source +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-source-schema-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const result = await apiInstance.deleteNonEmployeeSourceSchemaAttributesV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-non-employee-source-v1 +Delete non-employee source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-non-employee-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source Id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = e136567de87e4d029e60b3c3c55db56d; // Source Id +const result = await apiInstance.deleteNonEmployeeSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## export-non-employee-records-v1 +Exports non-employee records to csv +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-non-employee-records-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id (UUID) | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Source Id (UUID) +const result = await apiInstance.exportNonEmployeeRecordsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## export-non-employee-source-schema-template-v1 +Exports source schema template +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-non-employee-source-schema-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id (UUID) | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Source Id (UUID) +const result = await apiInstance.exportNonEmployeeSourceSchemaTemplateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-approval-summary-v1 +Get summary of non-employee approval requests +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 2. The current user is an approver, in which case "me" should be provided +as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-approval-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | [default to undefined] + +### Return type + +**NonemployeeapprovalsummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const requestedFor: string = 2c91808280430dfb0180431a59440460; // The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. +const result = await apiInstance.getNonEmployeeApprovalSummaryV1(requestedFor); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-approval-v1 +Get a non-employee approval item detail +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee approval item id (UUID) | [default to undefined] +**includeDetail** | **boolean** | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* | [optional] [default to undefined] + +### Return type + +**NonemployeeapprovalitemdetailV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Non-Employee approval item id (UUID) +const includeDetail: boolean = true; // The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) +const result = await apiInstance.getNonEmployeeApprovalV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-bulk-upload-status-v1 +Obtain the status of bulk upload on the source +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-bulk-upload-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source ID (UUID) | [default to undefined] + +### Return type + +**NonemployeebulkuploadstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Source ID (UUID) +const result = await apiInstance.getNonEmployeeBulkUploadStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-record-v1 +Get a non-employee record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-record-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee record id (UUID) | [default to undefined] + +### Return type + +**NonemployeerecordV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-Employee record id (UUID) +const result = await apiInstance.getNonEmployeeRecordV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-request-summary-v1 +Get summary of non-employee requests +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-request-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. | [default to undefined] + +### Return type + +**NonemployeerequestsummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const requestedFor: string = 2c91808280430dfb0180431a59440460; // The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. +const result = await apiInstance.getNonEmployeeRequestSummaryV1(requestedFor); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-request-v1 +Get a non-employee request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee request id (UUID) | [default to undefined] + +### Return type + +**NonemployeerequestV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ac110005-7156-1150-8171-5b292e3e0084; // Non-Employee request id (UUID) +const result = await apiInstance.getNonEmployeeRequestV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-schema-attribute-v1 +Get schema attribute non-employee source +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-schema-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**attributeId** | **string** | The Schema Attribute Id (UUID) | [default to undefined] +**sourceId** | **string** | The Source id | [default to undefined] + +### Return type + +**NonemployeeschemaattributeV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const attributeId: string = ef38f94347e94562b5bb8424a56397d8; // The Schema Attribute Id (UUID) +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const result = await apiInstance.getNonEmployeeSchemaAttributeV1(attributeId, sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-source-schema-attributes-v1 +List schema attributes non-employee source +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-source-schema-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const result = await apiInstance.getNonEmployeeSourceSchemaAttributesV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-non-employee-source-v1 +Get a non-employee source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-non-employee-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source Id | [default to undefined] + +### Return type + +**NonemployeesourceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = 2c91808b7c28b350017c2a2ec5790aa1; // Source Id +const result = await apiInstance.getNonEmployeeSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## import-non-employee-records-in-bulk-v1 +Imports, or updates, non-employee records +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-non-employee-records-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id (UUID) | [default to undefined] +**data** | **File** | | [default to undefined] + +### Return type + +**NonemployeebulkuploadjobV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Source Id (UUID) +const data: File = BINARY_DATA_HERE; // +const result = await apiInstance.importNonEmployeeRecordsInBulkV1(id, data); +console.log(result); +``` + +[[Back to top]](#) + +## list-non-employee-approvals-v1 +Get list of non-employee approval requests +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-non-employee-approvals-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const requestedFor: string = 2c91808280430dfb0180431a59440460; // The identity for whom the request was made. *me* indicates the current user. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = approvalStatus eq "Pending"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) +const sorters: string = created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) +const result = await apiInstance.listNonEmployeeApprovalsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-non-employee-records-v1 +List non-employee records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-non-employee-records-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = accountName,sourceId; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) +const filters: string = sourceId eq "2c91808568c529c60168cca6f90c1313"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) +const result = await apiInstance.listNonEmployeeRecordsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-non-employee-requests-v1 +List non-employee requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-non-employee-requests-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**requestedFor** | **string** | The identity for whom the request was made. *me* indicates the current user. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const requestedFor: string = e136567de87e4d029e60b3c3c55db56d; // The identity for whom the request was made. *me* indicates the current user. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = created,approvalStatus; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) +const filters: string = sourceId eq "2c91808568c529c60168cca6f90c1313"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) +const result = await apiInstance.listNonEmployeeRequestsV1(requestedFor); +console.log(result); +``` + +[[Back to top]](#) + +## list-non-employee-sources-v1 +List non-employee sources +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-non-employee-sources-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**requestedFor** | **string** | Identity the request was made for. Use \'me\' to indicate the current user. | [optional] [default to undefined] +**nonEmployeeCount** | **boolean** | Flag that determines whether the API will return a non-employee count associated with the source. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const requestedFor: string = me; // Identity the request was made for. Use \'me\' to indicate the current user. (optional) +const nonEmployeeCount: boolean = true; // Flag that determines whether the API will return a non-employee count associated with the source. (optional) +const sorters: string = name,created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) +const result = await apiInstance.listNonEmployeeSourcesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-non-employee-record-v1 +Patch non-employee record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-non-employee-record-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-employee record id (UUID) | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +**NonemployeerecordV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-employee record id (UUID) +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/endDate","value":"2019-08-23T18:40:35.772Z"}]; // A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. +const result = await apiInstance.patchNonEmployeeRecordV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-non-employee-schema-attribute-v1 +Patch a schema attribute for non-employee source +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-non-employee-schema-attribute-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**attributeId** | **string** | The Schema Attribute Id (UUID) | [default to undefined] +**sourceId** | **string** | The Source id | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. | + +### Return type + +**NonemployeeschemaattributeV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const attributeId: string = ef38f94347e94562b5bb8424a56397d8; // The Schema Attribute Id (UUID) +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // The Source id +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/label","value":{"new attribute label":null}}]; // A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. +const result = await apiInstance.patchNonEmployeeSchemaAttributeV1(attributeId, sourceId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-non-employee-source-v1 +Patch a non-employee source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-non-employee-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source Id | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**NonemployeesourceV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const sourceId: string = e136567de87e4d029e60b3c3c55db56d; // Source Id +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":{"new name":null}},{"op":"replace","path":"/approvers","value":["2c91809f703bb37a017040a2fe8748c7","48b1f463c9e8427db5a5071bd81914b8"]}]; // A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.patchNonEmployeeSourceV1(sourceId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## reject-non-employee-request-v1 +Reject a non-employee request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-non-employee-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-Employee approval item id (UUID) | [default to undefined] +**nonemployeerejectapprovaldecisionV1** | **NonemployeerejectapprovaldecisionV1** | | + +### Return type + +**NonemployeeapprovalitemV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = e136567de87e4d029e60b3c3c55db56d; // Non-Employee approval item id (UUID) +const nonemployeerejectapprovaldecisionV1: NonemployeerejectapprovaldecisionV1 = ; // +const result = await apiInstance.rejectNonEmployeeRequestV1(id, nonemployeerejectapprovaldecisionV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-non-employee-record-v1 +Update non-employee record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-non-employee-record-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Non-employee record id (UUID) | [default to undefined] +**nonemployeerequestbodyV1** | **NonemployeerequestbodyV1** | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. | + +### Return type + +**NonemployeerecordV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NonEmployeeLifecycleManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NonEmployeeLifecycleManagementV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Non-employee record id (UUID) +const nonemployeerequestbodyV1: NonemployeerequestbodyV1 = ; // Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. +const result = await apiInstance.updateNonEmployeeRecordV1(id, nonemployeerequestbodyV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Approvalstatus.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Approvalstatus.md new file mode 100644 index 00000000..ef17cd40 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Approvalstatus.md @@ -0,0 +1,27 @@ +--- +id: v1-approvalstatus-v1 +title: ApprovalstatusV1 +pagination_label: ApprovalstatusV1 +sidebar_label: ApprovalstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalstatusV1', 'v1ApprovalstatusV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/approvalstatus-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalstatusV1', 'v1ApprovalstatusV1'] +--- + +# ApprovalstatusV1 + +## Enum + + +* `Approved` (value: `'APPROVED'`) + +* `Rejected` (value: `'REJECTED'`) + +* `Pending` (value: `'PENDING'`) + +* `NotReady` (value: `'NOT_READY'`) + +* `Cancelled` (value: `'CANCELLED'`) + + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/ArrayInner.md b/sdk-output/non_employee_lifecycle_management/docs/Models/ArrayInner.md new file mode 100644 index 00000000..a5206b4c --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/DeleteNonEmployeeRecordsInBulkV1Request.md b/sdk-output/non_employee_lifecycle_management/docs/Models/DeleteNonEmployeeRecordsInBulkV1Request.md new file mode 100644 index 00000000..dae7d844 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/DeleteNonEmployeeRecordsInBulkV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-delete-non-employee-records-in-bulk-v1-request-v1 +title: DeleteNonEmployeeRecordsInBulkV1RequestV1 +pagination_label: DeleteNonEmployeeRecordsInBulkV1RequestV1 +sidebar_label: DeleteNonEmployeeRecordsInBulkV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeleteNonEmployeeRecordsInBulkV1RequestV1', 'v1DeleteNonEmployeeRecordsInBulkV1RequestV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/delete-non-employee-records-in-bulk-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkV1RequestV1', 'v1DeleteNonEmployeeRecordsInBulkV1RequestV1'] +--- + +# DeleteNonEmployeeRecordsInBulkV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<string>** | List of non-employee ids. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Errormessagedto.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8e77ccfe --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Errorresponsedto.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..62a157c5 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/ImportNonEmployeeRecordsInBulkV1Request.md b/sdk-output/non_employee_lifecycle_management/docs/Models/ImportNonEmployeeRecordsInBulkV1Request.md new file mode 100644 index 00000000..07bdc18f --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/ImportNonEmployeeRecordsInBulkV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-import-non-employee-records-in-bulk-v1-request-v1 +title: ImportNonEmployeeRecordsInBulkV1RequestV1 +pagination_label: ImportNonEmployeeRecordsInBulkV1RequestV1 +sidebar_label: ImportNonEmployeeRecordsInBulkV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportNonEmployeeRecordsInBulkV1RequestV1', 'v1ImportNonEmployeeRecordsInBulkV1RequestV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/import-non-employee-records-in-bulk-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkV1RequestV1', 'v1ImportNonEmployeeRecordsInBulkV1RequestV1'] +--- + +# ImportNonEmployeeRecordsInBulkV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **File** | | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Index.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Index.md new file mode 100644 index 00000000..80b81a6b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: non_employee_lifecycle_management-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: non_employee_lifecycle_management-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'non_employee_lifecycle_management', 'models'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models +tags: ['SDK', 'Software Development Kit', 'non_employee_lifecycle_management', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Jsonpatchoperation.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..373def18 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/JsonpatchoperationValue.md b/sdk-output/non_employee_lifecycle_management/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..1569e983 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1401Response.md b/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1401Response.md new file mode 100644 index 00000000..071c907b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-non-employee-records-v1401-response-v1 +title: ListNonEmployeeRecordsV1401ResponseV1 +pagination_label: ListNonEmployeeRecordsV1401ResponseV1 +sidebar_label: ListNonEmployeeRecordsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListNonEmployeeRecordsV1401ResponseV1', 'v1ListNonEmployeeRecordsV1401ResponseV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/list-non-employee-records-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListNonEmployeeRecordsV1401ResponseV1', 'v1ListNonEmployeeRecordsV1401ResponseV1'] +--- + +# ListNonEmployeeRecordsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1429Response.md b/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1429Response.md new file mode 100644 index 00000000..a505882d --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/ListNonEmployeeRecordsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-non-employee-records-v1429-response-v1 +title: ListNonEmployeeRecordsV1429ResponseV1 +pagination_label: ListNonEmployeeRecordsV1429ResponseV1 +sidebar_label: ListNonEmployeeRecordsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListNonEmployeeRecordsV1429ResponseV1', 'v1ListNonEmployeeRecordsV1429ResponseV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/list-non-employee-records-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListNonEmployeeRecordsV1429ResponseV1', 'v1ListNonEmployeeRecordsV1429ResponseV1'] +--- + +# ListNonEmployeeRecordsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Localeorigin.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d81ccb1b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovaldecision.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovaldecision.md new file mode 100644 index 00000000..1bb68cb9 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovaldecision.md @@ -0,0 +1,19 @@ +--- +id: v1-nonemployeeapprovaldecision-v1 +title: NonemployeeapprovaldecisionV1 +pagination_label: NonemployeeapprovaldecisionV1 +sidebar_label: NonemployeeapprovaldecisionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeapprovaldecisionV1', 'v1NonemployeeapprovaldecisionV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeapprovaldecision-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeapprovaldecisionV1', 'v1NonemployeeapprovaldecisionV1'] +--- + +# NonemployeeapprovaldecisionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **(optional)** **string** | Comment on the approval item. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitem.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitem.md new file mode 100644 index 00000000..32a0976d --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitem.md @@ -0,0 +1,27 @@ +--- +id: v1-nonemployeeapprovalitem-v1 +title: NonemployeeapprovalitemV1 +pagination_label: NonemployeeapprovalitemV1 +sidebar_label: NonemployeeapprovalitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeapprovalitemV1', 'v1NonemployeeapprovalitemV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeapprovalitem-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeapprovalitemV1', 'v1NonemployeeapprovalitemV1'] +--- + +# NonemployeeapprovalitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee approval item id | [default to undefined] +**approver** | **(optional)** **NonemployeeidentityreferencewithidV1** | | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name | [default to undefined] +**approvalStatus** | **(optional)** **ApprovalstatusV1** | | [default to undefined] +**approvalOrder** | **(optional)** **number** | Approval order | [default to undefined] +**comment** | **(optional)** **string** | comment of approver | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**nonEmployeeRequest** | **(optional)** **NonemployeerequestliteV1** | | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitembase.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitembase.md new file mode 100644 index 00000000..0fe12c3b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitembase.md @@ -0,0 +1,26 @@ +--- +id: v1-nonemployeeapprovalitembase-v1 +title: NonemployeeapprovalitembaseV1 +pagination_label: NonemployeeapprovalitembaseV1 +sidebar_label: NonemployeeapprovalitembaseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeapprovalitembaseV1', 'v1NonemployeeapprovalitembaseV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeapprovalitembase-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeapprovalitembaseV1', 'v1NonemployeeapprovalitembaseV1'] +--- + +# NonemployeeapprovalitembaseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee approval item id | [default to undefined] +**approver** | **(optional)** **NonemployeeidentityreferencewithidV1** | | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name | [default to undefined] +**approvalStatus** | **(optional)** **ApprovalstatusV1** | | [default to undefined] +**approvalOrder** | **(optional)** **number** | Approval order | [default to undefined] +**comment** | **(optional)** **string** | comment of approver | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitemdetail.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitemdetail.md new file mode 100644 index 00000000..00c377fe --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalitemdetail.md @@ -0,0 +1,27 @@ +--- +id: v1-nonemployeeapprovalitemdetail-v1 +title: NonemployeeapprovalitemdetailV1 +pagination_label: NonemployeeapprovalitemdetailV1 +sidebar_label: NonemployeeapprovalitemdetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeapprovalitemdetailV1', 'v1NonemployeeapprovalitemdetailV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeapprovalitemdetail-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeapprovalitemdetailV1', 'v1NonemployeeapprovalitemdetailV1'] +--- + +# NonemployeeapprovalitemdetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee approval item id | [default to undefined] +**approver** | **(optional)** **NonemployeeidentityreferencewithidV1** | | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name | [default to undefined] +**approvalStatus** | **(optional)** **ApprovalstatusV1** | | [default to undefined] +**approvalOrder** | **(optional)** **number** | Approval order | [default to undefined] +**comment** | **(optional)** **string** | comment of approver | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**nonEmployeeRequest** | **(optional)** **NonemployeerequestwithoutapprovalitemV1** | | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalsummary.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalsummary.md new file mode 100644 index 00000000..4fe8ee05 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeapprovalsummary.md @@ -0,0 +1,21 @@ +--- +id: v1-nonemployeeapprovalsummary-v1 +title: NonemployeeapprovalsummaryV1 +pagination_label: NonemployeeapprovalsummaryV1 +sidebar_label: NonemployeeapprovalsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeapprovalsummaryV1', 'v1NonemployeeapprovalsummaryV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeapprovalsummary-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeapprovalsummaryV1', 'v1NonemployeeapprovalsummaryV1'] +--- + +# NonemployeeapprovalsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **(optional)** **number** | The number of approved non-employee approval requests. | [default to undefined] +**pending** | **(optional)** **number** | The number of pending non-employee approval requests. | [default to undefined] +**rejected** | **(optional)** **number** | The number of rejected non-employee approval requests. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadjob.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadjob.md new file mode 100644 index 00000000..4d8e0c3b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadjob.md @@ -0,0 +1,23 @@ +--- +id: v1-nonemployeebulkuploadjob-v1 +title: NonemployeebulkuploadjobV1 +pagination_label: NonemployeebulkuploadjobV1 +sidebar_label: NonemployeebulkuploadjobV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeebulkuploadjobV1', 'v1NonemployeebulkuploadjobV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeebulkuploadjob-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeebulkuploadjobV1', 'v1NonemployeebulkuploadjobV1'] +--- + +# NonemployeebulkuploadjobV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The bulk upload job\'s ID. (UUID) | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source to bulk-upload non-employees to. (UUID) | [default to undefined] +**created** | **(optional)** **string** | The date-time the job was submitted. | [default to undefined] +**modified** | **(optional)** **string** | The date-time that the job was last updated. | [default to undefined] +**status** | **(optional)** **string** | Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadstatus.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadstatus.md new file mode 100644 index 00000000..e078b254 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeebulkuploadstatus.md @@ -0,0 +1,19 @@ +--- +id: v1-nonemployeebulkuploadstatus-v1 +title: NonemployeebulkuploadstatusV1 +pagination_label: NonemployeebulkuploadstatusV1 +sidebar_label: NonemployeebulkuploadstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeebulkuploadstatusV1', 'v1NonemployeebulkuploadstatusV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeebulkuploadstatus-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeebulkuploadstatusV1', 'v1NonemployeebulkuploadstatusV1'] +--- + +# NonemployeebulkuploadstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **(optional)** **string** | Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentitydtotype.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentitydtotype.md new file mode 100644 index 00000000..ed0db798 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentitydtotype.md @@ -0,0 +1,21 @@ +--- +id: v1-nonemployeeidentitydtotype-v1 +title: NonemployeeidentitydtotypeV1 +pagination_label: NonemployeeidentitydtotypeV1 +sidebar_label: NonemployeeidentitydtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeidentitydtotypeV1', 'v1NonemployeeidentitydtotypeV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeidentitydtotype-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeidentitydtotypeV1', 'v1NonemployeeidentitydtotypeV1'] +--- + +# NonemployeeidentitydtotypeV1 + +## Enum + + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentityreferencewithid.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentityreferencewithid.md new file mode 100644 index 00000000..958ea977 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidentityreferencewithid.md @@ -0,0 +1,20 @@ +--- +id: v1-nonemployeeidentityreferencewithid-v1 +title: NonemployeeidentityreferencewithidV1 +pagination_label: NonemployeeidentityreferencewithidV1 +sidebar_label: NonemployeeidentityreferencewithidV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeidentityreferencewithidV1', 'v1NonemployeeidentityreferencewithidV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeidentityreferencewithid-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeidentityreferencewithidV1', 'v1NonemployeeidentityreferencewithidV1'] +--- + +# NonemployeeidentityreferencewithidV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **NonemployeeidentitydtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidnuserrequest.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidnuserrequest.md new file mode 100644 index 00000000..c6ecdab0 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeidnuserrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-nonemployeeidnuserrequest-v1 +title: NonemployeeidnuserrequestV1 +pagination_label: NonemployeeidnuserrequestV1 +sidebar_label: NonemployeeidnuserrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeidnuserrequestV1', 'v1NonemployeeidnuserrequestV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeidnuserrequest-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeidnuserrequestV1', 'v1NonemployeeidnuserrequestV1'] +--- + +# NonemployeeidnuserrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Identity id. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerecord.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerecord.md new file mode 100644 index 00000000..b6989de8 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerecord.md @@ -0,0 +1,31 @@ +--- +id: v1-nonemployeerecord-v1 +title: NonemployeerecordV1 +pagination_label: NonemployeerecordV1 +sidebar_label: NonemployeerecordV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerecordV1', 'v1NonemployeerecordV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerecord-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerecordV1', 'v1NonemployeerecordV1'] +--- + +# NonemployeerecordV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee record id. | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name. | [default to undefined] +**firstName** | **(optional)** **string** | Non-Employee\'s first name. | [default to undefined] +**lastName** | **(optional)** **string** | Non-Employee\'s last name. | [default to undefined] +**email** | **(optional)** **string** | Non-Employee\'s email. | [default to undefined] +**phone** | **(optional)** **string** | Non-Employee\'s phone. | [default to undefined] +**manager** | **(optional)** **string** | The account ID of a valid identity to serve as this non-employee\'s manager. | [default to undefined] +**sourceId** | **(optional)** **string** | Non-Employee\'s source id. | [default to undefined] +**data** | **(optional)** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [default to undefined] +**startDate** | **(optional)** **string** | Non-Employee employment start date. | [default to undefined] +**endDate** | **(optional)** **string** | Non-Employee employment end date. | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerejectapprovaldecision.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerejectapprovaldecision.md new file mode 100644 index 00000000..d3535c15 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerejectapprovaldecision.md @@ -0,0 +1,19 @@ +--- +id: v1-nonemployeerejectapprovaldecision-v1 +title: NonemployeerejectapprovaldecisionV1 +pagination_label: NonemployeerejectapprovaldecisionV1 +sidebar_label: NonemployeerejectapprovaldecisionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerejectapprovaldecisionV1', 'v1NonemployeerejectapprovaldecisionV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerejectapprovaldecision-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerejectapprovaldecisionV1', 'v1NonemployeerejectapprovaldecisionV1'] +--- + +# NonemployeerejectapprovaldecisionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **string** | Comment on the approval item. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequest.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequest.md new file mode 100644 index 00000000..0c9e9a01 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequest.md @@ -0,0 +1,38 @@ +--- +id: v1-nonemployeerequest-v1 +title: NonemployeerequestV1 +pagination_label: NonemployeerequestV1 +sidebar_label: NonemployeerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerequestV1', 'v1NonemployeerequestV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerequest-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerequestV1', 'v1NonemployeerequestV1'] +--- + +# NonemployeerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name. | [default to undefined] +**firstName** | **(optional)** **string** | Non-Employee\'s first name. | [default to undefined] +**lastName** | **(optional)** **string** | Non-Employee\'s last name. | [default to undefined] +**email** | **(optional)** **string** | Non-Employee\'s email. | [default to undefined] +**phone** | **(optional)** **string** | Non-Employee\'s phone. | [default to undefined] +**manager** | **(optional)** **string** | The account ID of a valid identity to serve as this non-employee\'s manager. | [default to undefined] +**nonEmployeeSource** | **(optional)** **NonemployeesourceliteV1** | | [default to undefined] +**data** | **(optional)** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [default to undefined] +**approvalItems** | **(optional)** **Array<NonemployeeapprovalitembaseV1>** | List of approval item for the request | [default to undefined] +**approvalStatus** | **(optional)** **ApprovalstatusV1** | | [default to undefined] +**comment** | **(optional)** **string** | Comment of requester | [default to undefined] +**completionDate** | **(optional)** **string** | When the request was completely approved. | [default to undefined] +**startDate** | **(optional)** **string** | Non-Employee employment start date. | [default to undefined] +**endDate** | **(optional)** **string** | Non-Employee employment end date. | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestbody.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestbody.md new file mode 100644 index 00000000..dc540f2f --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestbody.md @@ -0,0 +1,28 @@ +--- +id: v1-nonemployeerequestbody-v1 +title: NonemployeerequestbodyV1 +pagination_label: NonemployeerequestbodyV1 +sidebar_label: NonemployeerequestbodyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerequestbodyV1', 'v1NonemployeerequestbodyV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerequestbody-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerequestbodyV1', 'v1NonemployeerequestbodyV1'] +--- + +# NonemployeerequestbodyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountName** | **string** | Requested identity account name. | [default to undefined] +**firstName** | **string** | Non-Employee\'s first name. | [default to undefined] +**lastName** | **string** | Non-Employee\'s last name. | [default to undefined] +**email** | **string** | Non-Employee\'s email. | [default to undefined] +**phone** | **string** | Non-Employee\'s phone. | [default to undefined] +**manager** | **string** | The account ID of a valid identity to serve as this non-employee\'s manager. | [default to undefined] +**sourceId** | **string** | Non-Employee\'s source id. | [default to undefined] +**data** | **(optional)** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [default to undefined] +**startDate** | **string** | Non-Employee employment start date. | [default to undefined] +**endDate** | **string** | Non-Employee employment end date. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestlite.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestlite.md new file mode 100644 index 00000000..63f2bf52 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestlite.md @@ -0,0 +1,20 @@ +--- +id: v1-nonemployeerequestlite-v1 +title: NonemployeerequestliteV1 +pagination_label: NonemployeerequestliteV1 +sidebar_label: NonemployeerequestliteV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerequestliteV1', 'v1NonemployeerequestliteV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerequestlite-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerequestliteV1', 'v1NonemployeerequestliteV1'] +--- + +# NonemployeerequestliteV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee request id. | [default to undefined] +**requester** | **(optional)** **NonemployeeidentityreferencewithidV1** | | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestsummary.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestsummary.md new file mode 100644 index 00000000..1d8f4b3b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestsummary.md @@ -0,0 +1,22 @@ +--- +id: v1-nonemployeerequestsummary-v1 +title: NonemployeerequestsummaryV1 +pagination_label: NonemployeerequestsummaryV1 +sidebar_label: NonemployeerequestsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerequestsummaryV1', 'v1NonemployeerequestsummaryV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerequestsummary-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerequestsummaryV1', 'v1NonemployeerequestsummaryV1'] +--- + +# NonemployeerequestsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **(optional)** **number** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [default to undefined] +**rejected** | **(optional)** **number** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [default to undefined] +**pending** | **(optional)** **number** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [default to undefined] +**nonEmployeeCount** | **(optional)** **number** | The number of non-employee records on all sources that *requested-for* user manages. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestwithoutapprovalitem.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestwithoutapprovalitem.md new file mode 100644 index 00000000..97c6a0f4 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeerequestwithoutapprovalitem.md @@ -0,0 +1,35 @@ +--- +id: v1-nonemployeerequestwithoutapprovalitem-v1 +title: NonemployeerequestwithoutapprovalitemV1 +pagination_label: NonemployeerequestwithoutapprovalitemV1 +sidebar_label: NonemployeerequestwithoutapprovalitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeerequestwithoutapprovalitemV1', 'v1NonemployeerequestwithoutapprovalitemV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeerequestwithoutapprovalitem-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeerequestwithoutapprovalitemV1', 'v1NonemployeerequestwithoutapprovalitemV1'] +--- + +# NonemployeerequestwithoutapprovalitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee request id. | [default to undefined] +**requester** | **(optional)** **NonemployeeidentityreferencewithidV1** | | [default to undefined] +**accountName** | **(optional)** **string** | Requested identity account name. | [default to undefined] +**firstName** | **(optional)** **string** | Non-Employee\'s first name. | [default to undefined] +**lastName** | **(optional)** **string** | Non-Employee\'s last name. | [default to undefined] +**email** | **(optional)** **string** | Non-Employee\'s email. | [default to undefined] +**phone** | **(optional)** **string** | Non-Employee\'s phone. | [default to undefined] +**manager** | **(optional)** **string** | The account ID of a valid identity to serve as this non-employee\'s manager. | [default to undefined] +**nonEmployeeSource** | **(optional)** **NonemployeesourcelitewithschemaattributesV1** | | [default to undefined] +**data** | **(optional)** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [default to undefined] +**approvalStatus** | **(optional)** **ApprovalstatusV1** | | [default to undefined] +**comment** | **(optional)** **string** | Comment of requester | [default to undefined] +**completionDate** | **(optional)** **string** | When the request was completely approved. | [default to undefined] +**startDate** | **(optional)** **string** | Non-Employee employment start date. | [default to undefined] +**endDate** | **(optional)** **string** | Non-Employee employment end date. | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattribute.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattribute.md new file mode 100644 index 00000000..4a9ae6c5 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattribute.md @@ -0,0 +1,28 @@ +--- +id: v1-nonemployeeschemaattribute-v1 +title: NonemployeeschemaattributeV1 +pagination_label: NonemployeeschemaattributeV1 +sidebar_label: NonemployeeschemaattributeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeschemaattributeV1', 'v1NonemployeeschemaattributeV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeschemaattribute-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeschemaattributeV1', 'v1NonemployeeschemaattributeV1'] +--- + +# NonemployeeschemaattributeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Schema Attribute Id | [default to undefined] +**system** | **(optional)** **boolean** | True if this schema attribute is mandatory on all non-employees sources. | [default to false] +**modified** | **(optional)** **string** | When the schema attribute was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the schema attribute was created. | [default to undefined] +**type** | **NonemployeeschemaattributetypeV1** | | [default to undefined] +**label** | **string** | Label displayed on the UI for this schema attribute. | [default to undefined] +**technicalName** | **string** | The technical name of the attribute. Must be unique per source. | [default to undefined] +**helpText** | **(optional)** **string** | help text displayed by UI. | [default to undefined] +**placeholder** | **(optional)** **string** | Hint text that fills UI box. | [default to undefined] +**required** | **(optional)** **boolean** | If true, the schema attribute is required for all non-employees in the source | [default to false] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributebody.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributebody.md new file mode 100644 index 00000000..b33ea455 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributebody.md @@ -0,0 +1,24 @@ +--- +id: v1-nonemployeeschemaattributebody-v1 +title: NonemployeeschemaattributebodyV1 +pagination_label: NonemployeeschemaattributebodyV1 +sidebar_label: NonemployeeschemaattributebodyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeschemaattributebodyV1', 'v1NonemployeeschemaattributebodyV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeschemaattributebody-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeschemaattributebodyV1', 'v1NonemployeeschemaattributebodyV1'] +--- + +# NonemployeeschemaattributebodyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of the attribute. Only type \'TEXT\' is supported for custom attributes. | [default to undefined] +**label** | **string** | Label displayed on the UI for this schema attribute. | [default to undefined] +**technicalName** | **string** | The technical name of the attribute. Must be unique per source. | [default to undefined] +**helpText** | **(optional)** **string** | help text displayed by UI. | [default to undefined] +**placeholder** | **(optional)** **string** | Hint text that fills UI box. | [default to undefined] +**required** | **(optional)** **boolean** | If true, the schema attribute is required for all non-employees in the source | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributetype.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributetype.md new file mode 100644 index 00000000..1d6442f0 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeeschemaattributetype.md @@ -0,0 +1,23 @@ +--- +id: v1-nonemployeeschemaattributetype-v1 +title: NonemployeeschemaattributetypeV1 +pagination_label: NonemployeeschemaattributetypeV1 +sidebar_label: NonemployeeschemaattributetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeeschemaattributetypeV1', 'v1NonemployeeschemaattributetypeV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeeschemaattributetype-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeeschemaattributetypeV1', 'v1NonemployeeschemaattributetypeV1'] +--- + +# NonemployeeschemaattributetypeV1 + +## Enum + + +* `Text` (value: `'TEXT'`) + +* `Date` (value: `'DATE'`) + +* `Identity` (value: `'IDENTITY'`) + + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesource.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesource.md new file mode 100644 index 00000000..3ae7c845 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesource.md @@ -0,0 +1,26 @@ +--- +id: v1-nonemployeesource-v1 +title: NonemployeesourceV1 +pagination_label: NonemployeesourceV1 +sidebar_label: NonemployeesourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourceV1', 'v1NonemployeesourceV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesource-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourceV1', 'v1NonemployeesourceV1'] +--- + +# NonemployeesourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] +**approvers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of approvers | [default to undefined] +**accountManagers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of account managers | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelite.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelite.md new file mode 100644 index 00000000..e08606a5 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelite.md @@ -0,0 +1,22 @@ +--- +id: v1-nonemployeesourcelite-v1 +title: NonemployeesourceliteV1 +pagination_label: NonemployeesourceliteV1 +sidebar_label: NonemployeesourceliteV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourceliteV1', 'v1NonemployeesourceliteV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesourcelite-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourceliteV1', 'v1NonemployeesourceliteV1'] +--- + +# NonemployeesourceliteV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelitewithschemaattributes.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelitewithschemaattributes.md new file mode 100644 index 00000000..76580622 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcelitewithschemaattributes.md @@ -0,0 +1,23 @@ +--- +id: v1-nonemployeesourcelitewithschemaattributes-v1 +title: NonemployeesourcelitewithschemaattributesV1 +pagination_label: NonemployeesourcelitewithschemaattributesV1 +sidebar_label: NonemployeesourcelitewithschemaattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourcelitewithschemaattributesV1', 'v1NonemployeesourcelitewithschemaattributesV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesourcelitewithschemaattributes-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourcelitewithschemaattributesV1', 'v1NonemployeesourcelitewithschemaattributesV1'] +--- + +# NonemployeesourcelitewithschemaattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] +**schemaAttributes** | **(optional)** **Array<NonemployeeschemaattributeV1>** | List of schema attributes associated with this non-employee source. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcerequestbody.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcerequestbody.md new file mode 100644 index 00000000..092643b7 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcerequestbody.md @@ -0,0 +1,24 @@ +--- +id: v1-nonemployeesourcerequestbody-v1 +title: NonemployeesourcerequestbodyV1 +pagination_label: NonemployeesourcerequestbodyV1 +sidebar_label: NonemployeesourcerequestbodyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourcerequestbodyV1', 'v1NonemployeesourcerequestbodyV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesourcerequestbody-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourcerequestbodyV1', 'v1NonemployeesourcerequestbodyV1'] +--- + +# NonemployeesourcerequestbodyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of non-employee source. | [default to undefined] +**description** | **string** | Description of non-employee source. | [default to undefined] +**owner** | **NonemployeeidnuserrequestV1** | | [default to undefined] +**managementWorkgroup** | **(optional)** **string** | The ID for the management workgroup that contains source sub-admins | [default to undefined] +**approvers** | **(optional)** **Array<NonemployeeidnuserrequestV1>** | List of approvers. | [default to undefined] +**accountManagers** | **(optional)** **Array<NonemployeeidnuserrequestV1>** | List of account managers. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithcloudexternalid.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithcloudexternalid.md new file mode 100644 index 00000000..4952359b --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithcloudexternalid.md @@ -0,0 +1,27 @@ +--- +id: v1-nonemployeesourcewithcloudexternalid-v1 +title: NonemployeesourcewithcloudexternalidV1 +pagination_label: NonemployeesourcewithcloudexternalidV1 +sidebar_label: NonemployeesourcewithcloudexternalidV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourcewithcloudexternalidV1', 'v1NonemployeesourcewithcloudexternalidV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesourcewithcloudexternalid-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourcewithcloudexternalidV1', 'v1NonemployeesourcewithcloudexternalidV1'] +--- + +# NonemployeesourcewithcloudexternalidV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] +**approvers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of approvers | [default to undefined] +**accountManagers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of account managers | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**cloudExternalId** | **(optional)** **string** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithnecount.md b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithnecount.md new file mode 100644 index 00000000..b9ec21a7 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/Nonemployeesourcewithnecount.md @@ -0,0 +1,27 @@ +--- +id: v1-nonemployeesourcewithnecount-v1 +title: NonemployeesourcewithnecountV1 +pagination_label: NonemployeesourcewithnecountV1 +sidebar_label: NonemployeesourcewithnecountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NonemployeesourcewithnecountV1', 'v1NonemployeesourcewithnecountV1'] +slug: /tools/sdk/typescript/non_employee_lifecycle_management/models/nonemployeesourcewithnecount-v1 +tags: ['SDK', 'Software Development Kit', 'NonemployeesourcewithnecountV1', 'v1NonemployeesourcewithnecountV1'] +--- + +# NonemployeesourcewithnecountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Non-Employee source id. | [default to undefined] +**sourceId** | **(optional)** **string** | Source Id associated with this non-employee source. | [default to undefined] +**name** | **(optional)** **string** | Source name associated with this non-employee source. | [default to undefined] +**description** | **(optional)** **string** | Source description associated with this non-employee source. | [default to undefined] +**approvers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of approvers | [default to undefined] +**accountManagers** | **(optional)** **Array<NonemployeeidentityreferencewithidV1>** | List of account managers | [default to undefined] +**modified** | **(optional)** **string** | When the request was last modified. | [default to undefined] +**created** | **(optional)** **string** | When the request was created. | [default to undefined] +**nonEmployeeCount** | **(optional)** **number** | Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. | [default to undefined] + diff --git a/sdk-output/non_employee_lifecycle_management/docs/Models/README.md b/sdk-output/non_employee_lifecycle_management/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/non_employee_lifecycle_management/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/notifications/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/notifications/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..86faa2dd --- /dev/null +++ b/sdk-output/notifications/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,251 @@ +- path: /verified-domains/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#create-domain-dkim-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const domainaddressV1: DomainaddressV1 = ; // DomainaddressV1 | + const result = await apiInstance.createDomainDkimV1(domainaddressV1); + console.log(result); +- path: /notification-templates/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#create-notification-template-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const templatedtoV1: TemplatedtoV1 = ; // TemplatedtoV1 | + const result = await apiInstance.createNotificationTemplateV1(templatedtoV1); + console.log(result); +- path: /verified-from-addresses/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#create-verified-from-address-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const emailstatusdtoV1: EmailstatusdtoV1 = {"email":"sender@example.com"}; // EmailstatusdtoV1 | + const result = await apiInstance.createVerifiedFromAddressV1(emailstatusdtoV1); + console.log(result); +- path: /notification-templates/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#delete-notification-templates-in-bulk-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const templatebulkdeletedtoV1: Array<TemplatebulkdeletedtoV1> = ; // Array | + const result = await apiInstance.deleteNotificationTemplatesInBulkV1(templatebulkdeletedtoV1); + console.log(result); +- path: /verified-from-addresses/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#delete-verified-from-address-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Unique identifier of the verified sender address to delete. (default to undefined) + const result = await apiInstance.deleteVerifiedFromAddressV1(id); + console.log(result); +- path: /verified-domains/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-dkim-attributes-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.getDkimAttributesV1(); + console.log(result); +- path: /mail-from-attributes/v1/{identity} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-mail-from-attributes-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const identity: string = 'bobsmith@sailpoint.com'; // string | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status (default to undefined) + const result = await apiInstance.getMailFromAttributesV1(identity); + console.log(result); +- path: /notification-preferences/v1/{key} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-notification-preferences-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const key: string = 'key_example'; // string | The key. (default to undefined) + const result = await apiInstance.getNotificationPreferencesV1(key); + console.log(result); +- path: /notification-templates/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-notification-template-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the Notification Template (default to undefined) + const result = await apiInstance.getNotificationTemplateV1(id); + console.log(result); +- path: /notification-template-variables/v1/{key}/{medium} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-notification-template-variables-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const key: string = 'approval_request_notification'; // string | The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. (default to undefined) + const medium: string = 'EMAIL'; // 'EMAIL' | 'SLACK' | 'TEAMS' | The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. (default to undefined) + const sorters: string = '-description'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** (optional) (default to undefined) + const result = await apiInstance.getNotificationTemplateVariablesV1(key, medium); + console.log(result); +- path: /notification-template-context/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#get-notifications-template-context-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const result = await apiInstance.getNotificationsTemplateContextV1(); + console.log(result); +- path: /verified-from-addresses/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#list-from-addresses-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'email eq "john.doe@company.com"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* (optional) (default to undefined) + const sorters: string = 'email'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) (default to undefined) + const result = await apiInstance.listFromAddressesV1(); + console.log(result); +- path: /notification-template-defaults/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#list-notification-template-defaults-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'key eq "cloud_manual_work_item_summary"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) (default to undefined) + const result = await apiInstance.listNotificationTemplateDefaultsV1(); + console.log(result); +- path: /notification-templates/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#list-notification-templates-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'medium eq "EMAIL"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'key, -name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** (optional) (default to undefined) + const result = await apiInstance.listNotificationTemplatesV1(); + console.log(result); +- path: /mail-from-attributes/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#put-mail-from-attributes-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const mailfromattributesdtoV1: MailfromattributesdtoV1 = {"identity":"BobSmith@sailpoint.com","mailFromDomain":"example.sailpoint.com"}; // MailfromattributesdtoV1 | + const result = await apiInstance.putMailFromAttributesV1(mailfromattributesdtoV1); + console.log(result); +- path: /send-test-notification/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/notifications/methods/notifications#send-test-notification-v1 + source: | + import { NotificationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new NotificationsV1Api(configuration); + const sendtestnotificationrequestdtoV1: SendtestnotificationrequestdtoV1 = {"key":"cloud_manual_work_item_summary","medium":"EMAIL","context":{"numberOfPendingTasks":"4","ownerId":"201327fda1c44704ac01181e963d463c"}}; // SendtestnotificationrequestdtoV1 | + const result = await apiInstance.sendTestNotificationV1(sendtestnotificationrequestdtoV1); + console.log(result); diff --git a/sdk-output/notifications/docs/Methods/Index.md b/sdk-output/notifications/docs/Methods/Index.md new file mode 100644 index 00000000..77b6e371 --- /dev/null +++ b/sdk-output/notifications/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: notifications-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: notifications-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'notifications', 'methods'] +slug: /tools/sdk/typescript/notifications/methods +tags: ['SDK', 'Software Development Kit', 'notifications', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/notifications/docs/Methods/NotificationsV1Api.md b/sdk-output/notifications/docs/Methods/NotificationsV1Api.md new file mode 100644 index 00000000..e1a4a8c7 --- /dev/null +++ b/sdk-output/notifications/docs/Methods/NotificationsV1Api.md @@ -0,0 +1,670 @@ +--- +id: v1-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Notifications', 'v1Notifications'] +slug: /tools/sdk/typescript/notifications/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'v1Notifications'] +--- + +# NotificationsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-domain-dkim-v1**](#create-domain-dkim-v1) | **POST** `/verified-domains/v1` | Verify domain address via dkim +[**create-notification-template-v1**](#create-notification-template-v1) | **POST** `/notification-templates/v1` | Create notification template +[**create-verified-from-address-v1**](#create-verified-from-address-v1) | **POST** `/verified-from-addresses/v1` | Create verified from address +[**delete-notification-templates-in-bulk-v1**](#delete-notification-templates-in-bulk-v1) | **POST** `/notification-templates/v1/bulk-delete` | Bulk delete notification templates +[**delete-verified-from-address-v1**](#delete-verified-from-address-v1) | **DELETE** `/verified-from-addresses/v1/{id}` | Delete verified from address +[**get-dkim-attributes-v1**](#get-dkim-attributes-v1) | **GET** `/verified-domains/v1` | Get dkim attributes +[**get-mail-from-attributes-v1**](#get-mail-from-attributes-v1) | **GET** `/mail-from-attributes/v1/{identity}` | Get mail from attributes +[**get-notification-preferences-v1**](#get-notification-preferences-v1) | **GET** `/notification-preferences/v1/{key}` | List notification preferences for tenant. +[**get-notification-template-v1**](#get-notification-template-v1) | **GET** `/notification-templates/v1/{id}` | Get notification template by id +[**get-notification-template-variables-v1**](#get-notification-template-variables-v1) | **GET** `/notification-template-variables/v1/{key}/{medium}` | Get notification template variables +[**get-notifications-template-context-v1**](#get-notifications-template-context-v1) | **GET** `/notification-template-context/v1` | Get notification template context +[**list-from-addresses-v1**](#list-from-addresses-v1) | **GET** `/verified-from-addresses/v1` | List from addresses +[**list-notification-template-defaults-v1**](#list-notification-template-defaults-v1) | **GET** `/notification-template-defaults/v1` | List notification template defaults +[**list-notification-templates-v1**](#list-notification-templates-v1) | **GET** `/notification-templates/v1` | List notification templates +[**put-mail-from-attributes-v1**](#put-mail-from-attributes-v1) | **PUT** `/mail-from-attributes/v1` | Change mail from domain +[**send-test-notification-v1**](#send-test-notification-v1) | **POST** `/send-test-notification/v1` | Send test notification + + +## create-domain-dkim-v1 +Verify domain address via dkim +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-domain-dkim-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**domainaddressV1** | **DomainaddressV1** | | + +### Return type + +**DomainstatusdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const domainaddressV1: DomainaddressV1 = ; // +const result = await apiInstance.createDomainDkimV1(domainaddressV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-notification-template-v1 +Create notification template +This will update notification templates that are available in your tenant. +Note that you cannot create new templates in your tenant, but you can use this to create custom notifications from existing templates. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. +Modify the fields you want to change and submit the POST request when ready. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-notification-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**templatedtoV1** | **TemplatedtoV1** | | + +### Return type + +**TemplatedtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const templatedtoV1: TemplatedtoV1 = ; // +const result = await apiInstance.createNotificationTemplateV1(templatedtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-verified-from-address-v1 +Create verified from address +Create a new sender email address and initiate verification process. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-verified-from-address-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**emailstatusdtoV1** | **EmailstatusdtoV1** | | + +### Return type + +**EmailstatusdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const emailstatusdtoV1: EmailstatusdtoV1 = {"email":"sender@example.com"}; // +const result = await apiInstance.createVerifiedFromAddressV1(emailstatusdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-notification-templates-in-bulk-v1 +Bulk delete notification templates +This lets you bulk delete templates that you previously created for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-notification-templates-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**templatebulkdeletedtoV1** | **Array<TemplatebulkdeletedtoV1>** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const templatebulkdeletedtoV1: Array<TemplatebulkdeletedtoV1> = ; // +const result = await apiInstance.deleteNotificationTemplatesInBulkV1(templatebulkdeletedtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-verified-from-address-v1 +Delete verified from address +Delete a verified sender email address + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-verified-from-address-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier of the verified sender address to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Unique identifier of the verified sender address to delete. +const result = await apiInstance.deleteVerifiedFromAddressV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-dkim-attributes-v1 +Get dkim attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-dkim-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getDkimAttributesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-mail-from-attributes-v1 +Get mail from attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-mail-from-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identity** | **string** | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status | [default to undefined] + +### Return type + +**MailfromattributesV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const identity: string = bobsmith@sailpoint.com; // Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status +const result = await apiInstance.getMailFromAttributesV1(identity); +console.log(result); +``` + +[[Back to top]](#) + +## get-notification-preferences-v1 +List notification preferences for tenant. +Returns a list of notification preferences for tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-notification-preferences-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | The key. | [default to undefined] + +### Return type + +**PreferencesdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const key: string = key_example; // The key. +const result = await apiInstance.getNotificationPreferencesV1(key); +console.log(result); +``` + +[[Back to top]](#) + +## get-notification-template-v1 +Get notification template by id +This gets a template that you have modified for your site by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-notification-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the Notification Template | [default to undefined] + +### Return type + +**TemplatedtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the Notification Template +const result = await apiInstance.getNotificationTemplateV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-notification-template-variables-v1 +Get notification template variables +Returns global variables and template-specific variables for a given notification template key and medium. +Use these variable names in template content; they are replaced at send time with the corresponding values. +Variable lists can be sorted by key, type, or description via the sorters query parameter (default ascending by key). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-notification-template-variables-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. | [default to undefined] +**medium** | **'EMAIL' | 'SLACK' | 'TEAMS'** | The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** | [optional] [default to undefined] + +### Return type + +**TemplatevariablesdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const key: string = approval_request_notification; // The notification template key. Valid keys (and key/medium pairs) are available from the list notification templates operation. +const medium: string = EMAIL; // The notification template medium (e.g. EMAIL, SLACK, TEAMS). Valid key/medium pairs are available from the list notification templates operation. +const sorters: string = -description; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, type, description** (optional) +const result = await apiInstance.getNotificationTemplateVariablesV1(key, medium); +console.log(result); +``` + +[[Back to top]](#) + +## get-notifications-template-context-v1 +Get notification template context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-notifications-template-context-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**NotificationtemplatecontextV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const result = await apiInstance.getNotificationsTemplateContextV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-from-addresses-v1 +List from addresses +Retrieve a list of sender email addresses and their verification statuses + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-from-addresses-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = email eq "john.doe@company.com"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, gt, lt* (optional) +const sorters: string = email; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) +const result = await apiInstance.listFromAddressesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-notification-template-defaults-v1 +List notification template defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-notification-template-defaults-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = key eq "cloud_manual_work_item_summary"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) +const result = await apiInstance.listNotificationTemplateDefaultsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-notification-templates-v1 +List notification templates +This lists the templates that you have modified for your site. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-notification-templates-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = medium eq "EMAIL"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) +const sorters: string = key, -name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **key, name, medium** (optional) +const result = await apiInstance.listNotificationTemplatesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-mail-from-attributes-v1 +Change mail from domain +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-mail-from-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**mailfromattributesdtoV1** | **MailfromattributesdtoV1** | | + +### Return type + +**MailfromattributesV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const mailfromattributesdtoV1: MailfromattributesdtoV1 = {"identity":"BobSmith@sailpoint.com","mailFromDomain":"example.sailpoint.com"}; // +const result = await apiInstance.putMailFromAttributesV1(mailfromattributesdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## send-test-notification-v1 +Send test notification +Send a Test Notification + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-test-notification-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sendtestnotificationrequestdtoV1** | **SendtestnotificationrequestdtoV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { NotificationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new NotificationsV1Api(configuration); +const sendtestnotificationrequestdtoV1: SendtestnotificationrequestdtoV1 = {"key":"cloud_manual_work_item_summary","medium":"EMAIL","context":{"numberOfPendingTasks":"4","ownerId":"201327fda1c44704ac01181e963d463c"}}; // +const result = await apiInstance.sendTestNotificationV1(sendtestnotificationrequestdtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/notifications/docs/Models/CreateDomainDkimV1405Response.md b/sdk-output/notifications/docs/Models/CreateDomainDkimV1405Response.md new file mode 100644 index 00000000..9fe86eb8 --- /dev/null +++ b/sdk-output/notifications/docs/Models/CreateDomainDkimV1405Response.md @@ -0,0 +1,21 @@ +--- +id: v1-create-domain-dkim-v1405-response-v1 +title: CreateDomainDkimV1405ResponseV1 +pagination_label: CreateDomainDkimV1405ResponseV1 +sidebar_label: CreateDomainDkimV1405ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateDomainDkimV1405ResponseV1', 'v1CreateDomainDkimV1405ResponseV1'] +slug: /tools/sdk/typescript/notifications/models/create-domain-dkim-v1405-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkimV1405ResponseV1', 'v1CreateDomainDkimV1405ResponseV1'] +--- + +# CreateDomainDkimV1405ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errorName** | **(optional)** **any** | A message describing the error | [default to undefined] +**errorMessage** | **(optional)** **any** | Description of the error | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Dkimattributes.md b/sdk-output/notifications/docs/Models/Dkimattributes.md new file mode 100644 index 00000000..1fd3179c --- /dev/null +++ b/sdk-output/notifications/docs/Models/Dkimattributes.md @@ -0,0 +1,24 @@ +--- +id: v1-dkimattributes-v1 +title: DkimattributesV1 +pagination_label: DkimattributesV1 +sidebar_label: DkimattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DkimattributesV1', 'v1DkimattributesV1'] +slug: /tools/sdk/typescript/notifications/models/dkimattributes-v1 +tags: ['SDK', 'Software Development Kit', 'DkimattributesV1', 'v1DkimattributesV1'] +--- + +# DkimattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | UUID associated with domain to be verified | [default to undefined] +**address** | **(optional)** **string** | The identity or domain address | [default to undefined] +**dkimEnabled** | **(optional)** **boolean** | Whether or not DKIM has been enabled for this domain / identity | [default to false] +**dkimTokens** | **(optional)** **Array<string>** | The tokens to be added to a DNS for verification | [default to undefined] +**dkimVerificationStatus** | **(optional)** **string** | The current status if the domain /identity has been verified. Ie SUCCESS, FAILED, PENDING | [default to undefined] +**region** | **(optional)** **string** | The AWS SES region the domain is associated with | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Domainaddress.md b/sdk-output/notifications/docs/Models/Domainaddress.md new file mode 100644 index 00000000..4749c7f8 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Domainaddress.md @@ -0,0 +1,19 @@ +--- +id: v1-domainaddress-v1 +title: DomainaddressV1 +pagination_label: DomainaddressV1 +sidebar_label: DomainaddressV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DomainaddressV1', 'v1DomainaddressV1'] +slug: /tools/sdk/typescript/notifications/models/domainaddress-v1 +tags: ['SDK', 'Software Development Kit', 'DomainaddressV1', 'v1DomainaddressV1'] +--- + +# DomainaddressV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domain** | **(optional)** **string** | A domain address | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Domainstatusdto.md b/sdk-output/notifications/docs/Models/Domainstatusdto.md new file mode 100644 index 00000000..6f0268cd --- /dev/null +++ b/sdk-output/notifications/docs/Models/Domainstatusdto.md @@ -0,0 +1,24 @@ +--- +id: v1-domainstatusdto-v1 +title: DomainstatusdtoV1 +pagination_label: DomainstatusdtoV1 +sidebar_label: DomainstatusdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DomainstatusdtoV1', 'v1DomainstatusdtoV1'] +slug: /tools/sdk/typescript/notifications/models/domainstatusdto-v1 +tags: ['SDK', 'Software Development Kit', 'DomainstatusdtoV1', 'v1DomainstatusdtoV1'] +--- + +# DomainstatusdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | New UUID associated with domain to be verified | [default to undefined] +**domain** | **(optional)** **string** | A domain address | [default to undefined] +**dkimEnabled** | **(optional)** **boolean** | DKIM is enabled for this domain | [default to false] +**dkimTokens** | **(optional)** **Array<string>** | DKIM tokens required for authentication | [default to undefined] +**dkimVerificationStatus** | **(optional)** **string** | Status of DKIM authentication | [default to undefined] +**region** | **(optional)** **string** | The AWS SES region the domain is associated with | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Emailstatusdto.md b/sdk-output/notifications/docs/Models/Emailstatusdto.md new file mode 100644 index 00000000..a92f0d0a --- /dev/null +++ b/sdk-output/notifications/docs/Models/Emailstatusdto.md @@ -0,0 +1,23 @@ +--- +id: v1-emailstatusdto-v1 +title: EmailstatusdtoV1 +pagination_label: EmailstatusdtoV1 +sidebar_label: EmailstatusdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EmailstatusdtoV1', 'v1EmailstatusdtoV1'] +slug: /tools/sdk/typescript/notifications/models/emailstatusdto-v1 +tags: ['SDK', 'Software Development Kit', 'EmailstatusdtoV1', 'v1EmailstatusdtoV1'] +--- + +# EmailstatusdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the verified sender address | [default to undefined] +**email** | **(optional)** **string** | The verified sender email address | [default to undefined] +**isVerifiedByDomain** | **(optional)** **boolean** | Whether the sender address is verified by domain | [default to false] +**verificationStatus** | **(optional)** **string** | The verification status of the sender address | [default to undefined] +**region** | **(optional)** **string** | The AWS SES region the sender address is associated with | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Errormessagedto.md b/sdk-output/notifications/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8a8fbf82 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/notifications/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Errorresponsedto.md b/sdk-output/notifications/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..385ce590 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/notifications/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1401Response.md b/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1401Response.md new file mode 100644 index 00000000..81f8ea31 --- /dev/null +++ b/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-notification-template-variables-v1401-response-v1 +title: GetNotificationTemplateVariablesV1401ResponseV1 +pagination_label: GetNotificationTemplateVariablesV1401ResponseV1 +sidebar_label: GetNotificationTemplateVariablesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetNotificationTemplateVariablesV1401ResponseV1', 'v1GetNotificationTemplateVariablesV1401ResponseV1'] +slug: /tools/sdk/typescript/notifications/models/get-notification-template-variables-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetNotificationTemplateVariablesV1401ResponseV1', 'v1GetNotificationTemplateVariablesV1401ResponseV1'] +--- + +# GetNotificationTemplateVariablesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1429Response.md b/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1429Response.md new file mode 100644 index 00000000..ea683f48 --- /dev/null +++ b/sdk-output/notifications/docs/Models/GetNotificationTemplateVariablesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-notification-template-variables-v1429-response-v1 +title: GetNotificationTemplateVariablesV1429ResponseV1 +pagination_label: GetNotificationTemplateVariablesV1429ResponseV1 +sidebar_label: GetNotificationTemplateVariablesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetNotificationTemplateVariablesV1429ResponseV1', 'v1GetNotificationTemplateVariablesV1429ResponseV1'] +slug: /tools/sdk/typescript/notifications/models/get-notification-template-variables-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetNotificationTemplateVariablesV1429ResponseV1', 'v1GetNotificationTemplateVariablesV1429ResponseV1'] +--- + +# GetNotificationTemplateVariablesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Index.md b/sdk-output/notifications/docs/Models/Index.md new file mode 100644 index 00000000..86184558 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: notifications-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: notifications-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'notifications', 'models'] +slug: /tools/sdk/typescript/notifications/models +tags: ['SDK', 'Software Development Kit', 'notifications', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/notifications/docs/Models/Localeorigin.md b/sdk-output/notifications/docs/Models/Localeorigin.md new file mode 100644 index 00000000..4f3c2951 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/notifications/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/notifications/docs/Models/Mailfromattributes.md b/sdk-output/notifications/docs/Models/Mailfromattributes.md new file mode 100644 index 00000000..f89250ff --- /dev/null +++ b/sdk-output/notifications/docs/Models/Mailfromattributes.md @@ -0,0 +1,23 @@ +--- +id: v1-mailfromattributes-v1 +title: MailfromattributesV1 +pagination_label: MailfromattributesV1 +sidebar_label: MailfromattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MailfromattributesV1', 'v1MailfromattributesV1'] +slug: /tools/sdk/typescript/notifications/models/mailfromattributes-v1 +tags: ['SDK', 'Software Development Kit', 'MailfromattributesV1', 'v1MailfromattributesV1'] +--- + +# MailfromattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **(optional)** **string** | The email identity | [default to undefined] +**mailFromDomain** | **(optional)** **string** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [default to undefined] +**mxRecord** | **(optional)** **string** | MX record that is required in customer\'s DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [default to undefined] +**txtRecord** | **(optional)** **string** | TXT record that is required in customer\'s DNS in order to prove that Amazon SES is authorized to send email from your domain | [default to undefined] +**mailFromDomainStatus** | **(optional)** **string** | The current status of the MAIL FROM verification | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Mailfromattributesdto.md b/sdk-output/notifications/docs/Models/Mailfromattributesdto.md new file mode 100644 index 00000000..1cf1d595 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Mailfromattributesdto.md @@ -0,0 +1,20 @@ +--- +id: v1-mailfromattributesdto-v1 +title: MailfromattributesdtoV1 +pagination_label: MailfromattributesdtoV1 +sidebar_label: MailfromattributesdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MailfromattributesdtoV1', 'v1MailfromattributesdtoV1'] +slug: /tools/sdk/typescript/notifications/models/mailfromattributesdto-v1 +tags: ['SDK', 'Software Development Kit', 'MailfromattributesdtoV1', 'v1MailfromattributesdtoV1'] +--- + +# MailfromattributesdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **(optional)** **string** | The identity or domain address | [default to undefined] +**mailFromDomain** | **(optional)** **string** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Medium.md b/sdk-output/notifications/docs/Models/Medium.md new file mode 100644 index 00000000..dea740cb --- /dev/null +++ b/sdk-output/notifications/docs/Models/Medium.md @@ -0,0 +1,23 @@ +--- +id: v1-medium-v1 +title: MediumV1 +pagination_label: MediumV1 +sidebar_label: MediumV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MediumV1', 'v1MediumV1'] +slug: /tools/sdk/typescript/notifications/models/medium-v1 +tags: ['SDK', 'Software Development Kit', 'MediumV1', 'v1MediumV1'] +--- + +# MediumV1 + +## Enum + + +* `Email` (value: `'EMAIL'`) + +* `Slack` (value: `'SLACK'`) + +* `Teams` (value: `'TEAMS'`) + + diff --git a/sdk-output/notifications/docs/Models/Notificationtemplatecontext.md b/sdk-output/notifications/docs/Models/Notificationtemplatecontext.md new file mode 100644 index 00000000..d20df2b2 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Notificationtemplatecontext.md @@ -0,0 +1,21 @@ +--- +id: v1-notificationtemplatecontext-v1 +title: NotificationtemplatecontextV1 +pagination_label: NotificationtemplatecontextV1 +sidebar_label: NotificationtemplatecontextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NotificationtemplatecontextV1', 'v1NotificationtemplatecontextV1'] +slug: /tools/sdk/typescript/notifications/models/notificationtemplatecontext-v1 +tags: ['SDK', 'Software Development Kit', 'NotificationtemplatecontextV1', 'v1NotificationtemplatecontextV1'] +--- + +# NotificationtemplatecontextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** | A JSON object that stores the context. | [default to undefined] +**created** | **(optional)** **string** | When the global context was created | [default to undefined] +**modified** | **(optional)** **string** | When the global context was last modified | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Preferencesdto.md b/sdk-output/notifications/docs/Models/Preferencesdto.md new file mode 100644 index 00000000..f55fdd7d --- /dev/null +++ b/sdk-output/notifications/docs/Models/Preferencesdto.md @@ -0,0 +1,21 @@ +--- +id: v1-preferencesdto-v1 +title: PreferencesdtoV1 +pagination_label: PreferencesdtoV1 +sidebar_label: PreferencesdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PreferencesdtoV1', 'v1PreferencesdtoV1'] +slug: /tools/sdk/typescript/notifications/models/preferencesdto-v1 +tags: ['SDK', 'Software Development Kit', 'PreferencesdtoV1', 'v1PreferencesdtoV1'] +--- + +# PreferencesdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template notification key. | [default to undefined] +**mediums** | **(optional)** **Array<MediumV1>** | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [default to undefined] +**modified** | **(optional)** **string** | Modified date of preference | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/README.md b/sdk-output/notifications/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/notifications/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/notifications/docs/Models/Sendtestnotificationrequestdto.md b/sdk-output/notifications/docs/Models/Sendtestnotificationrequestdto.md new file mode 100644 index 00000000..16d88218 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Sendtestnotificationrequestdto.md @@ -0,0 +1,25 @@ +--- +id: v1-sendtestnotificationrequestdto-v1 +title: SendtestnotificationrequestdtoV1 +pagination_label: SendtestnotificationrequestdtoV1 +sidebar_label: SendtestnotificationrequestdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SendtestnotificationrequestdtoV1', 'v1SendtestnotificationrequestdtoV1'] +slug: /tools/sdk/typescript/notifications/models/sendtestnotificationrequestdto-v1 +tags: ['SDK', 'Software Development Kit', 'SendtestnotificationrequestdtoV1', 'v1SendtestnotificationrequestdtoV1'] +--- + +# SendtestnotificationrequestdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template notification key. | [default to undefined] +**medium** | **(optional)** **string** | The notification medium. Has to be one of the following enum values. | [default to undefined] +**locale** | **(optional)** **string** | The locale for the message text. | [default to undefined] +**context** | **(optional)** **object** | A Json object that denotes the context specific to the template. | [default to undefined] +**recipientEmailList** | **(optional)** **Array<string>** | A list of override recipient email addresses for the test notification. | [default to undefined] +**carbonCopy** | **(optional)** **Array<string>** | A list of CC email addresses for the test notification. | [default to undefined] +**blindCarbonCopy** | **(optional)** **Array<string>** | A list of BCC email addresses for the test notification. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatebulkdeletedto.md b/sdk-output/notifications/docs/Models/Templatebulkdeletedto.md new file mode 100644 index 00000000..9a625448 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatebulkdeletedto.md @@ -0,0 +1,21 @@ +--- +id: v1-templatebulkdeletedto-v1 +title: TemplatebulkdeletedtoV1 +pagination_label: TemplatebulkdeletedtoV1 +sidebar_label: TemplatebulkdeletedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatebulkdeletedtoV1', 'v1TemplatebulkdeletedtoV1'] +slug: /tools/sdk/typescript/notifications/models/templatebulkdeletedto-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatebulkdeletedtoV1', 'v1TemplatebulkdeletedtoV1'] +--- + +# TemplatebulkdeletedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | The template key to delete | [default to undefined] +**medium** | **(optional)** **string** | The notification medium (EMAIL, SLACK, or TEAMS) | [default to undefined] +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatedto.md b/sdk-output/notifications/docs/Models/Templatedto.md new file mode 100644 index 00000000..3baf5858 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatedto.md @@ -0,0 +1,34 @@ +--- +id: v1-templatedto-v1 +title: TemplatedtoV1 +pagination_label: TemplatedtoV1 +sidebar_label: TemplatedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatedtoV1', 'v1TemplatedtoV1'] +slug: /tools/sdk/typescript/notifications/models/templatedto-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatedtoV1', 'v1TemplatedtoV1'] +--- + +# TemplatedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | The key of the template | [default to undefined] +**name** | **(optional)** **string** | The name of the Task Manager Subscription | [default to undefined] +**medium** | **string** | The message medium. More mediums may be added in the future. | [default to undefined] +**locale** | **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**subject** | **(optional)** **string** | The subject line in the template | [default to undefined] +**header** | **(optional)** **string** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [default to undefined] +**body** | **(optional)** **string** | The body in the template | [default to undefined] +**footer** | **(optional)** **string** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [default to undefined] +**from** | **(optional)** **string** | The \"From:\" address in the template | [default to undefined] +**replyTo** | **(optional)** **string** | The \"Reply To\" line in the template | [default to undefined] +**description** | **(optional)** **string** | The description in the template | [default to undefined] +**id** | **(optional)** **string** | This is auto-generated. | [default to undefined] +**created** | **(optional)** **string** | The time when this template is created. This is auto-generated. | [default to undefined] +**modified** | **(optional)** **string** | The time when this template was last modified. This is auto-generated. | [default to undefined] +**slackTemplate** | **(optional)** **TemplatedtoSlackTemplateV1** | | [default to undefined] +**teamsTemplate** | **(optional)** **TemplatedtoTeamsTemplateV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/TemplatedtoSlackTemplate.md b/sdk-output/notifications/docs/Models/TemplatedtoSlackTemplate.md new file mode 100644 index 00000000..9678b809 --- /dev/null +++ b/sdk-output/notifications/docs/Models/TemplatedtoSlackTemplate.md @@ -0,0 +1,29 @@ +--- +id: v1-templatedto-slack-template-v1 +title: TemplatedtoSlackTemplateV1 +pagination_label: TemplatedtoSlackTemplateV1 +sidebar_label: TemplatedtoSlackTemplateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatedtoSlackTemplateV1', 'v1TemplatedtoSlackTemplateV1'] +slug: /tools/sdk/typescript/notifications/models/templatedto-slack-template-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatedtoSlackTemplateV1', 'v1TemplatedtoSlackTemplateV1'] +--- + +# TemplatedtoSlackTemplateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template key | [default to undefined] +**text** | **(optional)** **string** | The main text content of the Slack message | [default to undefined] +**blocks** | **(optional)** **string** | JSON string of Slack Block Kit blocks for rich formatting | [default to undefined] +**attachments** | **(optional)** **string** | JSON string of Slack attachments | [default to undefined] +**notificationType** | **(optional)** **string** | The type of notification | [default to undefined] +**approvalId** | **(optional)** **string** | The approval request ID | [default to undefined] +**requestId** | **(optional)** **string** | The request ID | [default to undefined] +**requestedById** | **(optional)** **string** | The ID of the user who made the request | [default to undefined] +**isSubscription** | **(optional)** **boolean** | Whether this is a subscription notification | [default to false] +**autoApprovalData** | **(optional)** **TemplateslackAutoApprovalDataV1** | | [default to undefined] +**customFields** | **(optional)** **TemplateslackCustomFieldsV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/TemplatedtoTeamsTemplate.md b/sdk-output/notifications/docs/Models/TemplatedtoTeamsTemplate.md new file mode 100644 index 00000000..469555a5 --- /dev/null +++ b/sdk-output/notifications/docs/Models/TemplatedtoTeamsTemplate.md @@ -0,0 +1,29 @@ +--- +id: v1-templatedto-teams-template-v1 +title: TemplatedtoTeamsTemplateV1 +pagination_label: TemplatedtoTeamsTemplateV1 +sidebar_label: TemplatedtoTeamsTemplateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatedtoTeamsTemplateV1', 'v1TemplatedtoTeamsTemplateV1'] +slug: /tools/sdk/typescript/notifications/models/templatedto-teams-template-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatedtoTeamsTemplateV1', 'v1TemplatedtoTeamsTemplateV1'] +--- + +# TemplatedtoTeamsTemplateV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template key | [default to undefined] +**title** | **(optional)** **string** | The title of the Teams message | [default to undefined] +**text** | **(optional)** **string** | The main text content of the Teams message | [default to undefined] +**messageJSON** | **(optional)** **string** | JSON string of the Teams adaptive card | [default to undefined] +**isSubscription** | **(optional)** **boolean** | Whether this is a subscription notification | [default to false] +**approvalId** | **(optional)** **string** | The approval request ID | [default to undefined] +**requestId** | **(optional)** **string** | The request ID | [default to undefined] +**requestedById** | **(optional)** **string** | The ID of the user who made the request | [default to undefined] +**notificationType** | **(optional)** **string** | The type of notification | [default to undefined] +**autoApprovalData** | **(optional)** **TemplateslackAutoApprovalDataV1** | | [default to undefined] +**customFields** | **(optional)** **TemplateslackCustomFieldsV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatedtodefault.md b/sdk-output/notifications/docs/Models/Templatedtodefault.md new file mode 100644 index 00000000..ab9e6cab --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatedtodefault.md @@ -0,0 +1,31 @@ +--- +id: v1-templatedtodefault-v1 +title: TemplatedtodefaultV1 +pagination_label: TemplatedtodefaultV1 +sidebar_label: TemplatedtodefaultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatedtodefaultV1', 'v1TemplatedtodefaultV1'] +slug: /tools/sdk/typescript/notifications/models/templatedtodefault-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatedtodefaultV1', 'v1TemplatedtodefaultV1'] +--- + +# TemplatedtodefaultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The key of the default template | [default to undefined] +**name** | **(optional)** **string** | The name of the default template | [default to undefined] +**medium** | **(optional)** **string** | The message medium. More mediums may be added in the future. | [default to undefined] +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**subject** | **(optional)** **string** | The subject of the default template | [default to undefined] +**header** | **(optional)** **string** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [default to undefined] +**body** | **(optional)** **string** | The body of the default template | [default to undefined] +**footer** | **(optional)** **string** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [default to undefined] +**from** | **(optional)** **string** | The \"From:\" address of the default template | [default to undefined] +**replyTo** | **(optional)** **string** | The \"Reply To\" field of the default template | [default to undefined] +**description** | **(optional)** **string** | The description of the default template | [default to undefined] +**slackTemplate** | **(optional)** **TemplateslackV1** | | [default to undefined] +**teamsTemplate** | **(optional)** **TemplateteamsV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatemediumdto.md b/sdk-output/notifications/docs/Models/Templatemediumdto.md new file mode 100644 index 00000000..0ce25197 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatemediumdto.md @@ -0,0 +1,23 @@ +--- +id: v1-templatemediumdto-v1 +title: TemplatemediumdtoV1 +pagination_label: TemplatemediumdtoV1 +sidebar_label: TemplatemediumdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatemediumdtoV1', 'v1TemplatemediumdtoV1'] +slug: /tools/sdk/typescript/notifications/models/templatemediumdto-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatemediumdtoV1', 'v1TemplatemediumdtoV1'] +--- + +# TemplatemediumdtoV1 + +## Enum + + +* `Email` (value: `'EMAIL'`) + +* `Slack` (value: `'SLACK'`) + +* `Teams` (value: `'TEAMS'`) + + diff --git a/sdk-output/notifications/docs/Models/Templateslack.md b/sdk-output/notifications/docs/Models/Templateslack.md new file mode 100644 index 00000000..fff523a4 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templateslack.md @@ -0,0 +1,29 @@ +--- +id: v1-templateslack-v1 +title: TemplateslackV1 +pagination_label: TemplateslackV1 +sidebar_label: TemplateslackV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplateslackV1', 'v1TemplateslackV1'] +slug: /tools/sdk/typescript/notifications/models/templateslack-v1 +tags: ['SDK', 'Software Development Kit', 'TemplateslackV1', 'v1TemplateslackV1'] +--- + +# TemplateslackV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template key | [default to undefined] +**text** | **(optional)** **string** | The main text content of the Slack message | [default to undefined] +**blocks** | **(optional)** **string** | JSON string of Slack Block Kit blocks for rich formatting | [default to undefined] +**attachments** | **(optional)** **string** | JSON string of Slack attachments | [default to undefined] +**notificationType** | **(optional)** **string** | The type of notification | [default to undefined] +**approvalId** | **(optional)** **string** | The approval request ID | [default to undefined] +**requestId** | **(optional)** **string** | The request ID | [default to undefined] +**requestedById** | **(optional)** **string** | The ID of the user who made the request | [default to undefined] +**isSubscription** | **(optional)** **boolean** | Whether this is a subscription notification | [default to false] +**autoApprovalData** | **(optional)** **TemplateslackAutoApprovalDataV1** | | [default to undefined] +**customFields** | **(optional)** **TemplateslackCustomFieldsV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/TemplateslackAutoApprovalData.md b/sdk-output/notifications/docs/Models/TemplateslackAutoApprovalData.md new file mode 100644 index 00000000..bdafe62e --- /dev/null +++ b/sdk-output/notifications/docs/Models/TemplateslackAutoApprovalData.md @@ -0,0 +1,23 @@ +--- +id: v1-templateslack-auto-approval-data-v1 +title: TemplateslackAutoApprovalDataV1 +pagination_label: TemplateslackAutoApprovalDataV1 +sidebar_label: TemplateslackAutoApprovalDataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplateslackAutoApprovalDataV1', 'v1TemplateslackAutoApprovalDataV1'] +slug: /tools/sdk/typescript/notifications/models/templateslack-auto-approval-data-v1 +tags: ['SDK', 'Software Development Kit', 'TemplateslackAutoApprovalDataV1', 'v1TemplateslackAutoApprovalDataV1'] +--- + +# TemplateslackAutoApprovalDataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isAutoApproved** | **(optional)** **string** | Whether the request was auto-approved | [default to undefined] +**itemId** | **(optional)** **string** | The item ID | [default to undefined] +**itemType** | **(optional)** **string** | The item type | [default to undefined] +**autoApprovalMessageJSON** | **(optional)** **string** | JSON message for auto-approval | [default to undefined] +**autoApprovalTitle** | **(optional)** **string** | Title for auto-approval | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/TemplateslackCustomFields.md b/sdk-output/notifications/docs/Models/TemplateslackCustomFields.md new file mode 100644 index 00000000..c351ead6 --- /dev/null +++ b/sdk-output/notifications/docs/Models/TemplateslackCustomFields.md @@ -0,0 +1,22 @@ +--- +id: v1-templateslack-custom-fields-v1 +title: TemplateslackCustomFieldsV1 +pagination_label: TemplateslackCustomFieldsV1 +sidebar_label: TemplateslackCustomFieldsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplateslackCustomFieldsV1', 'v1TemplateslackCustomFieldsV1'] +slug: /tools/sdk/typescript/notifications/models/templateslack-custom-fields-v1 +tags: ['SDK', 'Software Development Kit', 'TemplateslackCustomFieldsV1', 'v1TemplateslackCustomFieldsV1'] +--- + +# TemplateslackCustomFieldsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestType** | **(optional)** **string** | The type of request | [default to undefined] +**containsDeny** | **(optional)** **string** | Whether the request contains a deny action | [default to undefined] +**campaignId** | **(optional)** **string** | The campaign ID | [default to undefined] +**campaignStatus** | **(optional)** **string** | The campaign status | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templateteams.md b/sdk-output/notifications/docs/Models/Templateteams.md new file mode 100644 index 00000000..02388f2d --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templateteams.md @@ -0,0 +1,29 @@ +--- +id: v1-templateteams-v1 +title: TemplateteamsV1 +pagination_label: TemplateteamsV1 +sidebar_label: TemplateteamsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplateteamsV1', 'v1TemplateteamsV1'] +slug: /tools/sdk/typescript/notifications/models/templateteams-v1 +tags: ['SDK', 'Software Development Kit', 'TemplateteamsV1', 'v1TemplateteamsV1'] +--- + +# TemplateteamsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The template key | [default to undefined] +**title** | **(optional)** **string** | The title of the Teams message | [default to undefined] +**text** | **(optional)** **string** | The main text content of the Teams message | [default to undefined] +**messageJSON** | **(optional)** **string** | JSON string of the Teams adaptive card | [default to undefined] +**isSubscription** | **(optional)** **boolean** | Whether this is a subscription notification | [default to false] +**approvalId** | **(optional)** **string** | The approval request ID | [default to undefined] +**requestId** | **(optional)** **string** | The request ID | [default to undefined] +**requestedById** | **(optional)** **string** | The ID of the user who made the request | [default to undefined] +**notificationType** | **(optional)** **string** | The type of notification | [default to undefined] +**autoApprovalData** | **(optional)** **TemplateslackAutoApprovalDataV1** | | [default to undefined] +**customFields** | **(optional)** **TemplateslackCustomFieldsV1** | | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatevariable.md b/sdk-output/notifications/docs/Models/Templatevariable.md new file mode 100644 index 00000000..1cd35a15 --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatevariable.md @@ -0,0 +1,22 @@ +--- +id: v1-templatevariable-v1 +title: TemplatevariableV1 +pagination_label: TemplatevariableV1 +sidebar_label: TemplatevariableV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatevariableV1', 'v1TemplatevariableV1'] +slug: /tools/sdk/typescript/notifications/models/templatevariable-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatevariableV1', 'v1TemplatevariableV1'] +--- + +# TemplatevariableV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The variable name as used when rendering context in templates. | [default to undefined] +**type** | **(optional)** **string** | The data type for this variable. Use JSON Schema-like names for values (string, boolean, number, object, array) or \"function\" for template utility/helper functions (e.g. __dateTool.format(), __esc.html()). | [default to undefined] +**description** | **(optional)** **string** | Human-readable description explaining what this variable represents. | [default to undefined] +**example** | **(optional)** **any** | Example value demonstrating the format and usage. For type \"function\", often a Velocity-style call (e.g. $__esc.html($value)). Can be a string, number, boolean, object, array, or null when no example is defined. | [default to undefined] + diff --git a/sdk-output/notifications/docs/Models/Templatevariablesdto.md b/sdk-output/notifications/docs/Models/Templatevariablesdto.md new file mode 100644 index 00000000..f2c5f88f --- /dev/null +++ b/sdk-output/notifications/docs/Models/Templatevariablesdto.md @@ -0,0 +1,22 @@ +--- +id: v1-templatevariablesdto-v1 +title: TemplatevariablesdtoV1 +pagination_label: TemplatevariablesdtoV1 +sidebar_label: TemplatevariablesdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TemplatevariablesdtoV1', 'v1TemplatevariablesdtoV1'] +slug: /tools/sdk/typescript/notifications/models/templatevariablesdto-v1 +tags: ['SDK', 'Software Development Kit', 'TemplatevariablesdtoV1', 'v1TemplatevariablesdtoV1'] +--- + +# TemplatevariablesdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The notification template key. | [default to undefined] +**medium** | **(optional)** **TemplatemediumdtoV1** | | [default to undefined] +**globalVariables** | **(optional)** **Array<TemplatevariableV1>** | Global variables available to all templates for this tenant (e.g. __global.*, __recipient, __util.*, __dateTool.*, __esc.*). Includes both data variables and function-type helpers. | [default to undefined] +**templateVariables** | **(optional)** **Array<TemplatevariableV1>** | Template-specific variables for the given key and medium (e.g. approverPath, requester, attributes). | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/oauth_clients/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..6a313bfc --- /dev/null +++ b/sdk-output/oauth_clients/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,76 @@ +- path: /oauth-clients/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/oauth_clients/methods/o-auth-clients#create-oauth-client-v1 + source: | + import { OAuthClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OAuthClientsV1Api(configuration); + const createoauthclientrequestV1: CreateoauthclientrequestV1 = ; // CreateoauthclientrequestV1 | + const result = await apiInstance.createOauthClientV1(createoauthclientrequestV1); + console.log(result); +- path: /oauth-clients/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/oauth_clients/methods/o-auth-clients#delete-oauth-client-v1 + source: | + import { OAuthClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OAuthClientsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The OAuth client id (default to undefined) + const result = await apiInstance.deleteOauthClientV1(id); + console.log(result); +- path: /oauth-clients/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/oauth_clients/methods/o-auth-clients#get-oauth-client-v1 + source: | + import { OAuthClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OAuthClientsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The OAuth client id (default to undefined) + const result = await apiInstance.getOauthClientV1(id); + console.log(result); +- path: /oauth-clients/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/oauth_clients/methods/o-auth-clients#list-oauth-clients-v1 + source: | + import { OAuthClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OAuthClientsV1Api(configuration); + const filters: string = 'lastUsed le 2023-02-05T10:59:27.214Z'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) (default to undefined) + const result = await apiInstance.listOauthClientsV1(); + console.log(result); +- path: /oauth-clients/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/oauth_clients/methods/o-auth-clients#patch-oauth-client-v1 + source: | + import { OAuthClientsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OAuthClientsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The OAuth client id (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/strongAuthSupported","value":true},{"op":"replace","path":"/businessName","value":"acme-solar"}]; // Array | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + const result = await apiInstance.patchOauthClientV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/oauth_clients/docs/Methods/Index.md b/sdk-output/oauth_clients/docs/Methods/Index.md new file mode 100644 index 00000000..3da31952 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: oauth_clients-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: oauth_clients-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'oauth_clients', 'methods'] +slug: /tools/sdk/typescript/oauth_clients/methods +tags: ['SDK', 'Software Development Kit', 'oauth_clients', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/oauth_clients/docs/Methods/OAuthClientsV1Api.md b/sdk-output/oauth_clients/docs/Methods/OAuthClientsV1Api.md new file mode 100644 index 00000000..735d66a7 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Methods/OAuthClientsV1Api.md @@ -0,0 +1,219 @@ +--- +id: v1-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OAuthClients', 'v1OAuthClients'] +slug: /tools/sdk/typescript/oauth_clients/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'v1OAuthClients'] +--- + +# OAuthClientsV1Api + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-oauth-client-v1**](#create-oauth-client-v1) | **POST** `/oauth-clients/v1` | Create oauth client +[**delete-oauth-client-v1**](#delete-oauth-client-v1) | **DELETE** `/oauth-clients/v1/{id}` | Delete oauth client +[**get-oauth-client-v1**](#get-oauth-client-v1) | **GET** `/oauth-clients/v1/{id}` | Get oauth client +[**list-oauth-clients-v1**](#list-oauth-clients-v1) | **GET** `/oauth-clients/v1` | List oauth clients +[**patch-oauth-client-v1**](#patch-oauth-client-v1) | **PATCH** `/oauth-clients/v1/{id}` | Patch oauth client + + +## create-oauth-client-v1 +Create oauth client +This creates an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-oauth-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createoauthclientrequestV1** | **CreateoauthclientrequestV1** | | + +### Return type + +**CreateoauthclientresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { OAuthClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OAuthClientsV1Api(configuration); +const createoauthclientrequestV1: CreateoauthclientrequestV1 = ; // +const result = await apiInstance.createOauthClientV1(createoauthclientrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-oauth-client-v1 +Delete oauth client +This deletes an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-oauth-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The OAuth client id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { OAuthClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OAuthClientsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The OAuth client id +const result = await apiInstance.deleteOauthClientV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-oauth-client-v1 +Get oauth client +This gets details of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-oauth-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The OAuth client id | [default to undefined] + +### Return type + +**GetoauthclientresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { OAuthClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OAuthClientsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The OAuth client id +const result = await apiInstance.getOauthClientV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-oauth-clients-v1 +List oauth clients +This gets a list of OAuth clients. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-oauth-clients-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { OAuthClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OAuthClientsV1Api(configuration); +const filters: string = lastUsed le 2023-02-05T10:59:27.214Z; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) +const result = await apiInstance.listOauthClientsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-oauth-client-v1 +Patch oauth client +This performs a targeted update to the field(s) of an OAuth client. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-oauth-client-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The OAuth client id | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported | + +### Return type + +**GetoauthclientresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { OAuthClientsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OAuthClientsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The OAuth client id +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/strongAuthSupported","value":true},{"op":"replace","path":"/businessName","value":"acme-solar"}]; // A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported +const result = await apiInstance.patchOauthClientV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/oauth_clients/docs/Models/Accesstype.md b/sdk-output/oauth_clients/docs/Models/Accesstype.md new file mode 100644 index 00000000..3803184b --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Accesstype.md @@ -0,0 +1,21 @@ +--- +id: v1-accesstype-v1 +title: AccesstypeV1 +pagination_label: AccesstypeV1 +sidebar_label: AccesstypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesstypeV1', 'v1AccesstypeV1'] +slug: /tools/sdk/typescript/oauth_clients/models/accesstype-v1 +tags: ['SDK', 'Software Development Kit', 'AccesstypeV1', 'v1AccesstypeV1'] +--- + +# AccesstypeV1 + +## Enum + + +* `Online` (value: `'ONLINE'`) + +* `Offline` (value: `'OFFLINE'`) + + diff --git a/sdk-output/oauth_clients/docs/Models/ArrayInner.md b/sdk-output/oauth_clients/docs/Models/ArrayInner.md new file mode 100644 index 00000000..8a9864ba --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/oauth_clients/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/oauth_clients/docs/Models/Clienttype.md b/sdk-output/oauth_clients/docs/Models/Clienttype.md new file mode 100644 index 00000000..1d812897 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Clienttype.md @@ -0,0 +1,21 @@ +--- +id: v1-clienttype-v1 +title: ClienttypeV1 +pagination_label: ClienttypeV1 +sidebar_label: ClienttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ClienttypeV1', 'v1ClienttypeV1'] +slug: /tools/sdk/typescript/oauth_clients/models/clienttype-v1 +tags: ['SDK', 'Software Development Kit', 'ClienttypeV1', 'v1ClienttypeV1'] +--- + +# ClienttypeV1 + +## Enum + + +* `Confidential` (value: `'CONFIDENTIAL'`) + +* `Public` (value: `'PUBLIC'`) + + diff --git a/sdk-output/oauth_clients/docs/Models/Createoauthclientrequest.md b/sdk-output/oauth_clients/docs/Models/Createoauthclientrequest.md new file mode 100644 index 00000000..a4a6cc36 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Createoauthclientrequest.md @@ -0,0 +1,33 @@ +--- +id: v1-createoauthclientrequest-v1 +title: CreateoauthclientrequestV1 +pagination_label: CreateoauthclientrequestV1 +sidebar_label: CreateoauthclientrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateoauthclientrequestV1', 'v1CreateoauthclientrequestV1'] +slug: /tools/sdk/typescript/oauth_clients/models/createoauthclientrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateoauthclientrequestV1', 'v1CreateoauthclientrequestV1'] +--- + +# CreateoauthclientrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**businessName** | **(optional)** **string** | The name of the business the API Client should belong to | [default to undefined] +**homepageUrl** | **(optional)** **string** | The homepage URL associated with the owner of the API Client | [default to undefined] +**name** | **string** | A human-readable name for the API Client | [default to undefined] +**description** | **string** | A description of the API Client | [default to undefined] +**accessTokenValiditySeconds** | **number** | The number of seconds an access token generated for this API Client is valid for | [default to undefined] +**refreshTokenValiditySeconds** | **(optional)** **number** | The number of seconds a refresh token generated for this API Client is valid for | [default to undefined] +**redirectUris** | **(optional)** **Array<string>** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [default to undefined] +**grantTypes** | **Array<GranttypeV1>** | A list of OAuth 2.0 grant types this API Client can be used with | [default to undefined] +**accessType** | **AccesstypeV1** | | [default to undefined] +**type** | **(optional)** **ClienttypeV1** | | [default to undefined] +**internal** | **(optional)** **boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [default to undefined] +**enabled** | **boolean** | An indicator of whether the API Client is enabled for use | [default to undefined] +**strongAuthSupported** | **(optional)** **boolean** | An indicator of whether the API Client supports strong authentication | [default to undefined] +**claimsSupported** | **(optional)** **boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [default to undefined] +**scope** | **(optional)** **Array<string>** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope \"sp:scopes:all\". This means the API Client will have all the rights of the owner who created it. | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Createoauthclientresponse.md b/sdk-output/oauth_clients/docs/Models/Createoauthclientresponse.md new file mode 100644 index 00000000..1809037d --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Createoauthclientresponse.md @@ -0,0 +1,37 @@ +--- +id: v1-createoauthclientresponse-v1 +title: CreateoauthclientresponseV1 +pagination_label: CreateoauthclientresponseV1 +sidebar_label: CreateoauthclientresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateoauthclientresponseV1', 'v1CreateoauthclientresponseV1'] +slug: /tools/sdk/typescript/oauth_clients/models/createoauthclientresponse-v1 +tags: ['SDK', 'Software Development Kit', 'CreateoauthclientresponseV1', 'v1CreateoauthclientresponseV1'] +--- + +# CreateoauthclientresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the OAuth client | [default to undefined] +**secret** | **string** | Secret of the OAuth client (This field is only returned on the intial create call.) | [default to undefined] +**businessName** | **string** | The name of the business the API Client should belong to | [default to undefined] +**homepageUrl** | **string** | The homepage URL associated with the owner of the API Client | [default to undefined] +**name** | **string** | A human-readable name for the API Client | [default to undefined] +**description** | **string** | A description of the API Client | [default to undefined] +**accessTokenValiditySeconds** | **number** | The number of seconds an access token generated for this API Client is valid for | [default to undefined] +**refreshTokenValiditySeconds** | **number** | The number of seconds a refresh token generated for this API Client is valid for | [default to undefined] +**redirectUris** | **Array<string>** | A list of the approved redirect URIs used with the authorization_code flow | [default to undefined] +**grantTypes** | **Array<GranttypeV1>** | A list of OAuth 2.0 grant types this API Client can be used with | [default to undefined] +**accessType** | **AccesstypeV1** | | [default to undefined] +**type** | **ClienttypeV1** | | [default to undefined] +**internal** | **boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [default to undefined] +**enabled** | **boolean** | An indicator of whether the API Client is enabled for use | [default to undefined] +**strongAuthSupported** | **boolean** | An indicator of whether the API Client supports strong authentication | [default to undefined] +**claimsSupported** | **boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [default to undefined] +**created** | **string** | The date and time, down to the millisecond, when the API Client was created | [default to undefined] +**modified** | **string** | The date and time, down to the millisecond, when the API Client was last updated | [default to undefined] +**scope** | **Array<string>** | Scopes of the API Client. | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Errormessagedto.md b/sdk-output/oauth_clients/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..047b2afc --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/oauth_clients/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Errorresponsedto.md b/sdk-output/oauth_clients/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..80309d9d --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/oauth_clients/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Getoauthclientresponse.md b/sdk-output/oauth_clients/docs/Models/Getoauthclientresponse.md new file mode 100644 index 00000000..4d5a52e1 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Getoauthclientresponse.md @@ -0,0 +1,39 @@ +--- +id: v1-getoauthclientresponse-v1 +title: GetoauthclientresponseV1 +pagination_label: GetoauthclientresponseV1 +sidebar_label: GetoauthclientresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetoauthclientresponseV1', 'v1GetoauthclientresponseV1'] +slug: /tools/sdk/typescript/oauth_clients/models/getoauthclientresponse-v1 +tags: ['SDK', 'Software Development Kit', 'GetoauthclientresponseV1', 'v1GetoauthclientresponseV1'] +--- + +# GetoauthclientresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the OAuth client | [default to undefined] +**businessName** | **string** | The name of the business the API Client should belong to | [default to undefined] +**homepageUrl** | **string** | The homepage URL associated with the owner of the API Client | [default to undefined] +**name** | **string** | A human-readable name for the API Client | [default to undefined] +**description** | **string** | A description of the API Client | [default to undefined] +**accessTokenValiditySeconds** | **number** | The number of seconds an access token generated for this API Client is valid for | [default to undefined] +**refreshTokenValiditySeconds** | **number** | The number of seconds a refresh token generated for this API Client is valid for | [default to undefined] +**redirectUris** | **Array<string>** | A list of the approved redirect URIs used with the authorization_code flow | [default to undefined] +**grantTypes** | **Array<GranttypeV1>** | A list of OAuth 2.0 grant types this API Client can be used with | [default to undefined] +**accessType** | **AccesstypeV1** | | [default to undefined] +**type** | **ClienttypeV1** | | [default to undefined] +**internal** | **boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [default to undefined] +**enabled** | **boolean** | An indicator of whether the API Client is enabled for use | [default to undefined] +**strongAuthSupported** | **boolean** | An indicator of whether the API Client supports strong authentication | [default to undefined] +**claimsSupported** | **boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [default to undefined] +**created** | **string** | The date and time, down to the millisecond, when the API Client was created | [default to undefined] +**modified** | **string** | The date and time, down to the millisecond, when the API Client was last updated | [default to undefined] +**secret** | **(optional)** **string** | | [default to undefined] +**metadata** | **(optional)** **string** | | [default to undefined] +**lastUsed** | **(optional)** **string** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [default to undefined] +**scope** | **Array<string>** | Scopes of the API Client. | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Granttype.md b/sdk-output/oauth_clients/docs/Models/Granttype.md new file mode 100644 index 00000000..cae61ff2 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Granttype.md @@ -0,0 +1,23 @@ +--- +id: v1-granttype-v1 +title: GranttypeV1 +pagination_label: GranttypeV1 +sidebar_label: GranttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GranttypeV1', 'v1GranttypeV1'] +slug: /tools/sdk/typescript/oauth_clients/models/granttype-v1 +tags: ['SDK', 'Software Development Kit', 'GranttypeV1', 'v1GranttypeV1'] +--- + +# GranttypeV1 + +## Enum + + +* `ClientCredentials` (value: `'CLIENT_CREDENTIALS'`) + +* `AuthorizationCode` (value: `'AUTHORIZATION_CODE'`) + +* `RefreshToken` (value: `'REFRESH_TOKEN'`) + + diff --git a/sdk-output/oauth_clients/docs/Models/Index.md b/sdk-output/oauth_clients/docs/Models/Index.md new file mode 100644 index 00000000..b202e74b --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: oauth_clients-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: oauth_clients-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'oauth_clients', 'models'] +slug: /tools/sdk/typescript/oauth_clients/models +tags: ['SDK', 'Software Development Kit', 'oauth_clients', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/oauth_clients/docs/Models/Jsonpatchoperation.md b/sdk-output/oauth_clients/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..431f312c --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/oauth_clients/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/JsonpatchoperationValue.md b/sdk-output/oauth_clients/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..4882ddfc --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/oauth_clients/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1401Response.md b/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1401Response.md new file mode 100644 index 00000000..975c0070 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-oauth-clients-v1401-response-v1 +title: ListOauthClientsV1401ResponseV1 +pagination_label: ListOauthClientsV1401ResponseV1 +sidebar_label: ListOauthClientsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListOauthClientsV1401ResponseV1', 'v1ListOauthClientsV1401ResponseV1'] +slug: /tools/sdk/typescript/oauth_clients/models/list-oauth-clients-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListOauthClientsV1401ResponseV1', 'v1ListOauthClientsV1401ResponseV1'] +--- + +# ListOauthClientsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1429Response.md b/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1429Response.md new file mode 100644 index 00000000..90b3591d --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/ListOauthClientsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-oauth-clients-v1429-response-v1 +title: ListOauthClientsV1429ResponseV1 +pagination_label: ListOauthClientsV1429ResponseV1 +sidebar_label: ListOauthClientsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListOauthClientsV1429ResponseV1', 'v1ListOauthClientsV1429ResponseV1'] +slug: /tools/sdk/typescript/oauth_clients/models/list-oauth-clients-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListOauthClientsV1429ResponseV1', 'v1ListOauthClientsV1429ResponseV1'] +--- + +# ListOauthClientsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/oauth_clients/docs/Models/Localeorigin.md b/sdk-output/oauth_clients/docs/Models/Localeorigin.md new file mode 100644 index 00000000..6d521994 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/oauth_clients/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/oauth_clients/docs/Models/README.md b/sdk-output/oauth_clients/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/oauth_clients/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/org_config/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/org_config/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..2b4da535 --- /dev/null +++ b/sdk-output/org_config/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,47 @@ +- path: /org-config/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/org_config/methods/org-config#get-org-config-v1 + source: | + import { OrgConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OrgConfigV1Api(configuration); + const result = await apiInstance.getOrgConfigV1(); + console.log(result); +- path: /org-config/v1/valid-time-zones + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/org_config/methods/org-config#get-valid-time-zones-v1 + source: | + import { OrgConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OrgConfigV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getValidTimeZonesV1(); + console.log(result); +- path: /org-config/v1 + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/org_config/methods/org-config#patch-org-config-v1 + source: | + import { OrgConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new OrgConfigV1Api(configuration); + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/timeZone","value":"America/Toronto"}]; // Array | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.patchOrgConfigV1(jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/org_config/docs/Methods/Index.md b/sdk-output/org_config/docs/Methods/Index.md new file mode 100644 index 00000000..b5dc0b81 --- /dev/null +++ b/sdk-output/org_config/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: org_config-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: org_config-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'org_config', 'methods'] +slug: /tools/sdk/typescript/org_config/methods +tags: ['SDK', 'Software Development Kit', 'org_config', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/org_config/docs/Methods/OrgConfigV1Api.md b/sdk-output/org_config/docs/Methods/OrgConfigV1Api.md new file mode 100644 index 00000000..3a34407d --- /dev/null +++ b/sdk-output/org_config/docs/Methods/OrgConfigV1Api.md @@ -0,0 +1,143 @@ +--- +id: v1-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OrgConfig', 'v1OrgConfig'] +slug: /tools/sdk/typescript/org_config/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'v1OrgConfig'] +--- + +# OrgConfigV1Api + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-org-config-v1**](#get-org-config-v1) | **GET** `/org-config/v1` | Get org config settings +[**get-valid-time-zones-v1**](#get-valid-time-zones-v1) | **GET** `/org-config/v1/valid-time-zones` | Get valid time zones +[**patch-org-config-v1**](#patch-org-config-v1) | **PATCH** `/org-config/v1` | Patch org config + + +## get-org-config-v1 +Get org config settings +Get the current organization's configuration settings, only external accessible properties. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-org-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**OrgconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { OrgConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OrgConfigV1Api(configuration); +const result = await apiInstance.getOrgConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-valid-time-zones-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get valid time zones +List the valid time zones that can be set in organization configurations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-valid-time-zones-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { OrgConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OrgConfigV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getValidTimeZonesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-org-config-v1 +Patch org config +Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-org-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**OrgconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { OrgConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new OrgConfigV1Api(configuration); +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/timeZone","value":"America/Toronto"}]; // A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.patchOrgConfigV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/org_config/docs/Models/ArrayInner.md b/sdk-output/org_config/docs/Models/ArrayInner.md new file mode 100644 index 00000000..9fe9270b --- /dev/null +++ b/sdk-output/org_config/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/org_config/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/org_config/docs/Models/Errormessagedto.md b/sdk-output/org_config/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..64a4940e --- /dev/null +++ b/sdk-output/org_config/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/org_config/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/Errorresponsedto.md b/sdk-output/org_config/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..16de971d --- /dev/null +++ b/sdk-output/org_config/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/org_config/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/GetOrgConfigV1401Response.md b/sdk-output/org_config/docs/Models/GetOrgConfigV1401Response.md new file mode 100644 index 00000000..40fce977 --- /dev/null +++ b/sdk-output/org_config/docs/Models/GetOrgConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-org-config-v1401-response-v1 +title: GetOrgConfigV1401ResponseV1 +pagination_label: GetOrgConfigV1401ResponseV1 +sidebar_label: GetOrgConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetOrgConfigV1401ResponseV1', 'v1GetOrgConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/org_config/models/get-org-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetOrgConfigV1401ResponseV1', 'v1GetOrgConfigV1401ResponseV1'] +--- + +# GetOrgConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/GetOrgConfigV1429Response.md b/sdk-output/org_config/docs/Models/GetOrgConfigV1429Response.md new file mode 100644 index 00000000..2928decb --- /dev/null +++ b/sdk-output/org_config/docs/Models/GetOrgConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-org-config-v1429-response-v1 +title: GetOrgConfigV1429ResponseV1 +pagination_label: GetOrgConfigV1429ResponseV1 +sidebar_label: GetOrgConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetOrgConfigV1429ResponseV1', 'v1GetOrgConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/org_config/models/get-org-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetOrgConfigV1429ResponseV1', 'v1GetOrgConfigV1429ResponseV1'] +--- + +# GetOrgConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/Index.md b/sdk-output/org_config/docs/Models/Index.md new file mode 100644 index 00000000..35a92e3e --- /dev/null +++ b/sdk-output/org_config/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: org_config-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: org_config-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'org_config', 'models'] +slug: /tools/sdk/typescript/org_config/models +tags: ['SDK', 'Software Development Kit', 'org_config', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/org_config/docs/Models/Jsonpatchoperation.md b/sdk-output/org_config/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..cc8fd078 --- /dev/null +++ b/sdk-output/org_config/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/org_config/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/JsonpatchoperationValue.md b/sdk-output/org_config/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..86b847b6 --- /dev/null +++ b/sdk-output/org_config/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/org_config/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/org_config/docs/Models/Localeorigin.md b/sdk-output/org_config/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a929c820 --- /dev/null +++ b/sdk-output/org_config/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/org_config/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/org_config/docs/Models/Orgconfig.md b/sdk-output/org_config/docs/Models/Orgconfig.md new file mode 100644 index 00000000..e3181413 --- /dev/null +++ b/sdk-output/org_config/docs/Models/Orgconfig.md @@ -0,0 +1,28 @@ +--- +id: v1-orgconfig-v1 +title: OrgconfigV1 +pagination_label: OrgconfigV1 +sidebar_label: OrgconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OrgconfigV1', 'v1OrgconfigV1'] +slug: /tools/sdk/typescript/org_config/models/orgconfig-v1 +tags: ['SDK', 'Software Development Kit', 'OrgconfigV1', 'v1OrgconfigV1'] +--- + +# OrgconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**orgName** | **(optional)** **string** | The name of the org. | [default to undefined] +**timeZone** | **(optional)** **string** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [default to undefined] +**lcsChangeHonorsSourceEnableFeature** | **(optional)** **boolean** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [default to undefined] +**armCustomerId** | **(optional)** **string** | ARM Customer ID | [default to undefined] +**armSapSystemIdMappings** | **(optional)** **string** | A list of IDN::sourceId to ARM::systemId mappings. | [default to undefined] +**armAuth** | **(optional)** **string** | ARM authentication string | [default to undefined] +**armDb** | **(optional)** **string** | ARM database name | [default to undefined] +**armSsoUrl** | **(optional)** **string** | ARM SSO URL | [default to undefined] +**iaiEnableCertificationRecommendations** | **(optional)** **boolean** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [default to undefined] +**sodReportConfigs** | **(optional)** **Array<ReportconfigdtoV1>** | | [default to undefined] + diff --git a/sdk-output/org_config/docs/Models/README.md b/sdk-output/org_config/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/org_config/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/org_config/docs/Models/Reportconfigdto.md b/sdk-output/org_config/docs/Models/Reportconfigdto.md new file mode 100644 index 00000000..d5e7a87a --- /dev/null +++ b/sdk-output/org_config/docs/Models/Reportconfigdto.md @@ -0,0 +1,22 @@ +--- +id: v1-reportconfigdto-v1 +title: ReportconfigdtoV1 +pagination_label: ReportconfigdtoV1 +sidebar_label: ReportconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportconfigdtoV1', 'v1ReportconfigdtoV1'] +slug: /tools/sdk/typescript/org_config/models/reportconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'ReportconfigdtoV1', 'v1ReportconfigdtoV1'] +--- + +# ReportconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**columnName** | **(optional)** **string** | Name of column in report | [default to undefined] +**required** | **(optional)** **boolean** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column\'s definition. | [default to false] +**included** | **(optional)** **boolean** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [default to false] +**order** | **(optional)** **number** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/parameter_storage/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..4d9d6453 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,127 @@ +- path: /parameter-storage/v1/parameters + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#create-parameter-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const parameterstoragenewparameterV1: ParameterstoragenewparameterV1 = ; // ParameterstoragenewparameterV1 | The parameter to add to the store. (optional) + const result = await apiInstance.createParameterV1(); + console.log(result); +- path: /parameter-storage/v1/parameters/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#delete-parameter-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const id: string = '58de858b-83d9-4563-9e15-7393594c684a'; // string | The ID of the parameter to be deleted. (default to undefined) + const result = await apiInstance.deleteParameterV1(id); + console.log(result); +- path: /parameter-storage/v1/attestation + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#get-attestation-document-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const key: string = 'BLdV-KA7nSRXx2XkksQX7bmOAShARsB3CCVWodKr4dOJj_puru76wy6drBTVlSytW_rDheLwepm9xdrRuqUI7p81wMP576frFBbsjndBKyRm3eouPbDcW8MAz0XRH1BB3w=='; // string | Base64Url encoded NIST P-384 public key (default to undefined) + const result = await apiInstance.getAttestationDocumentV1(key); + console.log(result); +- path: /parameter-storage/v1/parameters/{id}/references + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#get-parameter-references-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const id: string = '58de858b-83d9-4563-9e15-7393594c684a'; // string | The ID of the parameter which you want to fetch the references for. (default to undefined) + const sorters: string = 'consumerId,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.getParameterReferencesV1(id); + console.log(result); +- path: /parameter-storage/v1/specification + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#get-parameter-storage-specification-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const acceptLanguage: string = 'en'; // string | The i18n internationalization code for the language that the spec is in. Defaults to english. (optional) (default to 'en') + const result = await apiInstance.getParameterStorageSpecificationV1(); + console.log(result); +- path: /parameter-storage/v1/parameters/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#get-parameter-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const id: string = '58de858b-83d9-4563-9e15-7393594c684a'; // string | The ID of the parameter to be fetched (default to undefined) + const result = await apiInstance.getParameterV1(id); + console.log(result); +- path: /parameter-storage/v1/parameters + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#search-parameters-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const filters: string = 'id eq 550e8400-e29b-41d4-a716-446655440000'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* (optional) (default to undefined) + const sorters: string = 'type,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** (optional) (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.searchParametersV1(); + console.log(result); +- path: /parameter-storage/v1/parameters/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/parameter_storage/methods/parameter-storage#update-parameter-v1 + source: | + import { ParameterStorageV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ParameterStorageV1Api(configuration); + const id: string = '58de858b-83d9-4563-9e15-7393594c684a'; // string | The ID of the parameter to be updated. (default to undefined) + const parameterstorageupdateparameterV1: ParameterstorageupdateparameterV1 = ; // ParameterstorageupdateparameterV1 | The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. (optional) + const result = await apiInstance.updateParameterV1(id); + console.log(result); diff --git a/sdk-output/parameter_storage/docs/Methods/Index.md b/sdk-output/parameter_storage/docs/Methods/Index.md new file mode 100644 index 00000000..a15da554 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: parameter_storage-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: parameter_storage-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'parameter_storage', 'methods'] +slug: /tools/sdk/typescript/parameter_storage/methods +tags: ['SDK', 'Software Development Kit', 'parameter_storage', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/parameter_storage/docs/Methods/ParameterStorageV1Api.md b/sdk-output/parameter_storage/docs/Methods/ParameterStorageV1Api.md new file mode 100644 index 00000000..26b7ba9e --- /dev/null +++ b/sdk-output/parameter_storage/docs/Methods/ParameterStorageV1Api.md @@ -0,0 +1,365 @@ +--- +id: v1-parameter-storage +title: ParameterStorage +pagination_label: ParameterStorage +sidebar_label: ParameterStorage +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterStorage', 'v1ParameterStorage'] +slug: /tools/sdk/typescript/parameter_storage/methods/parameter-storage +tags: ['SDK', 'Software Development Kit', 'ParameterStorage', 'v1ParameterStorage'] +--- + +# ParameterStorageV1Api + The Parameter Storage is SailPoint's centralized repository for authentication, authorization, and connection configurations, stored as typed Parameters. + +The APIs can be used to input Parameters, which can then be referenced by other services, such as Workflow configurations. When these services are executed, the relevant values are fetched via an internal API (not documented here). + +The usage of Parameters can be monitored via References managed by Parameter Storage. References provide an indirect mapping between a Parameter and its usage (e.g., within a Workflow), allowing for reports such as "Parameter X is used in Workflow Y" via APIs. + +A Parameter is a named instance of typed configuration, where the state is stored as Fields. These Fields are either Public (cleartext, searchable) or Private (encrypted). + +Parameter Types are grouped and fall into three Categories: Authentication, Authorization, and Connection. + +Parameters are strongly typed; each Type's fields are named and exposed to the consumer. This means that if a service states that it expects a Credential Type, it will receive a Parameter with a Username and Password. + +Fields are named, typed variables within a Parameter; the Fields on a Parameter depend on the Parameter's Type. Fields contain customer-provided data that will be referenced by another service, and their typing determines whether they're stored in cleartext or encrypted. + +The Specification documents the supported Categories, Types, Fields, Field Names, and their relationships. + +A Reference is an indirect pointer to a Parameter, where each usage of a Parameter has a corresponding Reference. This allows for usage tracking and safe deletion. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-parameter-v1**](#create-parameter-v1) | **POST** `/parameter-storage/v1/parameters` | Add a new parameter. +[**delete-parameter-v1**](#delete-parameter-v1) | **DELETE** `/parameter-storage/v1/parameters/{id}` | Delete a parameter. +[**get-attestation-document-v1**](#get-attestation-document-v1) | **GET** `/parameter-storage/v1/attestation` | Get an attestation document. +[**get-parameter-references-v1**](#get-parameter-references-v1) | **GET** `/parameter-storage/v1/parameters/{id}/references` | Get parameter references. +[**get-parameter-storage-specification-v1**](#get-parameter-storage-specification-v1) | **GET** `/parameter-storage/v1/specification` | Get specifications for parameter types. +[**get-parameter-v1**](#get-parameter-v1) | **GET** `/parameter-storage/v1/parameters/{id}` | Get a specific parameter. +[**search-parameters-v1**](#search-parameters-v1) | **GET** `/parameter-storage/v1/parameters` | Query stored parameters. +[**update-parameter-v1**](#update-parameter-v1) | **PATCH** `/parameter-storage/v1/parameters/{id}` | Update a parameter. + + +## create-parameter-v1 +Add a new parameter. +Add a new parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-parameter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**parameterstoragenewparameterV1** | **ParameterstoragenewparameterV1** | The parameter to add to the store. | [optional] + +### Return type + +**ParameterstorageparameterV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const parameterstoragenewparameterV1: ParameterstoragenewparameterV1 = ; // The parameter to add to the store. (optional) +const result = await apiInstance.createParameterV1(); +console.log(result); +``` + +[[Back to top]](#) + +## delete-parameter-v1 +Delete a parameter. +Delete a parameter. Will only delete parameters without existing references. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-parameter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the parameter to be deleted. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const id: string = 58de858b-83d9-4563-9e15-7393594c684a; // The ID of the parameter to be deleted. +const result = await apiInstance.deleteParameterV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-attestation-document-v1 +Get an attestation document. +Get an attestation document containing a NIST P-384 service public key for an ECDHE handshake, enabling the end-to-end-encrypted transport of parameter private fields. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-attestation-document-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**key** | **string** | Base64Url encoded NIST P-384 public key | [default to undefined] + +### Return type + +**ParameterstorageattestationdocumentV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const key: string = BLdV-KA7nSRXx2XkksQX7bmOAShARsB3CCVWodKr4dOJj_puru76wy6drBTVlSytW_rDheLwepm9xdrRuqUI7p81wMP576frFBbsjndBKyRm3eouPbDcW8MAz0XRH1BB3w==; // Base64Url encoded NIST P-384 public key +const result = await apiInstance.getAttestationDocumentV1(key); +console.log(result); +``` + +[[Back to top]](#) + +## get-parameter-references-v1 +Get parameter references. +Get the references for a given parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-parameter-references-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the parameter which you want to fetch the references for. | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const id: string = 58de858b-83d9-4563-9e15-7393594c684a; // The ID of the parameter which you want to fetch the references for. +const sorters: string = consumerId,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, consumerId, parameterId, name, usageHint** (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getParameterReferencesV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-parameter-storage-specification-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get specifications for parameter types. +Get the specifications for all parameter types. All parameters must conform to this specification document. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-parameter-storage-specification-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**acceptLanguage** | **string** | The i18n internationalization code for the language that the spec is in. Defaults to english. | [optional] [default to 'en'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const acceptLanguage: string = en; // The i18n internationalization code for the language that the spec is in. Defaults to english. (optional) +const result = await apiInstance.getParameterStorageSpecificationV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-parameter-v1 +Get a specific parameter. +Get a parameter by ID. This will only return the public fields for the parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-parameter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the parameter to be fetched | [default to undefined] + +### Return type + +**ParameterstorageparameterV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const id: string = 58de858b-83d9-4563-9e15-7393594c684a; // The ID of the parameter to be fetched +const result = await apiInstance.getParameterV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## search-parameters-v1 +Query stored parameters. +Query a stored parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-parameters-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** | [optional] [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const filters: string = id eq 550e8400-e29b-41d4-a716-446655440000; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, in, co* **description**: *co* **ownerId**: *eq* **type**: *eq, sw* (optional) +const sorters: string = type,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, ownerId, type, description, lastModifiedAt, lastModifiedBy, privateFieldsLastModifiedAt, privateFieldsLastModifiedAt** (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.searchParametersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-parameter-v1 +Update a parameter. +Update a parameter. You cannot change a parameter's type once set. Only the name, owner, description, public fields, and private fields can be updated. Private field updates are made via JWE AES256 encrypted blobs. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-parameter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the parameter to be updated. | [default to undefined] +**parameterstorageupdateparameterV1** | **ParameterstorageupdateparameterV1** | The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. | [optional] + +### Return type + +**ParameterstorageparameterV1** + +### HTTP request headers + +- **Content-Type**: application/json, application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ParameterStorageV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ParameterStorageV1Api(configuration); +const id: string = 58de858b-83d9-4563-9e15-7393594c684a; // The ID of the parameter to be updated. +const parameterstorageupdateparameterV1: ParameterstorageupdateparameterV1 = ; // The updated parameter. Supports both full and RFC 6902 JSON Patch updates. For RFC 6902 JSON Patch updates, move and copy operations are not supported for privateField updates. (optional) +const result = await apiInstance.updateParameterV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/parameter_storage/docs/Models/DeleteParameterV1409Response.md b/sdk-output/parameter_storage/docs/Models/DeleteParameterV1409Response.md new file mode 100644 index 00000000..f333f0df --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/DeleteParameterV1409Response.md @@ -0,0 +1,21 @@ +--- +id: v1-delete-parameter-v1409-response-v1 +title: DeleteParameterV1409ResponseV1 +pagination_label: DeleteParameterV1409ResponseV1 +sidebar_label: DeleteParameterV1409ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeleteParameterV1409ResponseV1', 'v1DeleteParameterV1409ResponseV1'] +slug: /tools/sdk/typescript/parameter_storage/models/delete-parameter-v1409-response-v1 +tags: ['SDK', 'Software Development Kit', 'DeleteParameterV1409ResponseV1', 'v1DeleteParameterV1409ResponseV1'] +--- + +# DeleteParameterV1409ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errorName** | **(optional)** **any** | A message describing the error | [default to undefined] +**errorMessage** | **(optional)** **any** | Description of the error | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Errormessagedto.md b/sdk-output/parameter_storage/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..f8ae88be --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/parameter_storage/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Errorresponsedto.md b/sdk-output/parameter_storage/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..5f953b18 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/parameter_storage/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1401Response.md b/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1401Response.md new file mode 100644 index 00000000..0c8a3514 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-attestation-document-v1401-response-v1 +title: GetAttestationDocumentV1401ResponseV1 +pagination_label: GetAttestationDocumentV1401ResponseV1 +sidebar_label: GetAttestationDocumentV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAttestationDocumentV1401ResponseV1', 'v1GetAttestationDocumentV1401ResponseV1'] +slug: /tools/sdk/typescript/parameter_storage/models/get-attestation-document-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAttestationDocumentV1401ResponseV1', 'v1GetAttestationDocumentV1401ResponseV1'] +--- + +# GetAttestationDocumentV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1429Response.md b/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1429Response.md new file mode 100644 index 00000000..c2d2e393 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/GetAttestationDocumentV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-attestation-document-v1429-response-v1 +title: GetAttestationDocumentV1429ResponseV1 +pagination_label: GetAttestationDocumentV1429ResponseV1 +sidebar_label: GetAttestationDocumentV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAttestationDocumentV1429ResponseV1', 'v1GetAttestationDocumentV1429ResponseV1'] +slug: /tools/sdk/typescript/parameter_storage/models/get-attestation-document-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAttestationDocumentV1429ResponseV1', 'v1GetAttestationDocumentV1429ResponseV1'] +--- + +# GetAttestationDocumentV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Index.md b/sdk-output/parameter_storage/docs/Models/Index.md new file mode 100644 index 00000000..bdeb83e3 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: parameter_storage-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: parameter_storage-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'parameter_storage', 'models'] +slug: /tools/sdk/typescript/parameter_storage/models +tags: ['SDK', 'Software Development Kit', 'parameter_storage', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/parameter_storage/docs/Models/Localeorigin.md b/sdk-output/parameter_storage/docs/Models/Localeorigin.md new file mode 100644 index 00000000..6c61a819 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/parameter_storage/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstorageattestationdocument.md b/sdk-output/parameter_storage/docs/Models/Parameterstorageattestationdocument.md new file mode 100644 index 00000000..090b2915 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstorageattestationdocument.md @@ -0,0 +1,19 @@ +--- +id: v1-parameterstorageattestationdocument-v1 +title: ParameterstorageattestationdocumentV1 +pagination_label: ParameterstorageattestationdocumentV1 +sidebar_label: ParameterstorageattestationdocumentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstorageattestationdocumentV1', 'v1ParameterstorageattestationdocumentV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstorageattestationdocument-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstorageattestationdocumentV1', 'v1ParameterstorageattestationdocumentV1'] +--- + +# ParameterstorageattestationdocumentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attestationDocument** | **(optional)** **string** | The Base64Url encoded attestation document. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstoragejsonpatch.md b/sdk-output/parameter_storage/docs/Models/Parameterstoragejsonpatch.md new file mode 100644 index 00000000..26bc72a4 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstoragejsonpatch.md @@ -0,0 +1,22 @@ +--- +id: v1-parameterstoragejsonpatch-v1 +title: ParameterstoragejsonpatchV1 +pagination_label: ParameterstoragejsonpatchV1 +sidebar_label: ParameterstoragejsonpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstoragejsonpatchV1', 'v1ParameterstoragejsonpatchV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstoragejsonpatch-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstoragejsonpatchV1', 'v1ParameterstoragejsonpatchV1'] +--- + +# ParameterstoragejsonpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to perform (add, remove, replace, move, copy, test) | [default to undefined] +**path** | **string** | A JSON-Pointer describing the target location | [default to undefined] +**value** | **(optional)** **any** | The value to be used within the operations. Required for add/replace/test. | [default to undefined] +**from** | **(optional)** **string** | A JSON-Pointer describing the source location for move/copy. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstoragenewparameter.md b/sdk-output/parameter_storage/docs/Models/Parameterstoragenewparameter.md new file mode 100644 index 00000000..6da97a0c --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstoragenewparameter.md @@ -0,0 +1,24 @@ +--- +id: v1-parameterstoragenewparameter-v1 +title: ParameterstoragenewparameterV1 +pagination_label: ParameterstoragenewparameterV1 +sidebar_label: ParameterstoragenewparameterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstoragenewparameterV1', 'v1ParameterstoragenewparameterV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstoragenewparameter-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstoragenewparameterV1', 'v1ParameterstoragenewparameterV1'] +--- + +# ParameterstoragenewparameterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ownerId** | **string** | The UUID of the parameter owner. | [default to undefined] +**name** | **string** | The human-readable name for the parameter. | [default to undefined] +**type** | **string** | The type of the parameter. This cannot be changed after being set. Please see the types document for more information. | [default to undefined] +**publicFields** | **(optional)** **object** | The content must be a JSON object containing the public fields that can be stored with this parameter. | [default to undefined] +**privateFields** | **(optional)** **string** | Must be a JWE AES256 encrypted blob. The content of the blob must be a JSON object containing the private fields that can be stored with this parameter. | [default to undefined] +**description** | **(optional)** **string** | Describe the parameter | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstorageparameter.md b/sdk-output/parameter_storage/docs/Models/Parameterstorageparameter.md new file mode 100644 index 00000000..001c5c32 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstorageparameter.md @@ -0,0 +1,29 @@ +--- +id: v1-parameterstorageparameter-v1 +title: ParameterstorageparameterV1 +pagination_label: ParameterstorageparameterV1 +sidebar_label: ParameterstorageparameterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstorageparameterV1', 'v1ParameterstorageparameterV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstorageparameter-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstorageparameterV1', 'v1ParameterstorageparameterV1'] +--- + +# ParameterstorageparameterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of the reference | [default to undefined] +**ownerId** | **string** | The ID of the user who owns the parameter. | [default to undefined] +**type** | **(optional)** **string** | The type of the parameter. This cannot be changed after being set. Please see the types document for more information. | [default to undefined] +**name** | **string** | The human-readable name of the parameter. | [default to undefined] +**primaryField** | **(optional)** **string** | The name of the primary field in the public fields. | [default to undefined] +**publicFields** | **object** | The public fields stored for this parameter. See the types document for information about what can be stored. | [default to undefined] +**description** | **(optional)** **string** | Describe the parameter | [default to undefined] +**lastModifiedAt** | **(optional)** **string** | ISO8606 format datetime of the last time any field of the parameter was changed. | [default to undefined] +**lastModifiedBy** | **(optional)** **string** | The ID of the user who last modified the parameter. Empty when identity is not known. | [default to undefined] +**privateFieldsLastModifiedAt** | **(optional)** **string** | ISO8606 format datetime of the time the secret fields were changed on the parameter. | [default to undefined] +**privateFieldsLastModifiedBy** | **(optional)** **string** | The ID of the user who last modified the private fields. Empty when identity is not known. | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstoragereference.md b/sdk-output/parameter_storage/docs/Models/Parameterstoragereference.md new file mode 100644 index 00000000..cac26f6d --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstoragereference.md @@ -0,0 +1,23 @@ +--- +id: v1-parameterstoragereference-v1 +title: ParameterstoragereferenceV1 +pagination_label: ParameterstoragereferenceV1 +sidebar_label: ParameterstoragereferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstoragereferenceV1', 'v1ParameterstoragereferenceV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstoragereference-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstoragereferenceV1', 'v1ParameterstoragereferenceV1'] +--- + +# ParameterstoragereferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of the reference | [default to undefined] +**consumerId** | **string** | The ID of the consumer holding the reference | [default to undefined] +**parameterId** | **string** | The ID of the parameter that the reference is pointing to. | [default to undefined] +**name** | **string** | The human-readable name of the reference | [default to undefined] +**usageHint** | **(optional)** **string** | The hint string used to validate the reference | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/Parameterstorageupdateparameter.md b/sdk-output/parameter_storage/docs/Models/Parameterstorageupdateparameter.md new file mode 100644 index 00000000..6061298c --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/Parameterstorageupdateparameter.md @@ -0,0 +1,23 @@ +--- +id: v1-parameterstorageupdateparameter-v1 +title: ParameterstorageupdateparameterV1 +pagination_label: ParameterstorageupdateparameterV1 +sidebar_label: ParameterstorageupdateparameterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ParameterstorageupdateparameterV1', 'v1ParameterstorageupdateparameterV1'] +slug: /tools/sdk/typescript/parameter_storage/models/parameterstorageupdateparameter-v1 +tags: ['SDK', 'Software Development Kit', 'ParameterstorageupdateparameterV1', 'v1ParameterstorageupdateparameterV1'] +--- + +# ParameterstorageupdateparameterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ownerId** | **(optional)** **string** | The UUID of the parameter owner. | [default to undefined] +**name** | **(optional)** **string** | The human-readable name for the parameter. | [default to undefined] +**publicFields** | **(optional)** **object** | The public fields that can be stored with this parameter. | [default to undefined] +**privateFields** | **(optional)** **string** | The private fields that can be stored with this parameter. | [default to undefined] +**description** | **(optional)** **string** | Describe the parameter | [default to undefined] + diff --git a/sdk-output/parameter_storage/docs/Models/README.md b/sdk-output/parameter_storage/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/parameter_storage/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_configuration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/password_configuration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e81496a6 --- /dev/null +++ b/sdk-output/password_configuration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,44 @@ +- path: /password-org-config/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_configuration/methods/password-configuration#create-password-org-config-v1 + source: | + import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordConfigurationV1Api(configuration); + const passwordorgconfigV1: PasswordorgconfigV1 = {"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":12,"digitTokenLength":9}; // PasswordorgconfigV1 | + const result = await apiInstance.createPasswordOrgConfigV1(passwordorgconfigV1); + console.log(result); +- path: /password-org-config/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_configuration/methods/password-configuration#get-password-org-config-v1 + source: | + import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordConfigurationV1Api(configuration); + const result = await apiInstance.getPasswordOrgConfigV1(); + console.log(result); +- path: /password-org-config/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_configuration/methods/password-configuration#put-password-org-config-v1 + source: | + import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordConfigurationV1Api(configuration); + const passwordorgconfigV1: PasswordorgconfigV1 = {"digitTokenEnabled":true,"digitTokenDurationMinutes":12}; // PasswordorgconfigV1 | + const result = await apiInstance.putPasswordOrgConfigV1(passwordorgconfigV1); + console.log(result); diff --git a/sdk-output/password_configuration/docs/Methods/Index.md b/sdk-output/password_configuration/docs/Methods/Index.md new file mode 100644 index 00000000..841bfcf9 --- /dev/null +++ b/sdk-output/password_configuration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: password_configuration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: password_configuration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'password_configuration', 'methods'] +slug: /tools/sdk/typescript/password_configuration/methods +tags: ['SDK', 'Software Development Kit', 'password_configuration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/password_configuration/docs/Methods/PasswordConfigurationV1Api.md b/sdk-output/password_configuration/docs/Methods/PasswordConfigurationV1Api.md new file mode 100644 index 00000000..449ecdf4 --- /dev/null +++ b/sdk-output/password_configuration/docs/Methods/PasswordConfigurationV1Api.md @@ -0,0 +1,142 @@ +--- +id: v1-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordConfiguration', 'v1PasswordConfiguration'] +slug: /tools/sdk/typescript/password_configuration/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'v1PasswordConfiguration'] +--- + +# PasswordConfigurationV1Api + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-org-config-v1**](#create-password-org-config-v1) | **POST** `/password-org-config/v1` | Create password org config +[**get-password-org-config-v1**](#get-password-org-config-v1) | **GET** `/password-org-config/v1` | Get password org config +[**put-password-org-config-v1**](#put-password-org-config-v1) | **PUT** `/password-org-config/v1` | Update password org config + + +## create-password-org-config-v1 +Create password org config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-password-org-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordorgconfigV1** | **PasswordorgconfigV1** | | + +### Return type + +**PasswordorgconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordConfigurationV1Api(configuration); +const passwordorgconfigV1: PasswordorgconfigV1 = {"customInstructionsEnabled":true,"digitTokenEnabled":true,"digitTokenDurationMinutes":12,"digitTokenLength":9}; // +const result = await apiInstance.createPasswordOrgConfigV1(passwordorgconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-password-org-config-v1 +Get password org config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-org-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**PasswordorgconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordConfigurationV1Api(configuration); +const result = await apiInstance.getPasswordOrgConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-password-org-config-v1 +Update password org config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-password-org-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordorgconfigV1** | **PasswordorgconfigV1** | | + +### Return type + +**PasswordorgconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordConfigurationV1Api(configuration); +const passwordorgconfigV1: PasswordorgconfigV1 = {"digitTokenEnabled":true,"digitTokenDurationMinutes":12}; // +const result = await apiInstance.putPasswordOrgConfigV1(passwordorgconfigV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/password_configuration/docs/Models/Errormessagedto.md b/sdk-output/password_configuration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..fa7b50b1 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/password_configuration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/password_configuration/docs/Models/Errorresponsedto.md b/sdk-output/password_configuration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..cdf4ab9d --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/password_configuration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1401Response.md b/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1401Response.md new file mode 100644 index 00000000..aa13e2d2 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-org-config-v1401-response-v1 +title: GetPasswordOrgConfigV1401ResponseV1 +pagination_label: GetPasswordOrgConfigV1401ResponseV1 +sidebar_label: GetPasswordOrgConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordOrgConfigV1401ResponseV1', 'v1GetPasswordOrgConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/password_configuration/models/get-password-org-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordOrgConfigV1401ResponseV1', 'v1GetPasswordOrgConfigV1401ResponseV1'] +--- + +# GetPasswordOrgConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1429Response.md b/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1429Response.md new file mode 100644 index 00000000..01687510 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/GetPasswordOrgConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-org-config-v1429-response-v1 +title: GetPasswordOrgConfigV1429ResponseV1 +pagination_label: GetPasswordOrgConfigV1429ResponseV1 +sidebar_label: GetPasswordOrgConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordOrgConfigV1429ResponseV1', 'v1GetPasswordOrgConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/password_configuration/models/get-password-org-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordOrgConfigV1429ResponseV1', 'v1GetPasswordOrgConfigV1429ResponseV1'] +--- + +# GetPasswordOrgConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_configuration/docs/Models/Index.md b/sdk-output/password_configuration/docs/Models/Index.md new file mode 100644 index 00000000..b34f3377 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: password_configuration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: password_configuration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'password_configuration', 'models'] +slug: /tools/sdk/typescript/password_configuration/models +tags: ['SDK', 'Software Development Kit', 'password_configuration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/password_configuration/docs/Models/Localeorigin.md b/sdk-output/password_configuration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a746ac15 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/password_configuration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/password_configuration/docs/Models/Passwordorgconfig.md b/sdk-output/password_configuration/docs/Models/Passwordorgconfig.md new file mode 100644 index 00000000..ef913466 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/Passwordorgconfig.md @@ -0,0 +1,22 @@ +--- +id: v1-passwordorgconfig-v1 +title: PasswordorgconfigV1 +pagination_label: PasswordorgconfigV1 +sidebar_label: PasswordorgconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordorgconfigV1', 'v1PasswordorgconfigV1'] +slug: /tools/sdk/typescript/password_configuration/models/passwordorgconfig-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordorgconfigV1', 'v1PasswordorgconfigV1'] +--- + +# PasswordorgconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customInstructionsEnabled** | **(optional)** **boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [default to false] +**digitTokenEnabled** | **(optional)** **boolean** | Indicator whether \"digit token\" feature is enabled. The default value is false. | [default to false] +**digitTokenDurationMinutes** | **(optional)** **number** | The duration of \"digit token\" in minutes. The default value is 5. | [default to 5] +**digitTokenLength** | **(optional)** **number** | The length of \"digit token\". The default value is 6. | [default to 6] + diff --git a/sdk-output/password_configuration/docs/Models/README.md b/sdk-output/password_configuration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_configuration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_dictionary/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/password_dictionary/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5dad2200 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,29 @@ +- path: /password-dictionary/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_dictionary/methods/password-dictionary#get-password-dictionary-v1 + source: | + import { PasswordDictionaryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordDictionaryV1Api(configuration); + const result = await apiInstance.getPasswordDictionaryV1(); + console.log(result); +- path: /password-dictionary/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_dictionary/methods/password-dictionary#put-password-dictionary-v1 + source: | + import { PasswordDictionaryV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordDictionaryV1Api(configuration); + const file: File = BINARY_DATA_HERE; // File | (optional) (default to undefined) + const result = await apiInstance.putPasswordDictionaryV1(); + console.log(result); diff --git a/sdk-output/password_dictionary/docs/Methods/Index.md b/sdk-output/password_dictionary/docs/Methods/Index.md new file mode 100644 index 00000000..f5bee623 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: password_dictionary-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: password_dictionary-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'password_dictionary', 'methods'] +slug: /tools/sdk/typescript/password_dictionary/methods +tags: ['SDK', 'Software Development Kit', 'password_dictionary', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/password_dictionary/docs/Methods/PasswordDictionaryV1Api.md b/sdk-output/password_dictionary/docs/Methods/PasswordDictionaryV1Api.md new file mode 100644 index 00000000..020f99b9 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Methods/PasswordDictionaryV1Api.md @@ -0,0 +1,196 @@ +--- +id: v1-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordDictionary', 'v1PasswordDictionary'] +slug: /tools/sdk/typescript/password_dictionary/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'v1PasswordDictionary'] +--- + +# PasswordDictionaryV1Api + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v2025/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-password-dictionary-v1**](#get-password-dictionary-v1) | **GET** `/password-dictionary/v1` | Get password dictionary +[**put-password-dictionary-v1**](#put-password-dictionary-v1) | **PUT** `/password-dictionary/v1` | Update password dictionary + + +## get-password-dictionary-v1 +Get password dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-dictionary-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example + +```typescript +import { PasswordDictionaryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordDictionaryV1Api(configuration); +const result = await apiInstance.getPasswordDictionaryV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-password-dictionary-v1 +Update password dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-password-dictionary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**file** | **File** | | [optional] [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { PasswordDictionaryV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordDictionaryV1Api(configuration); +const file: File = BINARY_DATA_HERE; // (optional) +const result = await apiInstance.putPasswordDictionaryV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/password_dictionary/docs/Models/Errormessagedto.md b/sdk-output/password_dictionary/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..16c45bfc --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/password_dictionary/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/password_dictionary/docs/Models/Errorresponsedto.md b/sdk-output/password_dictionary/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f6f5e2f4 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/password_dictionary/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1401Response.md b/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1401Response.md new file mode 100644 index 00000000..4b3e90cb --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-dictionary-v1401-response-v1 +title: GetPasswordDictionaryV1401ResponseV1 +pagination_label: GetPasswordDictionaryV1401ResponseV1 +sidebar_label: GetPasswordDictionaryV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordDictionaryV1401ResponseV1', 'v1GetPasswordDictionaryV1401ResponseV1'] +slug: /tools/sdk/typescript/password_dictionary/models/get-password-dictionary-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordDictionaryV1401ResponseV1', 'v1GetPasswordDictionaryV1401ResponseV1'] +--- + +# GetPasswordDictionaryV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1429Response.md b/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1429Response.md new file mode 100644 index 00000000..e8a21811 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/GetPasswordDictionaryV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-dictionary-v1429-response-v1 +title: GetPasswordDictionaryV1429ResponseV1 +pagination_label: GetPasswordDictionaryV1429ResponseV1 +sidebar_label: GetPasswordDictionaryV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordDictionaryV1429ResponseV1', 'v1GetPasswordDictionaryV1429ResponseV1'] +slug: /tools/sdk/typescript/password_dictionary/models/get-password-dictionary-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordDictionaryV1429ResponseV1', 'v1GetPasswordDictionaryV1429ResponseV1'] +--- + +# GetPasswordDictionaryV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_dictionary/docs/Models/Index.md b/sdk-output/password_dictionary/docs/Models/Index.md new file mode 100644 index 00000000..cd1ec739 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: password_dictionary-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: password_dictionary-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'password_dictionary', 'models'] +slug: /tools/sdk/typescript/password_dictionary/models +tags: ['SDK', 'Software Development Kit', 'password_dictionary', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/password_dictionary/docs/Models/Localeorigin.md b/sdk-output/password_dictionary/docs/Models/Localeorigin.md new file mode 100644 index 00000000..672113ed --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/password_dictionary/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/password_dictionary/docs/Models/PutPasswordDictionaryV1Request.md b/sdk-output/password_dictionary/docs/Models/PutPasswordDictionaryV1Request.md new file mode 100644 index 00000000..fe4b1863 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/PutPasswordDictionaryV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-put-password-dictionary-v1-request-v1 +title: PutPasswordDictionaryV1RequestV1 +pagination_label: PutPasswordDictionaryV1RequestV1 +sidebar_label: PutPasswordDictionaryV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PutPasswordDictionaryV1RequestV1', 'v1PutPasswordDictionaryV1RequestV1'] +slug: /tools/sdk/typescript/password_dictionary/models/put-password-dictionary-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryV1RequestV1', 'v1PutPasswordDictionaryV1RequestV1'] +--- + +# PutPasswordDictionaryV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **(optional)** **File** | | [default to undefined] + diff --git a/sdk-output/password_dictionary/docs/Models/README.md b/sdk-output/password_dictionary/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_dictionary/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_management/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/password_management/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..3c9f0a25 --- /dev/null +++ b/sdk-output/password_management/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,61 @@ +- path: /generate-password-reset-token/v1/digit + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_management/methods/password-management#create-digit-token-v1 + source: | + import { PasswordManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordManagementV1Api(configuration); + const passworddigittokenresetV1: PassworddigittokenresetV1 = {"userId":"Abby.Smith","length":8,"durationMinutes":5}; // PassworddigittokenresetV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createDigitTokenV1(passworddigittokenresetV1); + console.log(result); +- path: /password-change-status/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_management/methods/password-management#get-password-change-status-v1 + source: | + import { PasswordManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordManagementV1Api(configuration); + const id: string = '089899f13a8f4da7824996191587bab9'; // string | Password change request ID (default to undefined) + const result = await apiInstance.getPasswordChangeStatusV1(id); + console.log(result); +- path: /query-password-info/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_management/methods/password-management#query-password-info-v1 + source: | + import { PasswordManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordManagementV1Api(configuration); + const passwordinfoquerydtoV1: PasswordinfoquerydtoV1 = ; // PasswordinfoquerydtoV1 | + const result = await apiInstance.queryPasswordInfoV1(passwordinfoquerydtoV1); + console.log(result); +- path: /set-password/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_management/methods/password-management#set-password-v1 + source: | + import { PasswordManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordManagementV1Api(configuration); + const passwordchangerequestV1: PasswordchangerequestV1 = ; // PasswordchangerequestV1 | + const result = await apiInstance.setPasswordV1(passwordchangerequestV1); + console.log(result); diff --git a/sdk-output/password_management/docs/Methods/Index.md b/sdk-output/password_management/docs/Methods/Index.md new file mode 100644 index 00000000..96cf43d1 --- /dev/null +++ b/sdk-output/password_management/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: password_management-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: password_management-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'password_management', 'methods'] +slug: /tools/sdk/typescript/password_management/methods +tags: ['SDK', 'Software Development Kit', 'password_management', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/password_management/docs/Methods/PasswordManagementV1Api.md b/sdk-output/password_management/docs/Methods/PasswordManagementV1Api.md new file mode 100644 index 00000000..b94b1e04 --- /dev/null +++ b/sdk-output/password_management/docs/Methods/PasswordManagementV1Api.md @@ -0,0 +1,224 @@ +--- +id: v1-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordManagement', 'v1PasswordManagement'] +slug: /tools/sdk/typescript/password_management/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'v1PasswordManagement'] +--- + +# PasswordManagementV1Api + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-digit-token-v1**](#create-digit-token-v1) | **POST** `/generate-password-reset-token/v1/digit` | Generate a digit token +[**get-password-change-status-v1**](#get-password-change-status-v1) | **GET** `/password-change-status/v1/{id}` | Get password change request status +[**query-password-info-v1**](#query-password-info-v1) | **POST** `/query-password-info/v1` | Query password info +[**set-password-v1**](#set-password-v1) | **POST** `/set-password/v1` | Set identity\'s password + + +## create-digit-token-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Generate a digit token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-digit-token-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passworddigittokenresetV1** | **PassworddigittokenresetV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**PassworddigittokenV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordManagementV1Api(configuration); +const passworddigittokenresetV1: PassworddigittokenresetV1 = {"userId":"Abby.Smith","length":8,"durationMinutes":5}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createDigitTokenV1(passworddigittokenresetV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-password-change-status-v1 +Get password change request status +This API returns the status of a password change request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-change-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Password change request ID | [default to undefined] + +### Return type + +**PasswordstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordManagementV1Api(configuration); +const id: string = 089899f13a8f4da7824996191587bab9; // Password change request ID +const result = await apiInstance.getPasswordChangeStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## query-password-info-v1 +Query password info +This API is used to query password related information. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/query-password-info-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordinfoquerydtoV1** | **PasswordinfoquerydtoV1** | | + +### Return type + +**PasswordinfoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordManagementV1Api(configuration); +const passwordinfoquerydtoV1: PasswordinfoquerydtoV1 = ; // +const result = await apiInstance.queryPasswordInfoV1(passwordinfoquerydtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-password-v1 +Set identity\'s password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-password-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordchangerequestV1** | **PasswordchangerequestV1** | | + +### Return type + +**PasswordchangeresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordManagementV1Api(configuration); +const passwordchangerequestV1: PasswordchangerequestV1 = ; // +const result = await apiInstance.setPasswordV1(passwordchangerequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/password_management/docs/Models/Errormessagedto.md b/sdk-output/password_management/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..a4e54aff --- /dev/null +++ b/sdk-output/password_management/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/password_management/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Errorresponsedto.md b/sdk-output/password_management/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..bfec6ff9 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/password_management/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Index.md b/sdk-output/password_management/docs/Models/Index.md new file mode 100644 index 00000000..8dff6c9d --- /dev/null +++ b/sdk-output/password_management/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: password_management-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: password_management-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'password_management', 'models'] +slug: /tools/sdk/typescript/password_management/models +tags: ['SDK', 'Software Development Kit', 'password_management', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/password_management/docs/Models/Localeorigin.md b/sdk-output/password_management/docs/Models/Localeorigin.md new file mode 100644 index 00000000..72d929a8 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/password_management/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/password_management/docs/Models/Passwordchangerequest.md b/sdk-output/password_management/docs/Models/Passwordchangerequest.md new file mode 100644 index 00000000..fbd7b417 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordchangerequest.md @@ -0,0 +1,23 @@ +--- +id: v1-passwordchangerequest-v1 +title: PasswordchangerequestV1 +pagination_label: PasswordchangerequestV1 +sidebar_label: PasswordchangerequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordchangerequestV1', 'v1PasswordchangerequestV1'] +slug: /tools/sdk/typescript/password_management/models/passwordchangerequest-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordchangerequestV1', 'v1PasswordchangerequestV1'] +--- + +# PasswordchangerequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | The identity ID that requested the password change | [default to undefined] +**encryptedPassword** | **(optional)** **string** | The RSA encrypted password | [default to undefined] +**publicKeyId** | **(optional)** **string** | The encryption key ID | [default to undefined] +**accountId** | **(optional)** **string** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source for which identity is requesting the password change | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passwordchangeresponse.md b/sdk-output/password_management/docs/Models/Passwordchangeresponse.md new file mode 100644 index 00000000..090da7b6 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordchangeresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-passwordchangeresponse-v1 +title: PasswordchangeresponseV1 +pagination_label: PasswordchangeresponseV1 +sidebar_label: PasswordchangeresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordchangeresponseV1', 'v1PasswordchangeresponseV1'] +slug: /tools/sdk/typescript/password_management/models/passwordchangeresponse-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordchangeresponseV1', 'v1PasswordchangeresponseV1'] +--- + +# PasswordchangeresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **(optional)** **string** | The password change request ID | [default to undefined] +**state** | **(optional)** **string** | Password change state | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passworddigittoken.md b/sdk-output/password_management/docs/Models/Passworddigittoken.md new file mode 100644 index 00000000..afbff6a8 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passworddigittoken.md @@ -0,0 +1,20 @@ +--- +id: v1-passworddigittoken-v1 +title: PassworddigittokenV1 +pagination_label: PassworddigittokenV1 +sidebar_label: PassworddigittokenV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PassworddigittokenV1', 'v1PassworddigittokenV1'] +slug: /tools/sdk/typescript/password_management/models/passworddigittoken-v1 +tags: ['SDK', 'Software Development Kit', 'PassworddigittokenV1', 'v1PassworddigittokenV1'] +--- + +# PassworddigittokenV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**digitToken** | **(optional)** **string** | The digit token for password management | [default to undefined] +**requestId** | **(optional)** **string** | The reference ID of the digit token generation request | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passworddigittokenreset.md b/sdk-output/password_management/docs/Models/Passworddigittokenreset.md new file mode 100644 index 00000000..6543e1b9 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passworddigittokenreset.md @@ -0,0 +1,21 @@ +--- +id: v1-passworddigittokenreset-v1 +title: PassworddigittokenresetV1 +pagination_label: PassworddigittokenresetV1 +sidebar_label: PassworddigittokenresetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PassworddigittokenresetV1', 'v1PassworddigittokenresetV1'] +slug: /tools/sdk/typescript/password_management/models/passworddigittokenreset-v1 +tags: ['SDK', 'Software Development Kit', 'PassworddigittokenresetV1', 'v1PassworddigittokenresetV1'] +--- + +# PassworddigittokenresetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userId** | **string** | The uid of the user requested for digit token | [default to undefined] +**length** | **(optional)** **number** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [default to undefined] +**durationMinutes** | **(optional)** **number** | The time to live for the digit token in minutes. The default value is 5 minutes. | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passwordinfo.md b/sdk-output/password_management/docs/Models/Passwordinfo.md new file mode 100644 index 00000000..f5383a94 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordinfo.md @@ -0,0 +1,24 @@ +--- +id: v1-passwordinfo-v1 +title: PasswordinfoV1 +pagination_label: PasswordinfoV1 +sidebar_label: PasswordinfoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordinfoV1', 'v1PasswordinfoV1'] +slug: /tools/sdk/typescript/password_management/models/passwordinfo-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordinfoV1', 'v1PasswordinfoV1'] +--- + +# PasswordinfoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **(optional)** **string** | Identity ID | [default to undefined] +**sourceId** | **(optional)** **string** | source ID | [default to undefined] +**publicKeyId** | **(optional)** **string** | public key ID | [default to undefined] +**publicKey** | **(optional)** **string** | User\'s public key with Base64 encoding | [default to undefined] +**accounts** | **(optional)** **Array<PasswordinfoaccountV1>** | Account info related to queried identity and source | [default to undefined] +**policies** | **(optional)** **Array<string>** | Password constraints | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passwordinfoaccount.md b/sdk-output/password_management/docs/Models/Passwordinfoaccount.md new file mode 100644 index 00000000..251dffd7 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordinfoaccount.md @@ -0,0 +1,20 @@ +--- +id: v1-passwordinfoaccount-v1 +title: PasswordinfoaccountV1 +pagination_label: PasswordinfoaccountV1 +sidebar_label: PasswordinfoaccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordinfoaccountV1', 'v1PasswordinfoaccountV1'] +slug: /tools/sdk/typescript/password_management/models/passwordinfoaccount-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordinfoaccountV1', 'v1PasswordinfoaccountV1'] +--- + +# PasswordinfoaccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountId** | **(optional)** **string** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [default to undefined] +**accountName** | **(optional)** **string** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passwordinfoquerydto.md b/sdk-output/password_management/docs/Models/Passwordinfoquerydto.md new file mode 100644 index 00000000..eede9886 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordinfoquerydto.md @@ -0,0 +1,20 @@ +--- +id: v1-passwordinfoquerydto-v1 +title: PasswordinfoquerydtoV1 +pagination_label: PasswordinfoquerydtoV1 +sidebar_label: PasswordinfoquerydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordinfoquerydtoV1', 'v1PasswordinfoquerydtoV1'] +slug: /tools/sdk/typescript/password_management/models/passwordinfoquerydto-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordinfoquerydtoV1', 'v1PasswordinfoquerydtoV1'] +--- + +# PasswordinfoquerydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userName** | **(optional)** **string** | The login name of the user | [default to undefined] +**sourceName** | **(optional)** **string** | The display name of the source | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/Passwordstatus.md b/sdk-output/password_management/docs/Models/Passwordstatus.md new file mode 100644 index 00000000..e55a1672 --- /dev/null +++ b/sdk-output/password_management/docs/Models/Passwordstatus.md @@ -0,0 +1,22 @@ +--- +id: v1-passwordstatus-v1 +title: PasswordstatusV1 +pagination_label: PasswordstatusV1 +sidebar_label: PasswordstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordstatusV1', 'v1PasswordstatusV1'] +slug: /tools/sdk/typescript/password_management/models/passwordstatus-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordstatusV1', 'v1PasswordstatusV1'] +--- + +# PasswordstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **(optional)** **string** | The password change request ID | [default to undefined] +**state** | **(optional)** **string** | Password change state | [default to undefined] +**errors** | **(optional)** **Array<string>** | The errors during the password change request | [default to undefined] +**sourceIds** | **(optional)** **Array<string>** | List of source IDs in the password change request | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/QueryPasswordInfoV1401Response.md b/sdk-output/password_management/docs/Models/QueryPasswordInfoV1401Response.md new file mode 100644 index 00000000..04c124e1 --- /dev/null +++ b/sdk-output/password_management/docs/Models/QueryPasswordInfoV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-query-password-info-v1401-response-v1 +title: QueryPasswordInfoV1401ResponseV1 +pagination_label: QueryPasswordInfoV1401ResponseV1 +sidebar_label: QueryPasswordInfoV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryPasswordInfoV1401ResponseV1', 'v1QueryPasswordInfoV1401ResponseV1'] +slug: /tools/sdk/typescript/password_management/models/query-password-info-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'QueryPasswordInfoV1401ResponseV1', 'v1QueryPasswordInfoV1401ResponseV1'] +--- + +# QueryPasswordInfoV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/QueryPasswordInfoV1429Response.md b/sdk-output/password_management/docs/Models/QueryPasswordInfoV1429Response.md new file mode 100644 index 00000000..bcbe00f7 --- /dev/null +++ b/sdk-output/password_management/docs/Models/QueryPasswordInfoV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-query-password-info-v1429-response-v1 +title: QueryPasswordInfoV1429ResponseV1 +pagination_label: QueryPasswordInfoV1429ResponseV1 +sidebar_label: QueryPasswordInfoV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryPasswordInfoV1429ResponseV1', 'v1QueryPasswordInfoV1429ResponseV1'] +slug: /tools/sdk/typescript/password_management/models/query-password-info-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'QueryPasswordInfoV1429ResponseV1', 'v1QueryPasswordInfoV1429ResponseV1'] +--- + +# QueryPasswordInfoV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_management/docs/Models/README.md b/sdk-output/password_management/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_management/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_policies/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/password_policies/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..4c124b88 --- /dev/null +++ b/sdk-output/password_policies/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,83 @@ +- path: /password-policies/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_policies/methods/password-policies#create-password-policy-v1 + source: | + import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordPoliciesV1Api(configuration); + const passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 = {"description":"New Password Policy with high requirements to password complexity.","id":null,"name":"High security Password Policy","dateCreated":1639056206564,"lastUpdated":1662385430753,"firstExpirationReminder":90,"accountIdMinWordLength":3,"accountNameMinWordLength":3,"maxLength":0,"maxRepeatedChars":4,"minAlpha":1,"minCharacterTypes":-1,"minLength":8,"minLower":0,"minNumeric":1,"minSpecial":0,"minUpper":0,"passwordExpiration":90,"defaultPolicy":false,"enablePasswdExpiration":false,"requireStrongAuthn":false,"requireStrongAuthOffNetwork":false,"requireStrongAuthUntrustedGeographies":false,"useAccountAttributes":false,"useDictionary":false,"useIdentityAttributes":false,"validateAgainstAccountId":true,"validateAgainstAccountName":true,"sourceIds":["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f"]}; // Passwordpolicyv3dtoV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createPasswordPolicyV1(passwordpolicyv3dtoV1); + console.log(result); +- path: /password-policies/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_policies/methods/password-policies#delete-password-policy-v1 + source: | + import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordPoliciesV1Api(configuration); + const id: string = 'ff808081838d9e9d01838da6a03e0002'; // string | The ID of password policy to delete. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deletePasswordPolicyV1(id); + console.log(result); +- path: /password-policies/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_policies/methods/password-policies#get-password-policy-by-id-v1 + source: | + import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordPoliciesV1Api(configuration); + const id: string = 'ff808081838d9e9d01838da6a03e0005'; // string | The ID of password policy to retrieve. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getPasswordPolicyByIdV1(id); + console.log(result); +- path: /password-policies/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_policies/methods/password-policies#list-password-policies-v1 + source: | + import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordPoliciesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listPasswordPoliciesV1(); + console.log(result); +- path: /password-policies/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_policies/methods/password-policies#set-password-policy-v1 + source: | + import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordPoliciesV1Api(configuration); + const id: string = 'ff808081838d9e9d01838da6a03e0007'; // string | The ID of password policy to update. (default to undefined) + const passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 = {"description":"Password Policy after update.","id":"2c91808e7d976f3b017d9f5ceae440c8","name":"Improved Password Policy","dateCreated":1639056206564,"lastUpdated":1662385430753,"firstExpirationReminder":90,"accountIdMinWordLength":3,"accountNameMinWordLength":3,"maxLength":0,"maxRepeatedChars":4,"minAlpha":1,"minCharacterTypes":-1,"minLength":8,"minLower":0,"minNumeric":1,"minSpecial":0,"minUpper":0,"passwordExpiration":90,"defaultPolicy":false,"enablePasswdExpiration":false,"requireStrongAuthn":false,"requireStrongAuthOffNetwork":false,"requireStrongAuthUntrustedGeographies":false,"useAccountAttributes":false,"useDictionary":false,"useIdentityAttributes":false,"validateAgainstAccountId":true,"validateAgainstAccountName":true,"sourceIds":["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f"]}; // Passwordpolicyv3dtoV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.setPasswordPolicyV1(id, passwordpolicyv3dtoV1); + console.log(result); diff --git a/sdk-output/password_policies/docs/Methods/Index.md b/sdk-output/password_policies/docs/Methods/Index.md new file mode 100644 index 00000000..8dae1891 --- /dev/null +++ b/sdk-output/password_policies/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: password_policies-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: password_policies-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'password_policies', 'methods'] +slug: /tools/sdk/typescript/password_policies/methods +tags: ['SDK', 'Software Development Kit', 'password_policies', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/password_policies/docs/Methods/PasswordPoliciesV1Api.md b/sdk-output/password_policies/docs/Methods/PasswordPoliciesV1Api.md new file mode 100644 index 00000000..ac66e4c5 --- /dev/null +++ b/sdk-output/password_policies/docs/Methods/PasswordPoliciesV1Api.md @@ -0,0 +1,254 @@ +--- +id: v1-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordPolicies', 'v1PasswordPolicies'] +slug: /tools/sdk/typescript/password_policies/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'v1PasswordPolicies'] +--- + +# PasswordPoliciesV1Api + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-policy-v1**](#create-password-policy-v1) | **POST** `/password-policies/v1` | Create password policy +[**delete-password-policy-v1**](#delete-password-policy-v1) | **DELETE** `/password-policies/v1/{id}` | Delete password policy by id +[**get-password-policy-by-id-v1**](#get-password-policy-by-id-v1) | **GET** `/password-policies/v1/{id}` | Get password policy by id +[**list-password-policies-v1**](#list-password-policies-v1) | **GET** `/password-policies/v1` | List password policies +[**set-password-policy-v1**](#set-password-policy-v1) | **PUT** `/password-policies/v1/{id}` | Update password policy by id + + +## create-password-policy-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create password policy +This API creates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-password-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordpolicyv3dtoV1** | **Passwordpolicyv3dtoV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Passwordpolicyv3dtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordPoliciesV1Api(configuration); +const passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 = {"description":"New Password Policy with high requirements to password complexity.","id":null,"name":"High security Password Policy","dateCreated":1639056206564,"lastUpdated":1662385430753,"firstExpirationReminder":90,"accountIdMinWordLength":3,"accountNameMinWordLength":3,"maxLength":0,"maxRepeatedChars":4,"minAlpha":1,"minCharacterTypes":-1,"minLength":8,"minLower":0,"minNumeric":1,"minSpecial":0,"minUpper":0,"passwordExpiration":90,"defaultPolicy":false,"enablePasswdExpiration":false,"requireStrongAuthn":false,"requireStrongAuthOffNetwork":false,"requireStrongAuthUntrustedGeographies":false,"useAccountAttributes":false,"useDictionary":false,"useIdentityAttributes":false,"validateAgainstAccountId":true,"validateAgainstAccountName":true,"sourceIds":["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f"]}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createPasswordPolicyV1(passwordpolicyv3dtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-password-policy-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete password policy by id +This API deletes the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-password-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password policy to delete. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordPoliciesV1Api(configuration); +const id: string = ff808081838d9e9d01838da6a03e0002; // The ID of password policy to delete. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deletePasswordPolicyV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-password-policy-by-id-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get password policy by id +This API returns the password policy for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-policy-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password policy to retrieve. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Passwordpolicyv3dtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordPoliciesV1Api(configuration); +const id: string = ff808081838d9e9d01838da6a03e0005; // The ID of password policy to retrieve. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getPasswordPolicyByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-password-policies-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List password policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-password-policies-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordPoliciesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listPasswordPoliciesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## set-password-policy-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update password policy by id +This API updates the specified password policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-password-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password policy to update. | [default to undefined] +**passwordpolicyv3dtoV1** | **Passwordpolicyv3dtoV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Passwordpolicyv3dtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordPoliciesV1Api(configuration); +const id: string = ff808081838d9e9d01838da6a03e0007; // The ID of password policy to update. +const passwordpolicyv3dtoV1: Passwordpolicyv3dtoV1 = {"description":"Password Policy after update.","id":"2c91808e7d976f3b017d9f5ceae440c8","name":"Improved Password Policy","dateCreated":1639056206564,"lastUpdated":1662385430753,"firstExpirationReminder":90,"accountIdMinWordLength":3,"accountNameMinWordLength":3,"maxLength":0,"maxRepeatedChars":4,"minAlpha":1,"minCharacterTypes":-1,"minLength":8,"minLower":0,"minNumeric":1,"minSpecial":0,"minUpper":0,"passwordExpiration":90,"defaultPolicy":false,"enablePasswdExpiration":false,"requireStrongAuthn":false,"requireStrongAuthOffNetwork":false,"requireStrongAuthUntrustedGeographies":false,"useAccountAttributes":false,"useDictionary":false,"useIdentityAttributes":false,"validateAgainstAccountId":true,"validateAgainstAccountName":true,"sourceIds":["2c91808382ffee0b01830de154f14034","2c91808582ffee0c01830de36511405f"]}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.setPasswordPolicyV1(id, passwordpolicyv3dtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/password_policies/docs/Models/Errormessagedto.md b/sdk-output/password_policies/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..f2b634e4 --- /dev/null +++ b/sdk-output/password_policies/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/password_policies/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/password_policies/docs/Models/Errorresponsedto.md b/sdk-output/password_policies/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..2c6b828f --- /dev/null +++ b/sdk-output/password_policies/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/password_policies/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1401Response.md b/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1401Response.md new file mode 100644 index 00000000..7d166570 --- /dev/null +++ b/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-policy-by-id-v1401-response-v1 +title: GetPasswordPolicyByIdV1401ResponseV1 +pagination_label: GetPasswordPolicyByIdV1401ResponseV1 +sidebar_label: GetPasswordPolicyByIdV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordPolicyByIdV1401ResponseV1', 'v1GetPasswordPolicyByIdV1401ResponseV1'] +slug: /tools/sdk/typescript/password_policies/models/get-password-policy-by-id-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordPolicyByIdV1401ResponseV1', 'v1GetPasswordPolicyByIdV1401ResponseV1'] +--- + +# GetPasswordPolicyByIdV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1429Response.md b/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1429Response.md new file mode 100644 index 00000000..b885937b --- /dev/null +++ b/sdk-output/password_policies/docs/Models/GetPasswordPolicyByIdV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-policy-by-id-v1429-response-v1 +title: GetPasswordPolicyByIdV1429ResponseV1 +pagination_label: GetPasswordPolicyByIdV1429ResponseV1 +sidebar_label: GetPasswordPolicyByIdV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordPolicyByIdV1429ResponseV1', 'v1GetPasswordPolicyByIdV1429ResponseV1'] +slug: /tools/sdk/typescript/password_policies/models/get-password-policy-by-id-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordPolicyByIdV1429ResponseV1', 'v1GetPasswordPolicyByIdV1429ResponseV1'] +--- + +# GetPasswordPolicyByIdV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_policies/docs/Models/Index.md b/sdk-output/password_policies/docs/Models/Index.md new file mode 100644 index 00000000..196c31ee --- /dev/null +++ b/sdk-output/password_policies/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: password_policies-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: password_policies-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'password_policies', 'models'] +slug: /tools/sdk/typescript/password_policies/models +tags: ['SDK', 'Software Development Kit', 'password_policies', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/password_policies/docs/Models/Localeorigin.md b/sdk-output/password_policies/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a0b0cfa7 --- /dev/null +++ b/sdk-output/password_policies/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/password_policies/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/password_policies/docs/Models/Passwordpolicyv3dto.md b/sdk-output/password_policies/docs/Models/Passwordpolicyv3dto.md new file mode 100644 index 00000000..5347f2b7 --- /dev/null +++ b/sdk-output/password_policies/docs/Models/Passwordpolicyv3dto.md @@ -0,0 +1,49 @@ +--- +id: v1-passwordpolicyv3dto-v1 +title: Passwordpolicyv3dtoV1 +pagination_label: Passwordpolicyv3dtoV1 +sidebar_label: Passwordpolicyv3dtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Passwordpolicyv3dtoV1', 'v1Passwordpolicyv3dtoV1'] +slug: /tools/sdk/typescript/password_policies/models/passwordpolicyv3dto-v1 +tags: ['SDK', 'Software Development Kit', 'Passwordpolicyv3dtoV1', 'v1Passwordpolicyv3dtoV1'] +--- + +# Passwordpolicyv3dtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The password policy Id. | [default to undefined] +**description** | **(optional)** **string** | Description for current password policy. | [default to undefined] +**name** | **(optional)** **string** | The name of the password policy. | [default to undefined] +**dateCreated** | **(optional)** **number** | Date the Password Policy was created. | [default to undefined] +**lastUpdated** | **(optional)** **number** | Date the Password Policy was updated. | [default to undefined] +**firstExpirationReminder** | **(optional)** **number** | The number of days before expiration remaninder. | [default to undefined] +**accountIdMinWordLength** | **(optional)** **number** | The minimun length of account Id. By default is equals to -1. | [default to undefined] +**accountNameMinWordLength** | **(optional)** **number** | The minimun length of account name. By default is equals to -1. | [default to undefined] +**minAlpha** | **(optional)** **number** | Maximum alpha. By default is equals to 0. | [default to undefined] +**minCharacterTypes** | **(optional)** **number** | MinCharacterTypes. By default is equals to -1. | [default to undefined] +**maxLength** | **(optional)** **number** | Maximum length of the password. | [default to undefined] +**minLength** | **(optional)** **number** | Minimum length of the password. By default is equals to 0. | [default to undefined] +**maxRepeatedChars** | **(optional)** **number** | Maximum repetition of the same character in the password. By default is equals to -1. | [default to undefined] +**minLower** | **(optional)** **number** | Minimum amount of lower case character in the password. By default is equals to 0. | [default to undefined] +**minNumeric** | **(optional)** **number** | Minimum amount of numeric characters in the password. By default is equals to 0. | [default to undefined] +**minSpecial** | **(optional)** **number** | Minimum amount of special symbols in the password. By default is equals to 0. | [default to undefined] +**minUpper** | **(optional)** **number** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [default to undefined] +**passwordExpiration** | **(optional)** **number** | Number of days before current password expires. By default is equals to 90. | [default to undefined] +**defaultPolicy** | **(optional)** **boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [default to false] +**enablePasswdExpiration** | **(optional)** **boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [default to false] +**requireStrongAuthn** | **(optional)** **boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [default to false] +**requireStrongAuthOffNetwork** | **(optional)** **boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [default to false] +**requireStrongAuthUntrustedGeographies** | **(optional)** **boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [default to false] +**useAccountAttributes** | **(optional)** **boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [default to false] +**useDictionary** | **(optional)** **boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [default to false] +**useIdentityAttributes** | **(optional)** **boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [default to false] +**validateAgainstAccountId** | **(optional)** **boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [default to false] +**validateAgainstAccountName** | **(optional)** **boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [default to false] +**created** | **(optional)** **string** | | [default to undefined] +**modified** | **(optional)** **string** | | [default to undefined] +**sourceIds** | **(optional)** **Array<string>** | List of sources IDs managed by this password policy. | [default to undefined] + diff --git a/sdk-output/password_policies/docs/Models/README.md b/sdk-output/password_policies/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_policies/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/password_sync_groups/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/password_sync_groups/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..638b3ef1 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,78 @@ +- path: /password-sync-groups/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_sync_groups/methods/password-sync-groups#create-password-sync-group-v1 + source: | + import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordSyncGroupsV1Api(configuration); + const passwordsyncgroupV1: PasswordsyncgroupV1 = {"name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}; // PasswordsyncgroupV1 | + const result = await apiInstance.createPasswordSyncGroupV1(passwordsyncgroupV1); + console.log(result); +- path: /password-sync-groups/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_sync_groups/methods/password-sync-groups#delete-password-sync-group-v1 + source: | + import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordSyncGroupsV1Api(configuration); + const id: string = '6881f631-3bd5-4213-9c75-8e05cc3e35dd'; // string | The ID of password sync group to delete. (default to undefined) + const result = await apiInstance.deletePasswordSyncGroupV1(id); + console.log(result); +- path: /password-sync-groups/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_sync_groups/methods/password-sync-groups#get-password-sync-group-v1 + source: | + import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordSyncGroupsV1Api(configuration); + const id: string = '6881f631-3bd5-4213-9c75-8e05cc3e35dd'; // string | The ID of password sync group to retrieve. (default to undefined) + const result = await apiInstance.getPasswordSyncGroupV1(id); + console.log(result); +- path: /password-sync-groups/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_sync_groups/methods/password-sync-groups#get-password-sync-groups-v1 + source: | + import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordSyncGroupsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getPasswordSyncGroupsV1(); + console.log(result); +- path: /password-sync-groups/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/password_sync_groups/methods/password-sync-groups#update-password-sync-group-v1 + source: | + import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PasswordSyncGroupsV1Api(configuration); + const id: string = '6881f631-3bd5-4213-9c75-8e05cc3e35dd'; // string | The ID of password sync group to update. (default to undefined) + const passwordsyncgroupV1: PasswordsyncgroupV1 = {"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}; // PasswordsyncgroupV1 | + const result = await apiInstance.updatePasswordSyncGroupV1(id, passwordsyncgroupV1); + console.log(result); diff --git a/sdk-output/password_sync_groups/docs/Methods/Index.md b/sdk-output/password_sync_groups/docs/Methods/Index.md new file mode 100644 index 00000000..69a38172 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: password_sync_groups-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: password_sync_groups-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'password_sync_groups', 'methods'] +slug: /tools/sdk/typescript/password_sync_groups/methods +tags: ['SDK', 'Software Development Kit', 'password_sync_groups', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/password_sync_groups/docs/Methods/PasswordSyncGroupsV1Api.md b/sdk-output/password_sync_groups/docs/Methods/PasswordSyncGroupsV1Api.md new file mode 100644 index 00000000..ebd38abd --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Methods/PasswordSyncGroupsV1Api.md @@ -0,0 +1,252 @@ +--- +id: v1-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordSyncGroups', 'v1PasswordSyncGroups'] +slug: /tools/sdk/typescript/password_sync_groups/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'v1PasswordSyncGroups'] +--- + +# PasswordSyncGroupsV1Api + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/index.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-password-sync-group-v1**](#create-password-sync-group-v1) | **POST** `/password-sync-groups/v1` | Create password sync group +[**delete-password-sync-group-v1**](#delete-password-sync-group-v1) | **DELETE** `/password-sync-groups/v1/{id}` | Delete password sync group by id +[**get-password-sync-group-v1**](#get-password-sync-group-v1) | **GET** `/password-sync-groups/v1/{id}` | Get password sync group by id +[**get-password-sync-groups-v1**](#get-password-sync-groups-v1) | **GET** `/password-sync-groups/v1` | Get password sync group list +[**update-password-sync-group-v1**](#update-password-sync-group-v1) | **PUT** `/password-sync-groups/v1/{id}` | Update password sync group by id + + +## create-password-sync-group-v1 +Create password sync group +This API creates a password sync group based on the specifications provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-password-sync-group-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**passwordsyncgroupV1** | **PasswordsyncgroupV1** | | + +### Return type + +**PasswordsyncgroupV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordSyncGroupsV1Api(configuration); +const passwordsyncgroupV1: PasswordsyncgroupV1 = {"name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}; // +const result = await apiInstance.createPasswordSyncGroupV1(passwordsyncgroupV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-password-sync-group-v1 +Delete password sync group by id +This API deletes the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-password-sync-group-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password sync group to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordSyncGroupsV1Api(configuration); +const id: string = 6881f631-3bd5-4213-9c75-8e05cc3e35dd; // The ID of password sync group to delete. +const result = await apiInstance.deletePasswordSyncGroupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-password-sync-group-v1 +Get password sync group by id +This API returns the sync group for the specified ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-sync-group-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password sync group to retrieve. | [default to undefined] + +### Return type + +**PasswordsyncgroupV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordSyncGroupsV1Api(configuration); +const id: string = 6881f631-3bd5-4213-9c75-8e05cc3e35dd; // The ID of password sync group to retrieve. +const result = await apiInstance.getPasswordSyncGroupV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-password-sync-groups-v1 +Get password sync group list +This API returns a list of password sync groups. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-password-sync-groups-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordSyncGroupsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getPasswordSyncGroupsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-password-sync-group-v1 +Update password sync group by id +This API updates the specified password sync group. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-password-sync-group-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of password sync group to update. | [default to undefined] +**passwordsyncgroupV1** | **PasswordsyncgroupV1** | | + +### Return type + +**PasswordsyncgroupV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PasswordSyncGroupsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PasswordSyncGroupsV1Api(configuration); +const id: string = 6881f631-3bd5-4213-9c75-8e05cc3e35dd; // The ID of password sync group to update. +const passwordsyncgroupV1: PasswordsyncgroupV1 = {"id":"6881f631-3bd5-4213-9c75-8e05cc3e35dd","name":"Password Sync Group 2","passwordPolicyId":"2c91808d744ba0ce01746f93b6204501","sourceIds":["2c918084660f45d6016617daa9210584","2c918084660f45d6016617daa9210500"]}; // +const result = await apiInstance.updatePasswordSyncGroupV1(id, passwordsyncgroupV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/password_sync_groups/docs/Models/Errormessagedto.md b/sdk-output/password_sync_groups/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..9979864b --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/password_sync_groups/docs/Models/Errorresponsedto.md b/sdk-output/password_sync_groups/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e956d2e4 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1401Response.md b/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1401Response.md new file mode 100644 index 00000000..294dae45 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-sync-groups-v1401-response-v1 +title: GetPasswordSyncGroupsV1401ResponseV1 +pagination_label: GetPasswordSyncGroupsV1401ResponseV1 +sidebar_label: GetPasswordSyncGroupsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordSyncGroupsV1401ResponseV1', 'v1GetPasswordSyncGroupsV1401ResponseV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/get-password-sync-groups-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordSyncGroupsV1401ResponseV1', 'v1GetPasswordSyncGroupsV1401ResponseV1'] +--- + +# GetPasswordSyncGroupsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1429Response.md b/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1429Response.md new file mode 100644 index 00000000..bba684dc --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/GetPasswordSyncGroupsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-password-sync-groups-v1429-response-v1 +title: GetPasswordSyncGroupsV1429ResponseV1 +pagination_label: GetPasswordSyncGroupsV1429ResponseV1 +sidebar_label: GetPasswordSyncGroupsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPasswordSyncGroupsV1429ResponseV1', 'v1GetPasswordSyncGroupsV1429ResponseV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/get-password-sync-groups-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPasswordSyncGroupsV1429ResponseV1', 'v1GetPasswordSyncGroupsV1429ResponseV1'] +--- + +# GetPasswordSyncGroupsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/password_sync_groups/docs/Models/Index.md b/sdk-output/password_sync_groups/docs/Models/Index.md new file mode 100644 index 00000000..dde0a096 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: password_sync_groups-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: password_sync_groups-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'password_sync_groups', 'models'] +slug: /tools/sdk/typescript/password_sync_groups/models +tags: ['SDK', 'Software Development Kit', 'password_sync_groups', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/password_sync_groups/docs/Models/Localeorigin.md b/sdk-output/password_sync_groups/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dafaa13b --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/password_sync_groups/docs/Models/Passwordsyncgroup.md b/sdk-output/password_sync_groups/docs/Models/Passwordsyncgroup.md new file mode 100644 index 00000000..200c9160 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/Passwordsyncgroup.md @@ -0,0 +1,24 @@ +--- +id: v1-passwordsyncgroup-v1 +title: PasswordsyncgroupV1 +pagination_label: PasswordsyncgroupV1 +sidebar_label: PasswordsyncgroupV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordsyncgroupV1', 'v1PasswordsyncgroupV1'] +slug: /tools/sdk/typescript/password_sync_groups/models/passwordsyncgroup-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordsyncgroupV1', 'v1PasswordsyncgroupV1'] +--- + +# PasswordsyncgroupV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the sync group | [default to undefined] +**name** | **(optional)** **string** | Name of the sync group | [default to undefined] +**passwordPolicyId** | **(optional)** **string** | ID of the password policy | [default to undefined] +**sourceIds** | **(optional)** **Array<string>** | List of password managed sources IDs | [default to undefined] +**created** | **(optional)** **string** | The date and time this sync group was created | [default to undefined] +**modified** | **(optional)** **string** | The date and time this sync group was last modified | [default to undefined] + diff --git a/sdk-output/password_sync_groups/docs/Models/README.md b/sdk-output/password_sync_groups/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/password_sync_groups/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/personal_access_tokens/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/personal_access_tokens/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d12ae7e4 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,62 @@ +- path: /personal-access-tokens/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/personal_access_tokens/methods/personal-access-tokens#create-personal-access-token-v1 + source: | + import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PersonalAccessTokensV1Api(configuration); + const createpersonalaccesstokenrequestV1: CreatepersonalaccesstokenrequestV1 = ; // CreatepersonalaccesstokenrequestV1 | Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + const result = await apiInstance.createPersonalAccessTokenV1(createpersonalaccesstokenrequestV1); + console.log(result); +- path: /personal-access-tokens/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/personal_access_tokens/methods/personal-access-tokens#delete-personal-access-token-v1 + source: | + import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PersonalAccessTokensV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The personal access token id (default to undefined) + const result = await apiInstance.deletePersonalAccessTokenV1(id); + console.log(result); +- path: /personal-access-tokens/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/personal_access_tokens/methods/personal-access-tokens#list-personal-access-tokens-v1 + source: | + import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PersonalAccessTokensV1Api(configuration); + const ownerId: string = '2c9180867b50d088017b554662fb281e'; // string | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' (optional) (default to undefined) + const filters: string = 'lastUsed le 2023-02-05T10:59:27.214Z'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) (default to undefined) + const result = await apiInstance.listPersonalAccessTokensV1(); + console.log(result); +- path: /personal-access-tokens/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/personal_access_tokens/methods/personal-access-tokens#patch-personal-access-token-v1 + source: | + import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PersonalAccessTokensV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The Personal Access Token id (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/scope","value":["sp:scopes:all"]},{"op":"replace","path":"/expirationDate","value":"2027-12-31T23:59:59.999Z"}]; // Array | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. + const result = await apiInstance.patchPersonalAccessTokenV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/personal_access_tokens/docs/Methods/Index.md b/sdk-output/personal_access_tokens/docs/Methods/Index.md new file mode 100644 index 00000000..1ef4efdb --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: personal_access_tokens-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: personal_access_tokens-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'personal_access_tokens', 'methods'] +slug: /tools/sdk/typescript/personal_access_tokens/methods +tags: ['SDK', 'Software Development Kit', 'personal_access_tokens', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/personal_access_tokens/docs/Methods/PersonalAccessTokensV1Api.md b/sdk-output/personal_access_tokens/docs/Methods/PersonalAccessTokensV1Api.md new file mode 100644 index 00000000..aa863362 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Methods/PersonalAccessTokensV1Api.md @@ -0,0 +1,207 @@ +--- +id: v1-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PersonalAccessTokens', 'v1PersonalAccessTokens'] +slug: /tools/sdk/typescript/personal_access_tokens/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'v1PersonalAccessTokens'] +--- + +# PersonalAccessTokensV1Api + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html?h=token#generating-a-personal-access-token) for more information about PATs. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-personal-access-token-v1**](#create-personal-access-token-v1) | **POST** `/personal-access-tokens/v1` | Create personal access token +[**delete-personal-access-token-v1**](#delete-personal-access-token-v1) | **DELETE** `/personal-access-tokens/v1/{id}` | Delete personal access token +[**list-personal-access-tokens-v1**](#list-personal-access-tokens-v1) | **GET** `/personal-access-tokens/v1` | List personal access tokens +[**patch-personal-access-token-v1**](#patch-personal-access-token-v1) | **PATCH** `/personal-access-tokens/v1/{id}` | Patch personal access token + + +## create-personal-access-token-v1 +Create personal access token +This creates a personal access token. +**expirationDate and userAwareTokenNeverExpires Relationship:** +**Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. +**Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. +The valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: +* **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. This creates a PAT that never expires and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. +**Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. +**Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. +**Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-personal-access-token-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createpersonalaccesstokenrequestV1** | **CreatepersonalaccesstokenrequestV1** | Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. | + +### Return type + +**CreatepersonalaccesstokenresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PersonalAccessTokensV1Api(configuration); +const createpersonalaccesstokenrequestV1: CreatepersonalaccesstokenrequestV1 = ; // Configuration for creating a personal access token, including name, scope, expiration settings, and user acknowledgment of never-expiring tokens. **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. +const result = await apiInstance.createPersonalAccessTokenV1(createpersonalaccesstokenrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-personal-access-token-v1 +Delete personal access token +This deletes a personal access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-personal-access-token-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The personal access token id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PersonalAccessTokensV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The personal access token id +const result = await apiInstance.deletePersonalAccessTokenV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-personal-access-tokens-v1 +List personal access tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-personal-access-tokens-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PersonalAccessTokensV1Api(configuration); +const ownerId: string = 2c9180867b50d088017b554662fb281e; // The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: \'idn:my-personal-access-tokens:read\' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: \'idn:all-personal-access-tokens:read\'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: \'idn:managed-personal-access-tokens:read\' (optional) +const filters: string = lastUsed le 2023-02-05T10:59:27.214Z; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) +const result = await apiInstance.listPersonalAccessTokensV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-personal-access-token-v1 +Patch personal access token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. +**expirationDate and userAwareTokenNeverExpires Relationship:** +**Important:** When `expirationDate` is `null` or empty (replaced to `null` or omitted from the patch request), the token will never expire. +**Required Validation:** If `expirationDate` is being replaced to `null` or is empty, `userAwareTokenNeverExpires` must be set to `true` in the patch request. This is a required validation rule. +When patching `expirationDate` and `userAwareTokenNeverExpires`, the valid values for `expirationDate` depend on the value provided for `userAwareTokenNeverExpires`: +* **When `userAwareTokenNeverExpires` is being set to `true` (or required to be `true`):** `expirationDate` can be replaced to `null` or omitted from the patch request. When `expirationDate` is `null` or empty, the token will never expire. This sets the PAT to never expire and serves as an explicit acknowledgment that the user is aware of the security implications of creating a non-expiring token. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (there is no upper limit). `expirationDate` cannot be `null` in this case. In this scenario, `userAwareTokenNeverExpires` can be omitted. +**Validation Rules:** * **If `expirationDate` is being replaced to `null`:** `userAwareTokenNeverExpires` must also be present in the patch request with a value of `true` (required). The token will never expire. * **If `expirationDate` is not being replaced to `null` (i.e., set to a future date):** `userAwareTokenNeverExpires` can be omitted. +**Security Considerations:** The `userAwareTokenNeverExpires` field is designed to ensure that users explicitly acknowledge the security implications of creating tokens that never expire. Setting this field to `true` indicates that the user understands the increased security risks and has made an informed decision to proceed. +**Note:** The `userAwareTokenNeverExpires` field indicates that the user acknowledges they are creating a token that will never expire. It does not affect token behavior beyond indicating this acknowledgment. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-personal-access-token-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Personal Access Token id | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. | + +### Return type + +**GetpersonalaccesstokenresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { PersonalAccessTokensV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PersonalAccessTokensV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The Personal Access Token id +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"New name"},{"op":"replace","path":"/scope","value":["sp:scopes:all"]},{"op":"replace","path":"/expirationDate","value":"2027-12-31T23:59:59.999Z"}]; // A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope * expirationDate * userAwareTokenNeverExpires **Important:** See the endpoint description for validation rules regarding the relationship between `expirationDate` and `userAwareTokenNeverExpires`. +const result = await apiInstance.patchPersonalAccessTokenV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/personal_access_tokens/docs/Models/ArrayInner.md b/sdk-output/personal_access_tokens/docs/Models/ArrayInner.md new file mode 100644 index 00000000..878e5821 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenrequest.md b/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenrequest.md new file mode 100644 index 00000000..2a1b621e --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenrequest.md @@ -0,0 +1,23 @@ +--- +id: v1-createpersonalaccesstokenrequest-v1 +title: CreatepersonalaccesstokenrequestV1 +pagination_label: CreatepersonalaccesstokenrequestV1 +sidebar_label: CreatepersonalaccesstokenrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreatepersonalaccesstokenrequestV1', 'v1CreatepersonalaccesstokenrequestV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/createpersonalaccesstokenrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreatepersonalaccesstokenrequestV1', 'v1CreatepersonalaccesstokenrequestV1'] +--- + +# CreatepersonalaccesstokenrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [default to undefined] +**scope** | **(optional)** **Array<string>** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope \"sp:scopes:all\". This means the personal access token will have all the rights of the owner who created it. | [default to undefined] +**accessTokenValiditySeconds** | **(optional)** **number** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [default to undefined] +**expirationDate** | **(optional)** **string** | Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty (not included in the request body), the token will never expire. **Required Validation:** If `expirationDate` is `null` or empty, `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Valid Values (dependent on `userAwareTokenNeverExpires`):** * **When `userAwareTokenNeverExpires` is `true` (or required to be `true`):** `expirationDate` can be `null` or omitted from the request body. When `expirationDate` is `null` or empty, the token will never expire. * **When `userAwareTokenNeverExpires` is `false` or omitted:** `expirationDate` must be provided and must be a valid date-time string representing a future date (after the current date/time). There is no upper limit on how far in the future the expiration date can be set. `expirationDate` cannot be `null` in this case. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). The token will never expire. * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. | [default to undefined] +**userAwareTokenNeverExpires** | **(optional)** **boolean** | Indicates that the user creating this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When set to `true`, this flag confirms that the user understands the security risks associated with non-expiring tokens. **Security Awareness:** Setting this field to `true` serves as an explicit acknowledgment that the user creating the token understands: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Required Validation:** If `expirationDate` is `null` or empty (not included in the request body), `userAwareTokenNeverExpires` must be set to `true`. This is a required validation rule. **Validation Rules:** * **If `expirationDate` is `null` or not included in the request body:** `userAwareTokenNeverExpires` must be set to `true` (required). * **If `expirationDate` is provided and is not `null`:** `userAwareTokenNeverExpires` can be omitted. **Behavior:** * When set to `true`: Indicates that the user acknowledges they are creating a token that will never expire. When `expirationDate` is `null` or empty, the token will never expire. * When set to `false` or not specified (and `expirationDate` is provided): The token will follow normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. | [default to false] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenresponse.md b/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenresponse.md new file mode 100644 index 00000000..cc99a73b --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Createpersonalaccesstokenresponse.md @@ -0,0 +1,26 @@ +--- +id: v1-createpersonalaccesstokenresponse-v1 +title: CreatepersonalaccesstokenresponseV1 +pagination_label: CreatepersonalaccesstokenresponseV1 +sidebar_label: CreatepersonalaccesstokenresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreatepersonalaccesstokenresponseV1', 'v1CreatepersonalaccesstokenresponseV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/createpersonalaccesstokenresponse-v1 +tags: ['SDK', 'Software Development Kit', 'CreatepersonalaccesstokenresponseV1', 'v1CreatepersonalaccesstokenresponseV1'] +--- + +# CreatepersonalaccesstokenresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | [default to undefined] +**secret** | **string** | The secret of the personal access token (to be used as the password for Basic Auth). | [default to undefined] +**scope** | **Array<string>** | Scopes of the personal access token. | [default to undefined] +**name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [default to undefined] +**owner** | **PatownerV1** | | [default to undefined] +**created** | **string** | The date and time, down to the millisecond, when this personal access token was created. | [default to undefined] +**accessTokenValiditySeconds** | **number** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [default to undefined] +**expirationDate** | **string** | Date and time, down to the millisecond, when this personal access token will expire. If not provided, the token will expire 6 months after its creation date. The value must be a valid date-time string between the current date and 6 months from the creation date. | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Errormessagedto.md b/sdk-output/personal_access_tokens/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..62f655f4 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Errorresponsedto.md b/sdk-output/personal_access_tokens/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..5d569553 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Getpersonalaccesstokenresponse.md b/sdk-output/personal_access_tokens/docs/Models/Getpersonalaccesstokenresponse.md new file mode 100644 index 00000000..76202ab8 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Getpersonalaccesstokenresponse.md @@ -0,0 +1,28 @@ +--- +id: v1-getpersonalaccesstokenresponse-v1 +title: GetpersonalaccesstokenresponseV1 +pagination_label: GetpersonalaccesstokenresponseV1 +sidebar_label: GetpersonalaccesstokenresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetpersonalaccesstokenresponseV1', 'v1GetpersonalaccesstokenresponseV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/getpersonalaccesstokenresponse-v1 +tags: ['SDK', 'Software Development Kit', 'GetpersonalaccesstokenresponseV1', 'v1GetpersonalaccesstokenresponseV1'] +--- + +# GetpersonalaccesstokenresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of the personal access token (to be used as the username for Basic Auth). | [default to undefined] +**name** | **string** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [default to undefined] +**scope** | **Array<string>** | Scopes of the personal access token. | [default to undefined] +**owner** | **PatownerV1** | | [default to undefined] +**created** | **string** | The date and time, down to the millisecond, when this personal access token was created. | [default to undefined] +**lastUsed** | **(optional)** **string** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [default to undefined] +**managed** | **(optional)** **boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [default to false] +**accessTokenValiditySeconds** | **(optional)** **number** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [default to 43200] +**expirationDate** | **(optional)** **string** | Date and time, down to the millisecond, when this personal access token will expire. **Important:** When `expirationDate` is `null` or empty, the token will never expire (and `userAwareTokenNeverExpires` will be `true`). When `expirationDate` is provided, this value must be a future date. There is no upper limit on how far in the future the expiration date can be set. | [default to undefined] +**userAwareTokenNeverExpires** | **(optional)** **boolean** | Indicates that the user who created or updated this Personal Access Token is aware of and acknowledges the security implications of creating a token that will never expire. When `true`, this flag confirms that the user understood the security risks associated with non-expiring tokens at the time of creation or update. **Security Awareness:** This field serves as a record that the user acknowledged: * Tokens that never expire pose a greater security risk if compromised * Non-expiring tokens should be used only when necessary and with appropriate security measures * Regular rotation and monitoring of non-expiring tokens is recommended **Behavior:** * When `true`: Indicates that the user acknowledged they were creating a token that will never expire. When `expirationDate` is `null`, the token will never expire. * When `false`: The token follows normal expiration rules based on the `expirationDate` field and `accessTokenValiditySeconds` setting. | [default to false] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Index.md b/sdk-output/personal_access_tokens/docs/Models/Index.md new file mode 100644 index 00000000..e2572303 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: personal_access_tokens-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: personal_access_tokens-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'personal_access_tokens', 'models'] +slug: /tools/sdk/typescript/personal_access_tokens/models +tags: ['SDK', 'Software Development Kit', 'personal_access_tokens', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/personal_access_tokens/docs/Models/Jsonpatchoperation.md b/sdk-output/personal_access_tokens/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..f66b89a0 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/JsonpatchoperationValue.md b/sdk-output/personal_access_tokens/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..cab49742 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1401Response.md b/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1401Response.md new file mode 100644 index 00000000..20b6b328 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-personal-access-tokens-v1401-response-v1 +title: ListPersonalAccessTokensV1401ResponseV1 +pagination_label: ListPersonalAccessTokensV1401ResponseV1 +sidebar_label: ListPersonalAccessTokensV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPersonalAccessTokensV1401ResponseV1', 'v1ListPersonalAccessTokensV1401ResponseV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/list-personal-access-tokens-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPersonalAccessTokensV1401ResponseV1', 'v1ListPersonalAccessTokensV1401ResponseV1'] +--- + +# ListPersonalAccessTokensV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1429Response.md b/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1429Response.md new file mode 100644 index 00000000..353b332b --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/ListPersonalAccessTokensV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-personal-access-tokens-v1429-response-v1 +title: ListPersonalAccessTokensV1429ResponseV1 +pagination_label: ListPersonalAccessTokensV1429ResponseV1 +sidebar_label: ListPersonalAccessTokensV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPersonalAccessTokensV1429ResponseV1', 'v1ListPersonalAccessTokensV1429ResponseV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/list-personal-access-tokens-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPersonalAccessTokensV1429ResponseV1', 'v1ListPersonalAccessTokensV1429ResponseV1'] +--- + +# ListPersonalAccessTokensV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/Localeorigin.md b/sdk-output/personal_access_tokens/docs/Models/Localeorigin.md new file mode 100644 index 00000000..2bab903e --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/personal_access_tokens/docs/Models/Patowner.md b/sdk-output/personal_access_tokens/docs/Models/Patowner.md new file mode 100644 index 00000000..2090cb46 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/Patowner.md @@ -0,0 +1,21 @@ +--- +id: v1-patowner-v1 +title: PatownerV1 +pagination_label: PatownerV1 +sidebar_label: PatownerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PatownerV1', 'v1PatownerV1'] +slug: /tools/sdk/typescript/personal_access_tokens/models/patowner-v1 +tags: ['SDK', 'Software Development Kit', 'PatownerV1', 'v1PatownerV1'] +--- + +# PatownerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Personal access token owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Personal access token owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Personal access token owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/personal_access_tokens/docs/Models/README.md b/sdk-output/personal_access_tokens/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/personal_access_tokens/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/privilege_criteria/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/privilege_criteria/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d2209aac --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,76 @@ +- path: /criteria/v1/privilege + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria/methods/privilege-criteria#create-custom-privilege-criteria-v1 + source: | + import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaV1Api(configuration); + const createprivilegecriteriarequestV1: CreateprivilegecriteriarequestV1 = ; // CreateprivilegecriteriarequestV1 | Create custom privilege criteria request body. + const result = await apiInstance.createCustomPrivilegeCriteriaV1(createprivilegecriteriarequestV1); + console.log(result); +- path: /criteria/v1/privilege/{criteriaId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria/methods/privilege-criteria#delete-custom-privilege-criteria-v1 + source: | + import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaV1Api(configuration); + const criteriaId: string = '6d123044-5834-4e8d-a49f-9c70089b0de1'; // string | The Id of the custom privilege criteria to delete. (default to undefined) + const result = await apiInstance.deleteCustomPrivilegeCriteriaV1(criteriaId); + console.log(result); +- path: /criteria/v1/privilege/{criteriaId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria/methods/privilege-criteria#get-privilege-criteria-v1 + source: | + import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaV1Api(configuration); + const criteriaId: string = '6d123044-5834-4e8d-a49f-9c70089b0de1'; // string | The Id of the privilege criteria record to return. (default to undefined) + const result = await apiInstance.getPrivilegeCriteriaV1(criteriaId); + console.log(result); +- path: /criteria/v1/privilege + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria/methods/privilege-criteria#list-privilege-criteria-v1 + source: | + import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaV1Api(configuration); + const filters: string = 'type eq "CUSTOM" and sourceId eq "c42c45d8d7c04d2da64d215cd8c32f21"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` (default to undefined) + const result = await apiInstance.listPrivilegeCriteriaV1(filters); + console.log(result); +- path: /criteria/v1/privilege/{criteriaId} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria/methods/privilege-criteria#put-custom-privilege-criteria-value-v1 + source: | + import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaV1Api(configuration); + const criteriaId: string = '6d123044-5834-4e8d-a49f-9c70089b0de1'; // string | The Id of the privilege criteria record to return. (default to undefined) + const privilegecriteriadtoV1: PrivilegecriteriadtoV1 = ; // PrivilegecriteriadtoV1 | The new version of the custom privilege criteria. This overwrites the existing privilege criteria. + const result = await apiInstance.putCustomPrivilegeCriteriaValueV1(criteriaId, privilegecriteriadtoV1); + console.log(result); diff --git a/sdk-output/privilege_criteria/docs/Methods/Index.md b/sdk-output/privilege_criteria/docs/Methods/Index.md new file mode 100644 index 00000000..c46bf217 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: privilege_criteria-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: privilege_criteria-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'privilege_criteria', 'methods'] +slug: /tools/sdk/typescript/privilege_criteria/methods +tags: ['SDK', 'Software Development Kit', 'privilege_criteria', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/privilege_criteria/docs/Methods/PrivilegeCriteriaV1Api.md b/sdk-output/privilege_criteria/docs/Methods/PrivilegeCriteriaV1Api.md new file mode 100644 index 00000000..8116283e --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Methods/PrivilegeCriteriaV1Api.md @@ -0,0 +1,217 @@ +--- +id: v1-privilege-criteria +title: PrivilegeCriteria +pagination_label: PrivilegeCriteria +sidebar_label: PrivilegeCriteria +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegeCriteria', 'v1PrivilegeCriteria'] +slug: /tools/sdk/typescript/privilege_criteria/methods/privilege-criteria +tags: ['SDK', 'Software Development Kit', 'PrivilegeCriteria', 'v1PrivilegeCriteria'] +--- + +# PrivilegeCriteriaV1Api + Use this API to create, retrieve, update, and delete privilege criteria. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-custom-privilege-criteria-v1**](#create-custom-privilege-criteria-v1) | **POST** `/criteria/v1/privilege` | Create custom privilege criteria +[**delete-custom-privilege-criteria-v1**](#delete-custom-privilege-criteria-v1) | **DELETE** `/criteria/v1/privilege/{criteriaId}` | Delete privilege criteria +[**get-privilege-criteria-v1**](#get-privilege-criteria-v1) | **GET** `/criteria/v1/privilege/{criteriaId}` | Get privilege criteria +[**list-privilege-criteria-v1**](#list-privilege-criteria-v1) | **GET** `/criteria/v1/privilege` | List privilege criteria +[**put-custom-privilege-criteria-value-v1**](#put-custom-privilege-criteria-value-v1) | **PUT** `/criteria/v1/privilege/{criteriaId}` | Update privilege criteria + + +## create-custom-privilege-criteria-v1 +Create custom privilege criteria +Use this API to create a custom privilege criteria + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-custom-privilege-criteria-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createprivilegecriteriarequestV1** | **CreateprivilegecriteriarequestV1** | Create custom privilege criteria request body. | + +### Return type + +**PrivilegecriteriadtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaV1Api(configuration); +const createprivilegecriteriarequestV1: CreateprivilegecriteriarequestV1 = ; // Create custom privilege criteria request body. +const result = await apiInstance.createCustomPrivilegeCriteriaV1(createprivilegecriteriarequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-custom-privilege-criteria-v1 +Delete privilege criteria +Use this API to delete a specific custom privilege criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-custom-privilege-criteria-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**criteriaId** | **string** | The Id of the custom privilege criteria to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaV1Api(configuration); +const criteriaId: string = 6d123044-5834-4e8d-a49f-9c70089b0de1; // The Id of the custom privilege criteria to delete. +const result = await apiInstance.deleteCustomPrivilegeCriteriaV1(criteriaId); +console.log(result); +``` + +[[Back to top]](#) + +## get-privilege-criteria-v1 +Get privilege criteria +Use this API to get a specific privilege criteria. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-privilege-criteria-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**criteriaId** | **string** | The Id of the privilege criteria record to return. | [default to undefined] + +### Return type + +**PrivilegecriteriadtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaV1Api(configuration); +const criteriaId: string = 6d123044-5834-4e8d-a49f-9c70089b0de1; // The Id of the privilege criteria record to return. +const result = await apiInstance.getPrivilegeCriteriaV1(criteriaId); +console.log(result); +``` + +[[Back to top]](#) + +## list-privilege-criteria-v1 +List privilege criteria +Use this API to list all privilege criteria matching a filter + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-privilege-criteria-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaV1Api(configuration); +const filters: string = type eq "CUSTOM" and sourceId eq "c42c45d8d7c04d2da64d215cd8c32f21"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq \"CUSTOM\" and sourceId eq \"2c91809175e6c63f0175fb5570220569\"` +const result = await apiInstance.listPrivilegeCriteriaV1(filters); +console.log(result); +``` + +[[Back to top]](#) + +## put-custom-privilege-criteria-value-v1 +Update privilege criteria +Use this API to update a specific custom privilege criteria by overwriting the information with new information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-custom-privilege-criteria-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**criteriaId** | **string** | The Id of the privilege criteria record to return. | [default to undefined] +**privilegecriteriadtoV1** | **PrivilegecriteriadtoV1** | The new version of the custom privilege criteria. This overwrites the existing privilege criteria. | + +### Return type + +**PrivilegecriteriadtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaV1Api(configuration); +const criteriaId: string = 6d123044-5834-4e8d-a49f-9c70089b0de1; // The Id of the privilege criteria record to return. +const privilegecriteriadtoV1: PrivilegecriteriadtoV1 = ; // The new version of the custom privilege criteria. This overwrites the existing privilege criteria. +const result = await apiInstance.putCustomPrivilegeCriteriaValueV1(criteriaId, privilegecriteriadtoV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/privilege_criteria/docs/Models/Createprivilegecriteriarequest.md b/sdk-output/privilege_criteria/docs/Models/Createprivilegecriteriarequest.md new file mode 100644 index 00000000..d4fe07b7 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Createprivilegecriteriarequest.md @@ -0,0 +1,23 @@ +--- +id: v1-createprivilegecriteriarequest-v1 +title: CreateprivilegecriteriarequestV1 +pagination_label: CreateprivilegecriteriarequestV1 +sidebar_label: CreateprivilegecriteriarequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateprivilegecriteriarequestV1', 'v1CreateprivilegecriteriarequestV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/createprivilegecriteriarequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreateprivilegecriteriarequestV1', 'v1CreateprivilegecriteriarequestV1'] +--- + +# CreateprivilegecriteriarequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sourceId** | **(optional)** **string** | The Id of the source that the criteria is applied to. | [default to undefined] +**type** | **(optional)** **string** | The type of criteria being created. Expects \"CUSTOM\". | [default to undefined] +**operator** | **(optional)** **string** | The logical operator to apply between groups. | [default to undefined] +**groups** | **(optional)** **Array<CreateprivilegecriteriarequestGroupsInnerV1>** | | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level assigned by this criteria. | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInner.md b/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInner.md new file mode 100644 index 00000000..af96603c --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-createprivilegecriteriarequest-groups-inner-v1 +title: CreateprivilegecriteriarequestGroupsInnerV1 +pagination_label: CreateprivilegecriteriarequestGroupsInnerV1 +sidebar_label: CreateprivilegecriteriarequestGroupsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateprivilegecriteriarequestGroupsInnerV1', 'v1CreateprivilegecriteriarequestGroupsInnerV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/createprivilegecriteriarequest-groups-inner-v1 +tags: ['SDK', 'Software Development Kit', 'CreateprivilegecriteriarequestGroupsInnerV1', 'v1CreateprivilegecriteriarequestGroupsInnerV1'] +--- + +# CreateprivilegecriteriarequestGroupsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | The logical operator to apply between criteria items in the group. | [default to undefined] +**criteriaItems** | **(optional)** **Array<CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1>** | | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInner.md b/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInner.md new file mode 100644 index 00000000..a3bbd8b6 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInner.md @@ -0,0 +1,22 @@ +--- +id: v1-createprivilegecriteriarequest-groups-inner-criteria-items-inner-v1 +title: CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 +pagination_label: CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 +sidebar_label: CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1', 'v1CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/createprivilegecriteriarequest-groups-inner-criteria-items-inner-v1 +tags: ['SDK', 'Software Development Kit', 'CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1', 'v1CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1'] +--- + +# CreateprivilegecriteriarequestGroupsInnerCriteriaItemsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**targetType** | **(optional)** **string** | The target type of the criteria item. | [default to undefined] +**operator** | **(optional)** **string** | | [default to undefined] +**values** | **(optional)** **Array<string>** | The values to evaluate the property against. | [default to undefined] +**ignoreCase** | **(optional)** **boolean** | Whether to ignore case when evaluating the property against the values. | [default to false] + diff --git a/sdk-output/privilege_criteria/docs/Models/Errormessagedto.md b/sdk-output/privilege_criteria/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..ce401eb7 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/Errorresponsedto.md b/sdk-output/privilege_criteria/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..944d405b --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/Index.md b/sdk-output/privilege_criteria/docs/Models/Index.md new file mode 100644 index 00000000..88830542 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: privilege_criteria-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: privilege_criteria-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'privilege_criteria', 'models'] +slug: /tools/sdk/typescript/privilege_criteria/models +tags: ['SDK', 'Software Development Kit', 'privilege_criteria', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1401Response.md b/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1401Response.md new file mode 100644 index 00000000..21b77941 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-privilege-criteria-v1401-response-v1 +title: ListPrivilegeCriteriaV1401ResponseV1 +pagination_label: ListPrivilegeCriteriaV1401ResponseV1 +sidebar_label: ListPrivilegeCriteriaV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPrivilegeCriteriaV1401ResponseV1', 'v1ListPrivilegeCriteriaV1401ResponseV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/list-privilege-criteria-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPrivilegeCriteriaV1401ResponseV1', 'v1ListPrivilegeCriteriaV1401ResponseV1'] +--- + +# ListPrivilegeCriteriaV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1429Response.md b/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1429Response.md new file mode 100644 index 00000000..66b91af9 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/ListPrivilegeCriteriaV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-privilege-criteria-v1429-response-v1 +title: ListPrivilegeCriteriaV1429ResponseV1 +pagination_label: ListPrivilegeCriteriaV1429ResponseV1 +sidebar_label: ListPrivilegeCriteriaV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListPrivilegeCriteriaV1429ResponseV1', 'v1ListPrivilegeCriteriaV1429ResponseV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/list-privilege-criteria-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListPrivilegeCriteriaV1429ResponseV1', 'v1ListPrivilegeCriteriaV1429ResponseV1'] +--- + +# ListPrivilegeCriteriaV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/Localeorigin.md b/sdk-output/privilege_criteria/docs/Models/Localeorigin.md new file mode 100644 index 00000000..33bd3f34 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/privilege_criteria/docs/Models/Privilegecriteriadto.md b/sdk-output/privilege_criteria/docs/Models/Privilegecriteriadto.md new file mode 100644 index 00000000..0db7daeb --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/Privilegecriteriadto.md @@ -0,0 +1,24 @@ +--- +id: v1-privilegecriteriadto-v1 +title: PrivilegecriteriadtoV1 +pagination_label: PrivilegecriteriadtoV1 +sidebar_label: PrivilegecriteriadtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegecriteriadtoV1', 'v1PrivilegecriteriadtoV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/privilegecriteriadto-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegecriteriadtoV1', 'v1PrivilegecriteriadtoV1'] +--- + +# PrivilegecriteriadtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The Id of the criteria. | [default to undefined] +**sourceId** | **(optional)** **string** | The Id of the source that the criteria is applied to. | [default to undefined] +**type** | **(optional)** **string** | The type of criteria. | [default to undefined] +**operator** | **(optional)** **string** | The logical operator to apply between groups. | [default to undefined] +**groups** | **(optional)** **Array<PrivilegecriteriadtoGroupsInnerV1>** | | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level assigned by this criteria. | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInner.md b/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInner.md new file mode 100644 index 00000000..3bc62ff9 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-privilegecriteriadto-groups-inner-v1 +title: PrivilegecriteriadtoGroupsInnerV1 +pagination_label: PrivilegecriteriadtoGroupsInnerV1 +sidebar_label: PrivilegecriteriadtoGroupsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegecriteriadtoGroupsInnerV1', 'v1PrivilegecriteriadtoGroupsInnerV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/privilegecriteriadto-groups-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegecriteriadtoGroupsInnerV1', 'v1PrivilegecriteriadtoGroupsInnerV1'] +--- + +# PrivilegecriteriadtoGroupsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | The logical operator to apply between criteria items in the group. | [default to undefined] +**criteriaItems** | **(optional)** **Array<PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1>** | | [default to undefined] + diff --git a/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInnerCriteriaItemsInner.md b/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInnerCriteriaItemsInner.md new file mode 100644 index 00000000..6cf54d65 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/PrivilegecriteriadtoGroupsInnerCriteriaItemsInner.md @@ -0,0 +1,23 @@ +--- +id: v1-privilegecriteriadto-groups-inner-criteria-items-inner-v1 +title: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 +pagination_label: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 +sidebar_label: PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1', 'v1PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1'] +slug: /tools/sdk/typescript/privilege_criteria/models/privilegecriteriadto-groups-inner-criteria-items-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1', 'v1PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1'] +--- + +# PrivilegecriteriadtoGroupsInnerCriteriaItemsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**targetType** | **(optional)** **string** | The target type for the criteria item. | [default to undefined] +**operator** | **(optional)** **string** | The operator to apply to the property and values. | [default to undefined] +**property** | **(optional)** **string** | | [default to undefined] +**values** | **(optional)** **Array<string>** | The values to evaluate the property against. | [default to undefined] +**ignoreCase** | **(optional)** **boolean** | Whether to ignore case when evaluating the property against the values. | [default to false] + diff --git a/sdk-output/privilege_criteria/docs/Models/README.md b/sdk-output/privilege_criteria/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/privilege_criteria/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/privilege_criteria_configuration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/privilege_criteria_configuration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..1e831171 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,46 @@ +- path: /criteria-config/v1/privilege/{criteriaConfigId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria_configuration/methods/privilege-criteria-configuration#get-privilege-criteria-config-v1 + source: | + import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); + const criteriaConfigId: string = '6d123044-5834-4e8d-a49f-9c70089b0de1'; // string | The Id of the privilege criteria configuration record to retrieve. (default to undefined) + const result = await apiInstance.getPrivilegeCriteriaConfigV1(criteriaConfigId); + console.log(result); +- path: /criteria-config/v1/privilege + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria_configuration/methods/privilege-criteria-configuration#list-privilege-criteria-config-v1 + source: | + import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); + const filters: string = 'sourceId eq "c42c45d8d7c04d2da64d215cd8c32f21"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` (default to undefined) + const result = await apiInstance.listPrivilegeCriteriaConfigV1(filters); + console.log(result); +- path: /criteria-config/v1/privilege/{criteriaConfigId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/privilege_criteria_configuration/methods/privilege-criteria-configuration#patch-privilege-criteria-config-v1 + source: | + import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); + const criteriaConfigId: string = '6d123044-5834-4e8d-a49f-9c70089b0de1'; // string | The Id of the privilege criteria configuration to update. (default to undefined) + const requestBody: Array<object> = [{"op":"replace","path":"/config/privilegeClassificationMode","value":"SINGLE_PRIVILEGE_LEVEL"},{"op":"replace","path":"/config/criteriaPrivilegeLevel/connectorMediumEnabled","value":true}]; // Array | A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + const result = await apiInstance.patchPrivilegeCriteriaConfigV1(criteriaConfigId, requestBody); + console.log(result); diff --git a/sdk-output/privilege_criteria_configuration/docs/Methods/Index.md b/sdk-output/privilege_criteria_configuration/docs/Methods/Index.md new file mode 100644 index 00000000..67afd57c --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: privilege_criteria_configuration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: privilege_criteria_configuration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'privilege_criteria_configuration', 'methods'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/methods +tags: ['SDK', 'Software Development Kit', 'privilege_criteria_configuration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationV1Api.md b/sdk-output/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationV1Api.md new file mode 100644 index 00000000..d6519680 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationV1Api.md @@ -0,0 +1,165 @@ +--- +id: v1-privilege-criteria-configuration +title: PrivilegeCriteriaConfiguration +pagination_label: PrivilegeCriteriaConfiguration +sidebar_label: PrivilegeCriteriaConfiguration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegeCriteriaConfiguration', 'v1PrivilegeCriteriaConfiguration'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/methods/privilege-criteria-configuration +tags: ['SDK', 'Software Development Kit', 'PrivilegeCriteriaConfiguration', 'v1PrivilegeCriteriaConfiguration'] +--- + +# PrivilegeCriteriaConfigurationV1Api + Use this API to manage the configuration of privilege criteria. + +**globalPrivilegeLevelEnabled**: Boolean flag indicating whether privilege classification is enabled. + + +**privilegeClassificationMode**: Enum specifying the mode (CRITERIA_PRIVILEGE_LEVEL, SINGLE_PRIVILEGE_LEVEL) to use for privilege classification. CRITERIA_PRIVILEGE_LEVEL mode uses criteria to determine privilege levels, while SINGLE_PRIVILEGE_LEVEL assigns the same privilege level to all enititlements based on the value of singlePrivilegeLevel.privilegeLevel. + + +**singlePrivilegeLevel.privilegeLevel**: Enum specifying the privilege level (HIGH, MEDIUM, LOW) to assign to all privileges when the privilege classification mode is SINGLE_PRIVILEGE_LEVEL. + + +**criteriaPrivilegeLevel.connectorHighEnabled**: Boolean flag indicating whether HIGH level connector criteria is used for privilege classification. + + +**criteriaPrivilegeLevel.connectorMediumEnabled**: Boolean flag indicating whether MEDIUM level connector criteria is used for privilege classification. + + +**criteriaPrivilegeLevel.connectorLowEnabled**: Boolean flag indicating whether LOW level connector criteria is used for privilege classification. + + +**criteriaPrivilegeLevel.customHighEnabled**: Boolean flag indicating whether HIGH level custom criteria is used for privilege classification. + + +**criteriaPrivilegeLevel.customMediumEnabled**: Boolean flag indicating whether MEDIUM level custom criteria is used for privilege classification. + + +**criteriaPrivilegeLevel.customLowEnabled**: Boolean flag indicating whether LOW level custom criteria is used for privilege classification. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-privilege-criteria-config-v1**](#get-privilege-criteria-config-v1) | **GET** `/criteria-config/v1/privilege/{criteriaConfigId}` | Get privilege criteria config +[**list-privilege-criteria-config-v1**](#list-privilege-criteria-config-v1) | **GET** `/criteria-config/v1/privilege` | List privilege criteria config +[**patch-privilege-criteria-config-v1**](#patch-privilege-criteria-config-v1) | **PATCH** `/criteria-config/v1/privilege/{criteriaConfigId}` | Update privilege criteria configuration + + +## get-privilege-criteria-config-v1 +Get privilege criteria config +Use this API to get the privilege criteria configuration by Id. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-privilege-criteria-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**criteriaConfigId** | **string** | The Id of the privilege criteria configuration record to retrieve. | [default to undefined] + +### Return type + +**PrivilegecriteriaconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); +const criteriaConfigId: string = 6d123044-5834-4e8d-a49f-9c70089b0de1; // The Id of the privilege criteria configuration record to retrieve. +const result = await apiInstance.getPrivilegeCriteriaConfigV1(criteriaConfigId); +console.log(result); +``` + +[[Back to top]](#) + +## list-privilege-criteria-config-v1 +List privilege criteria config +Use this API to list the privilege criteria configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-privilege-criteria-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); +const filters: string = sourceId eq "c42c45d8d7c04d2da64d215cd8c32f21"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=sourceId eq \"2c91809175e6c63f0175fb5570220569\"` +const result = await apiInstance.listPrivilegeCriteriaConfigV1(filters); +console.log(result); +``` + +[[Back to top]](#) + +## patch-privilege-criteria-config-v1 +Update privilege criteria configuration +Use this API to update the privilege criteria configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-privilege-criteria-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**criteriaConfigId** | **string** | The Id of the privilege criteria configuration to update. | [default to undefined] +**requestBody** | **Array<object>** | A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. | + +### Return type + +**PrivilegecriteriaconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { PrivilegeCriteriaConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PrivilegeCriteriaConfigurationV1Api(configuration); +const criteriaConfigId: string = 6d123044-5834-4e8d-a49f-9c70089b0de1; // The Id of the privilege criteria configuration to update. +const requestBody: Array<object> = [{"op":"replace","path":"/config/privilegeClassificationMode","value":"SINGLE_PRIVILEGE_LEVEL"},{"op":"replace","path":"/config/criteriaPrivilegeLevel/connectorMediumEnabled","value":true}]; // A list of criteria configuration operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +const result = await apiInstance.patchPrivilegeCriteriaConfigV1(criteriaConfigId, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/Errormessagedto.md b/sdk-output/privilege_criteria_configuration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..17499d0c --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/Errorresponsedto.md b/sdk-output/privilege_criteria_configuration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f16cc52e --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1401Response.md b/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1401Response.md new file mode 100644 index 00000000..362ccb2b --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-privilege-criteria-config-v1401-response-v1 +title: GetPrivilegeCriteriaConfigV1401ResponseV1 +pagination_label: GetPrivilegeCriteriaConfigV1401ResponseV1 +sidebar_label: GetPrivilegeCriteriaConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPrivilegeCriteriaConfigV1401ResponseV1', 'v1GetPrivilegeCriteriaConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/get-privilege-criteria-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPrivilegeCriteriaConfigV1401ResponseV1', 'v1GetPrivilegeCriteriaConfigV1401ResponseV1'] +--- + +# GetPrivilegeCriteriaConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1429Response.md b/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1429Response.md new file mode 100644 index 00000000..c70f6fa2 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/GetPrivilegeCriteriaConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-privilege-criteria-config-v1429-response-v1 +title: GetPrivilegeCriteriaConfigV1429ResponseV1 +pagination_label: GetPrivilegeCriteriaConfigV1429ResponseV1 +sidebar_label: GetPrivilegeCriteriaConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPrivilegeCriteriaConfigV1429ResponseV1', 'v1GetPrivilegeCriteriaConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/get-privilege-criteria-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPrivilegeCriteriaConfigV1429ResponseV1', 'v1GetPrivilegeCriteriaConfigV1429ResponseV1'] +--- + +# GetPrivilegeCriteriaConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/Index.md b/sdk-output/privilege_criteria_configuration/docs/Models/Index.md new file mode 100644 index 00000000..a3beb143 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: privilege_criteria_configuration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: privilege_criteria_configuration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'privilege_criteria_configuration', 'models'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models +tags: ['SDK', 'Software Development Kit', 'privilege_criteria_configuration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/Localeorigin.md b/sdk-output/privilege_criteria_configuration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..420a347c --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/Privilegecriteriaconfigdto.md b/sdk-output/privilege_criteria_configuration/docs/Models/Privilegecriteriaconfigdto.md new file mode 100644 index 00000000..9af77294 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/Privilegecriteriaconfigdto.md @@ -0,0 +1,23 @@ +--- +id: v1-privilegecriteriaconfigdto-v1 +title: PrivilegecriteriaconfigdtoV1 +pagination_label: PrivilegecriteriaconfigdtoV1 +sidebar_label: PrivilegecriteriaconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegecriteriaconfigdtoV1', 'v1PrivilegecriteriaconfigdtoV1'] +slug: /tools/sdk/typescript/privilege_criteria_configuration/models/privilegecriteriaconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegecriteriaconfigdtoV1', 'v1PrivilegecriteriaconfigdtoV1'] +--- + +# PrivilegecriteriaconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The Id of the task which is executing the bulk update. | [default to undefined] +**sourceId** | **(optional)** **string** | The Id of the source that the criteria configuration is applied to. | [default to undefined] +**config** | **(optional)** **object** | The configuration settings for privilege criteria evaluation. | [default to undefined] +**created** | **(optional)** **string** | The date and time when the privilege criteria configuration was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time when the privilege criteria configuration was last modified. | [default to undefined] + diff --git a/sdk-output/privilege_criteria_configuration/docs/Models/README.md b/sdk-output/privilege_criteria_configuration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/privilege_criteria_configuration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/prompt_insights/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/prompt_insights/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..beb1220f --- /dev/null +++ b/sdk-output/prompt_insights/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,33 @@ +- path: /prompt-insights/v1/metrics + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/prompt_insights/methods/prompt-insights#get-prompt-insights-metrics-v1 + source: | + import { PromptInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PromptInsightsV1Api(configuration); + const interval: string = '-7d'; // '-1h' | '-1d' | '-7d' | '-30d' | Relative lookback window for metrics aggregation. (default to undefined) + const result = await apiInstance.getPromptInsightsMetricsV1(interval); + console.log(result); +- path: /prompt-insights/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/prompt_insights/methods/prompt-insights#list-prompt-insights-v1 + source: | + import { PromptInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PromptInsightsV1Api(configuration); + const interval: string = '-30d'; // '-1h' | '-1d' | '-7d' | '-30d' | Relative lookback window for prompt insights. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'policyDecision eq "REDACTED" and severity eq "CRITICAL"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* (optional) (default to undefined) + const result = await apiInstance.listPromptInsightsV1(interval); + console.log(result); diff --git a/sdk-output/prompt_insights/docs/Methods/Index.md b/sdk-output/prompt_insights/docs/Methods/Index.md new file mode 100644 index 00000000..ff6b0978 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: prompt_insights-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: prompt_insights-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'prompt_insights', 'methods'] +slug: /tools/sdk/typescript/prompt_insights/methods +tags: ['SDK', 'Software Development Kit', 'prompt_insights', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/prompt_insights/docs/Methods/PromptInsightsV1Api.md b/sdk-output/prompt_insights/docs/Methods/PromptInsightsV1Api.md new file mode 100644 index 00000000..4328aa48 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Methods/PromptInsightsV1Api.md @@ -0,0 +1,111 @@ +--- +id: v1-prompt-insights +title: PromptInsights +pagination_label: PromptInsights +sidebar_label: PromptInsights +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PromptInsights', 'v1PromptInsights'] +slug: /tools/sdk/typescript/prompt_insights/methods/prompt-insights +tags: ['SDK', 'Software Development Kit', 'PromptInsights', 'v1PromptInsights'] +--- + +# PromptInsightsV1Api + Use this API to retrieve prompt security insights and aggregate metrics for AI agent prompt activity. +With this functionality in place, administrators can review prompt events and their policy decisions, +filter insights by policy decision, category, severity, and other attributes, and view summary metrics +for scanned and redacted prompts over configurable time windows. + +Policy decisions indicate whether a prompt was allowed or redacted. Insight categories include anomalies, +data uploads, and MCP tool calls. Supported filter fields include policy decision, category, severity, +user, agent, reason, rule, and policy. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-prompt-insights-metrics-v1**](#get-prompt-insights-metrics-v1) | **GET** `/prompt-insights/v1/metrics` | Get prompt insights metrics +[**list-prompt-insights-v1**](#list-prompt-insights-v1) | **GET** `/prompt-insights/v1` | List prompt insights + + +## get-prompt-insights-metrics-v1 +Get prompt insights metrics +Returns aggregate prompt insights metrics for the requested time window. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-prompt-insights-metrics-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**interval** | **'-1h' | '-1d' | '-7d' | '-30d'** | Relative lookback window for metrics aggregation. | [default to undefined] + +### Return type + +**PromptinsightsmetricsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PromptInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PromptInsightsV1Api(configuration); +const interval: string = -7d; // Relative lookback window for metrics aggregation. +const result = await apiInstance.getPromptInsightsMetricsV1(interval); +console.log(result); +``` + +[[Back to top]](#) + +## list-prompt-insights-v1 +List prompt insights +Returns a paginated list of prompt insights within a lookback window, with optional structured filters. Results are sorted by timestamp descending (most recent first). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-prompt-insights-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**interval** | **'-1h' | '-1d' | '-7d' | '-30d'** | Relative lookback window for prompt insights. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PromptInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PromptInsightsV1Api(configuration); +const interval: string = -30d; // Relative lookback window for prompt insights. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = policyDecision eq "REDACTED" and severity eq "CRITICAL"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **policyDecision**: *eq* **category**: *eq* **severity**: *eq* **user**: *eq, sw, co* **agent**: *eq, sw, co* **reason**: *eq, sw, co* **rule**: *eq, sw, co* **policy**: *eq, sw, co* (optional) +const result = await apiInstance.listPromptInsightsV1(interval); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/prompt_insights/docs/Models/Errormessagedto.md b/sdk-output/prompt_insights/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..97dc2fdc --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/prompt_insights/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/Errorresponsedto.md b/sdk-output/prompt_insights/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..7d282b7c --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/prompt_insights/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1401Response.md b/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1401Response.md new file mode 100644 index 00000000..e35fb913 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-prompt-insights-metrics-v1401-response-v1 +title: GetPromptInsightsMetricsV1401ResponseV1 +pagination_label: GetPromptInsightsMetricsV1401ResponseV1 +sidebar_label: GetPromptInsightsMetricsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPromptInsightsMetricsV1401ResponseV1', 'v1GetPromptInsightsMetricsV1401ResponseV1'] +slug: /tools/sdk/typescript/prompt_insights/models/get-prompt-insights-metrics-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPromptInsightsMetricsV1401ResponseV1', 'v1GetPromptInsightsMetricsV1401ResponseV1'] +--- + +# GetPromptInsightsMetricsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1429Response.md b/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1429Response.md new file mode 100644 index 00000000..e7ce8eed --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/GetPromptInsightsMetricsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-prompt-insights-metrics-v1429-response-v1 +title: GetPromptInsightsMetricsV1429ResponseV1 +pagination_label: GetPromptInsightsMetricsV1429ResponseV1 +sidebar_label: GetPromptInsightsMetricsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPromptInsightsMetricsV1429ResponseV1', 'v1GetPromptInsightsMetricsV1429ResponseV1'] +slug: /tools/sdk/typescript/prompt_insights/models/get-prompt-insights-metrics-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPromptInsightsMetricsV1429ResponseV1', 'v1GetPromptInsightsMetricsV1429ResponseV1'] +--- + +# GetPromptInsightsMetricsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/Index.md b/sdk-output/prompt_insights/docs/Models/Index.md new file mode 100644 index 00000000..04484dc5 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: prompt_insights-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: prompt_insights-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'prompt_insights', 'models'] +slug: /tools/sdk/typescript/prompt_insights/models +tags: ['SDK', 'Software Development Kit', 'prompt_insights', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/prompt_insights/docs/Models/Localeorigin.md b/sdk-output/prompt_insights/docs/Models/Localeorigin.md new file mode 100644 index 00000000..1623cbf1 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/prompt_insights/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/prompt_insights/docs/Models/Promptinsight.md b/sdk-output/prompt_insights/docs/Models/Promptinsight.md new file mode 100644 index 00000000..64d1d187 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Promptinsight.md @@ -0,0 +1,27 @@ +--- +id: v1-promptinsight-v1 +title: PromptinsightV1 +pagination_label: PromptinsightV1 +sidebar_label: PromptinsightV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PromptinsightV1', 'v1PromptinsightV1'] +slug: /tools/sdk/typescript/prompt_insights/models/promptinsight-v1 +tags: ['SDK', 'Software Development Kit', 'PromptinsightV1', 'v1PromptinsightV1'] +--- + +# PromptinsightV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timestamp** | **(optional)** **string** | Event time in UTC. | [default to undefined] +**user** | **(optional)** **string** | User identifier or display name. | [default to undefined] +**agent** | **(optional)** **string** | The AI agent that processed the prompt. | [default to undefined] +**policyDecision** | **(optional)** **string** | The policy decision applied to the prompt. | [default to undefined] +**category** | **(optional)** **string** | The category of the prompt security finding. | [default to undefined] +**severity** | **(optional)** **string** | The severity of the prompt security finding. | [default to undefined] +**reason** | **(optional)** **string** | Human-readable or structured reason for the policy decision. | [default to undefined] +**rule** | **(optional)** **string** | The rule that matched the prompt. | [default to undefined] +**policy** | **(optional)** **string** | The policy that matched the prompt. | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/Promptinsightsmetrics.md b/sdk-output/prompt_insights/docs/Models/Promptinsightsmetrics.md new file mode 100644 index 00000000..a1c0be08 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/Promptinsightsmetrics.md @@ -0,0 +1,20 @@ +--- +id: v1-promptinsightsmetrics-v1 +title: PromptinsightsmetricsV1 +pagination_label: PromptinsightsmetricsV1 +sidebar_label: PromptinsightsmetricsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PromptinsightsmetricsV1', 'v1PromptinsightsmetricsV1'] +slug: /tools/sdk/typescript/prompt_insights/models/promptinsightsmetrics-v1 +tags: ['SDK', 'Software Development Kit', 'PromptinsightsmetricsV1', 'v1PromptinsightsmetricsV1'] +--- + +# PromptinsightsmetricsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**promptsScanned** | **(optional)** **number** | Count of prompts scanned in the interval. | [default to undefined] +**promptsRedacted** | **(optional)** **number** | Count of prompts redacted in the interval. | [default to undefined] + diff --git a/sdk-output/prompt_insights/docs/Models/README.md b/sdk-output/prompt_insights/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/prompt_insights/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/public_identities/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/public_identities/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..dab19af0 --- /dev/null +++ b/sdk-output/public_identities/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,20 @@ +- path: /public-identities/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/public_identities/methods/public-identities#get-public-identities-v1 + source: | + import { PublicIdentitiesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PublicIdentitiesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'firstname eq "John"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) (default to undefined) + const addCoreFilters: boolean = false; // boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to false) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const result = await apiInstance.getPublicIdentitiesV1(); + console.log(result); diff --git a/sdk-output/public_identities/docs/Methods/Index.md b/sdk-output/public_identities/docs/Methods/Index.md new file mode 100644 index 00000000..5ec5933b --- /dev/null +++ b/sdk-output/public_identities/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: public_identities-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: public_identities-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'public_identities', 'methods'] +slug: /tools/sdk/typescript/public_identities/methods +tags: ['SDK', 'Software Development Kit', 'public_identities', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/public_identities/docs/Methods/PublicIdentitiesV1Api.md b/sdk-output/public_identities/docs/Methods/PublicIdentitiesV1Api.md new file mode 100644 index 00000000..e1ae66ff --- /dev/null +++ b/sdk-output/public_identities/docs/Methods/PublicIdentitiesV1Api.md @@ -0,0 +1,71 @@ +--- +id: v1-public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicIdentities', 'v1PublicIdentities'] +slug: /tools/sdk/typescript/public_identities/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'v1PublicIdentities'] +--- + +# PublicIdentitiesV1Api + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v2025/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identities-v1**](#get-public-identities-v1) | **GET** `/public-identities/v1` | Get list of public identities + + +## get-public-identities-v1 +Get list of public identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-public-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* | [optional] [default to undefined] +**addCoreFilters** | **boolean** | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PublicIdentitiesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PublicIdentitiesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = firstname eq "John"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) +const addCoreFilters: boolean = false; // If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be \"spadmin\" or \"cloudadmin\". - uid should not be null. - lastname should not be null. - email should not be null. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const result = await apiInstance.getPublicIdentitiesV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/public_identities/docs/Models/Dtotype.md b/sdk-output/public_identities/docs/Models/Dtotype.md new file mode 100644 index 00000000..49dd0c3f --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/public_identities/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/public_identities/docs/Models/Errormessagedto.md b/sdk-output/public_identities/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..08aba584 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/public_identities/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/Errorresponsedto.md b/sdk-output/public_identities/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..9e81a616 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/public_identities/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1401Response.md b/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1401Response.md new file mode 100644 index 00000000..95a3b302 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-public-identities-v1401-response-v1 +title: GetPublicIdentitiesV1401ResponseV1 +pagination_label: GetPublicIdentitiesV1401ResponseV1 +sidebar_label: GetPublicIdentitiesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPublicIdentitiesV1401ResponseV1', 'v1GetPublicIdentitiesV1401ResponseV1'] +slug: /tools/sdk/typescript/public_identities/models/get-public-identities-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPublicIdentitiesV1401ResponseV1', 'v1GetPublicIdentitiesV1401ResponseV1'] +--- + +# GetPublicIdentitiesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1429Response.md b/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1429Response.md new file mode 100644 index 00000000..5ac5ea46 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/GetPublicIdentitiesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-public-identities-v1429-response-v1 +title: GetPublicIdentitiesV1429ResponseV1 +pagination_label: GetPublicIdentitiesV1429ResponseV1 +sidebar_label: GetPublicIdentitiesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPublicIdentitiesV1429ResponseV1', 'v1GetPublicIdentitiesV1429ResponseV1'] +slug: /tools/sdk/typescript/public_identities/models/get-public-identities-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPublicIdentitiesV1429ResponseV1', 'v1GetPublicIdentitiesV1429ResponseV1'] +--- + +# GetPublicIdentitiesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/Identityreference.md b/sdk-output/public_identities/docs/Models/Identityreference.md new file mode 100644 index 00000000..d13ef1c8 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Identityreference.md @@ -0,0 +1,21 @@ +--- +id: v1-identityreference-v1 +title: IdentityreferenceV1 +pagination_label: IdentityreferenceV1 +sidebar_label: IdentityreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +slug: /tools/sdk/typescript/public_identities/models/identityreference-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +--- + +# IdentityreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/Index.md b/sdk-output/public_identities/docs/Models/Index.md new file mode 100644 index 00000000..c0c0f7aa --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: public_identities-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: public_identities-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'public_identities', 'models'] +slug: /tools/sdk/typescript/public_identities/models +tags: ['SDK', 'Software Development Kit', 'public_identities', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/public_identities/docs/Models/Localeorigin.md b/sdk-output/public_identities/docs/Models/Localeorigin.md new file mode 100644 index 00000000..59157ca1 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/public_identities/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/public_identities/docs/Models/Publicidentity.md b/sdk-output/public_identities/docs/Models/Publicidentity.md new file mode 100644 index 00000000..af68d1d1 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/Publicidentity.md @@ -0,0 +1,26 @@ +--- +id: v1-publicidentity-v1 +title: PublicidentityV1 +pagination_label: PublicidentityV1 +sidebar_label: PublicidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityV1', 'v1PublicidentityV1'] +slug: /tools/sdk/typescript/public_identities/models/publicidentity-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityV1', 'v1PublicidentityV1'] +--- + +# PublicidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] +**alias** | **(optional)** **string** | Alternate unique identifier for the identity. | [default to undefined] +**email** | **(optional)** **string** | Email address of identity. | [default to undefined] +**status** | **(optional)** **string** | The lifecycle status for the identity | [default to undefined] +**identityState** | **(optional)** **string** | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [default to undefined] +**manager** | **(optional)** **IdentityreferenceV1** | | [default to undefined] +**attributes** | **(optional)** **Array<PublicidentityAttributesInnerV1>** | The public identity attributes of the identity | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/PublicidentityAttributesInner.md b/sdk-output/public_identities/docs/Models/PublicidentityAttributesInner.md new file mode 100644 index 00000000..1f9a482d --- /dev/null +++ b/sdk-output/public_identities/docs/Models/PublicidentityAttributesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-publicidentity-attributes-inner-v1 +title: PublicidentityAttributesInnerV1 +pagination_label: PublicidentityAttributesInnerV1 +sidebar_label: PublicidentityAttributesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityAttributesInnerV1', 'v1PublicidentityAttributesInnerV1'] +slug: /tools/sdk/typescript/public_identities/models/publicidentity-attributes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityAttributesInnerV1', 'v1PublicidentityAttributesInnerV1'] +--- + +# PublicidentityAttributesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The attribute key | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the attribute | [default to undefined] +**value** | **(optional)** **string** | The attribute value | [default to undefined] + diff --git a/sdk-output/public_identities/docs/Models/README.md b/sdk-output/public_identities/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/public_identities/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/public_identities_config/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/public_identities_config/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..54a2503f --- /dev/null +++ b/sdk-output/public_identities_config/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,29 @@ +- path: /public-identities-config/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/public_identities_config/methods/public-identities-config#get-public-identity-config-v1 + source: | + import { PublicIdentitiesConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PublicIdentitiesConfigV1Api(configuration); + const result = await apiInstance.getPublicIdentityConfigV1(); + console.log(result); +- path: /public-identities-config/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/public_identities_config/methods/public-identities-config#update-public-identity-config-v1 + source: | + import { PublicIdentitiesConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new PublicIdentitiesConfigV1Api(configuration); + const publicidentityconfigV1: PublicidentityconfigV1 = ; // PublicidentityconfigV1 | + const result = await apiInstance.updatePublicIdentityConfigV1(publicidentityconfigV1); + console.log(result); diff --git a/sdk-output/public_identities_config/docs/Methods/Index.md b/sdk-output/public_identities_config/docs/Methods/Index.md new file mode 100644 index 00000000..954f421e --- /dev/null +++ b/sdk-output/public_identities_config/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: public_identities_config-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: public_identities_config-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'public_identities_config', 'methods'] +slug: /tools/sdk/typescript/public_identities_config/methods +tags: ['SDK', 'Software Development Kit', 'public_identities_config', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/public_identities_config/docs/Methods/PublicIdentitiesConfigV1Api.md b/sdk-output/public_identities_config/docs/Methods/PublicIdentitiesConfigV1Api.md new file mode 100644 index 00000000..990eca7f --- /dev/null +++ b/sdk-output/public_identities_config/docs/Methods/PublicIdentitiesConfigV1Api.md @@ -0,0 +1,103 @@ +--- +id: v1-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicIdentitiesConfig', 'v1PublicIdentitiesConfig'] +slug: /tools/sdk/typescript/public_identities_config/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'v1PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfigV1Api + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v2025/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-public-identity-config-v1**](#get-public-identity-config-v1) | **GET** `/public-identities-config/v1` | Get the public identities configuration +[**update-public-identity-config-v1**](#update-public-identity-config-v1) | **PUT** `/public-identities-config/v1` | Update the public identities configuration + + +## get-public-identity-config-v1 +Get the public identities configuration +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-public-identity-config-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**PublicidentityconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { PublicIdentitiesConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PublicIdentitiesConfigV1Api(configuration); +const result = await apiInstance.getPublicIdentityConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-public-identity-config-v1 +Update the public identities configuration +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-public-identity-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**publicidentityconfigV1** | **PublicidentityconfigV1** | | + +### Return type + +**PublicidentityconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { PublicIdentitiesConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new PublicIdentitiesConfigV1Api(configuration); +const publicidentityconfigV1: PublicidentityconfigV1 = ; // +const result = await apiInstance.updatePublicIdentityConfigV1(publicidentityconfigV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/public_identities_config/docs/Models/Dtotype.md b/sdk-output/public_identities_config/docs/Models/Dtotype.md new file mode 100644 index 00000000..61da4b95 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/public_identities_config/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/public_identities_config/docs/Models/Errormessagedto.md b/sdk-output/public_identities_config/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..563df69b --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/public_identities_config/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/Errorresponsedto.md b/sdk-output/public_identities_config/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..5a155482 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/public_identities_config/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1401Response.md b/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1401Response.md new file mode 100644 index 00000000..e9d6fdce --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-public-identity-config-v1401-response-v1 +title: GetPublicIdentityConfigV1401ResponseV1 +pagination_label: GetPublicIdentityConfigV1401ResponseV1 +sidebar_label: GetPublicIdentityConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPublicIdentityConfigV1401ResponseV1', 'v1GetPublicIdentityConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/public_identities_config/models/get-public-identity-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPublicIdentityConfigV1401ResponseV1', 'v1GetPublicIdentityConfigV1401ResponseV1'] +--- + +# GetPublicIdentityConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1429Response.md b/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1429Response.md new file mode 100644 index 00000000..e8313b2f --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/GetPublicIdentityConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-public-identity-config-v1429-response-v1 +title: GetPublicIdentityConfigV1429ResponseV1 +pagination_label: GetPublicIdentityConfigV1429ResponseV1 +sidebar_label: GetPublicIdentityConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetPublicIdentityConfigV1429ResponseV1', 'v1GetPublicIdentityConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/public_identities_config/models/get-public-identity-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetPublicIdentityConfigV1429ResponseV1', 'v1GetPublicIdentityConfigV1429ResponseV1'] +--- + +# GetPublicIdentityConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/Identityreference.md b/sdk-output/public_identities_config/docs/Models/Identityreference.md new file mode 100644 index 00000000..d64a559a --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Identityreference.md @@ -0,0 +1,21 @@ +--- +id: v1-identityreference-v1 +title: IdentityreferenceV1 +pagination_label: IdentityreferenceV1 +sidebar_label: IdentityreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +slug: /tools/sdk/typescript/public_identities_config/models/identityreference-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferenceV1', 'v1IdentityreferenceV1'] +--- + +# IdentityreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/Index.md b/sdk-output/public_identities_config/docs/Models/Index.md new file mode 100644 index 00000000..b9375fc1 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: public_identities_config-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: public_identities_config-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'public_identities_config', 'models'] +slug: /tools/sdk/typescript/public_identities_config/models +tags: ['SDK', 'Software Development Kit', 'public_identities_config', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/public_identities_config/docs/Models/Localeorigin.md b/sdk-output/public_identities_config/docs/Models/Localeorigin.md new file mode 100644 index 00000000..7a21ea71 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/public_identities_config/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/public_identities_config/docs/Models/Publicidentityattributeconfig.md b/sdk-output/public_identities_config/docs/Models/Publicidentityattributeconfig.md new file mode 100644 index 00000000..07aaf7ff --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Publicidentityattributeconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-publicidentityattributeconfig-v1 +title: PublicidentityattributeconfigV1 +pagination_label: PublicidentityattributeconfigV1 +sidebar_label: PublicidentityattributeconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityattributeconfigV1', 'v1PublicidentityattributeconfigV1'] +slug: /tools/sdk/typescript/public_identities_config/models/publicidentityattributeconfig-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityattributeconfigV1', 'v1PublicidentityattributeconfigV1'] +--- + +# PublicidentityattributeconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | The attribute key | [default to undefined] +**name** | **(optional)** **string** | The attribute display name | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/Publicidentityconfig.md b/sdk-output/public_identities_config/docs/Models/Publicidentityconfig.md new file mode 100644 index 00000000..47f6b5c7 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/Publicidentityconfig.md @@ -0,0 +1,21 @@ +--- +id: v1-publicidentityconfig-v1 +title: PublicidentityconfigV1 +pagination_label: PublicidentityconfigV1 +sidebar_label: PublicidentityconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PublicidentityconfigV1', 'v1PublicidentityconfigV1'] +slug: /tools/sdk/typescript/public_identities_config/models/publicidentityconfig-v1 +tags: ['SDK', 'Software Development Kit', 'PublicidentityconfigV1', 'v1PublicidentityconfigV1'] +--- + +# PublicidentityconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<PublicidentityattributeconfigV1>** | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [default to undefined] +**modified** | **(optional)** **string** | When this configuration was last modified. | [default to undefined] +**modifiedBy** | **(optional)** **IdentityreferenceV1** | | [default to undefined] + diff --git a/sdk-output/public_identities_config/docs/Models/README.md b/sdk-output/public_identities_config/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/public_identities_config/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/reports_data_extraction/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/reports_data_extraction/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..909eb69f --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,64 @@ +- path: /reports/v1/{id}/cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/reports_data_extraction/methods/reports-data-extraction#cancel-report-v1 + source: | + import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ReportsDataExtractionV1Api(configuration); + const id: string = 'a1ed223247144cc29d23c632624b4767'; // string | ID of the running Report to cancel (default to undefined) + const result = await apiInstance.cancelReportV1(id); + console.log(result); +- path: /reports/v1/{taskResultId}/result + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/reports_data_extraction/methods/reports-data-extraction#get-report-result-v1 + source: | + import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ReportsDataExtractionV1Api(configuration); + const taskResultId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Unique identifier of the task result which handled report (default to undefined) + const completed: boolean = true; // boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to false) + const result = await apiInstance.getReportResultV1(taskResultId); + console.log(result); +- path: /reports/v1/{taskResultId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/reports_data_extraction/methods/reports-data-extraction#get-report-v1 + source: | + import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ReportsDataExtractionV1Api(configuration); + const taskResultId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Unique identifier of the task result which handled report (default to undefined) + const fileFormat: string = 'csv'; // 'csv' | 'pdf' | Output format of the requested report file (default to undefined) + const name: string = 'Identities Details Report'; // string | preferred Report file name, by default will be used report name from task result. (optional) (default to undefined) + const auditable: boolean = true; // boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to false) + const result = await apiInstance.getReportV1(taskResultId, fileFormat); + console.log(result); +- path: /reports/v1/run + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/reports_data_extraction/methods/reports-data-extraction#start-report-v1 + source: | + import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ReportsDataExtractionV1Api(configuration); + const reportdetailsV1: ReportdetailsV1 = ; // ReportdetailsV1 | + const result = await apiInstance.startReportV1(reportdetailsV1); + console.log(result); diff --git a/sdk-output/reports_data_extraction/docs/Methods/Index.md b/sdk-output/reports_data_extraction/docs/Methods/Index.md new file mode 100644 index 00000000..116411f6 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: reports_data_extraction-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: reports_data_extraction-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'reports_data_extraction', 'methods'] +slug: /tools/sdk/typescript/reports_data_extraction/methods +tags: ['SDK', 'Software Development Kit', 'reports_data_extraction', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/reports_data_extraction/docs/Methods/ReportsDataExtractionV1Api.md b/sdk-output/reports_data_extraction/docs/Methods/ReportsDataExtractionV1Api.md new file mode 100644 index 00000000..ea50ed59 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Methods/ReportsDataExtractionV1Api.md @@ -0,0 +1,186 @@ +--- +id: v1-reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportsDataExtraction', 'v1ReportsDataExtraction'] +slug: /tools/sdk/typescript/reports_data_extraction/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'v1ReportsDataExtraction'] +--- + +# ReportsDataExtractionV1Api + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-report-v1**](#cancel-report-v1) | **POST** `/reports/v1/{id}/cancel` | Cancel report +[**get-report-result-v1**](#get-report-result-v1) | **GET** `/reports/v1/{taskResultId}/result` | Get report result +[**get-report-v1**](#get-report-v1) | **GET** `/reports/v1/{taskResultId}` | Get report file +[**start-report-v1**](#start-report-v1) | **POST** `/reports/v1/run` | Run report + + +## cancel-report-v1 +Cancel report +Cancels a running report. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the running Report to cancel | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ReportsDataExtractionV1Api(configuration); +const id: string = a1ed223247144cc29d23c632624b4767; // ID of the running Report to cancel +const result = await apiInstance.cancelReportV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-report-result-v1 +Get report result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-report-result-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**taskResultId** | **string** | Unique identifier of the task result which handled report | [default to undefined] +**completed** | **boolean** | state of task result to apply ordering when results are fetching from the DB | [optional] [default to false] + +### Return type + +**ReportresultsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ReportsDataExtractionV1Api(configuration); +const taskResultId: string = ef38f94347e94562b5bb8424a56397d8; // Unique identifier of the task result which handled report +const completed: boolean = true; // state of task result to apply ordering when results are fetching from the DB (optional) +const result = await apiInstance.getReportResultV1(taskResultId); +console.log(result); +``` + +[[Back to top]](#) + +## get-report-v1 +Get report file +Gets a report in file format. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**taskResultId** | **string** | Unique identifier of the task result which handled report | [default to undefined] +**fileFormat** | **'csv' | 'pdf'** | Output format of the requested report file | [default to undefined] +**name** | **string** | preferred Report file name, by default will be used report name from task result. | [optional] [default to undefined] +**auditable** | **boolean** | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. | [optional] [default to false] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example + +```typescript +import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ReportsDataExtractionV1Api(configuration); +const taskResultId: string = ef38f94347e94562b5bb8424a56397d8; // Unique identifier of the task result which handled report +const fileFormat: string = csv; // Output format of the requested report file +const name: string = Identities Details Report; // preferred Report file name, by default will be used report name from task result. (optional) +const auditable: boolean = true; // Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) +const result = await apiInstance.getReportV1(taskResultId, fileFormat); +console.log(result); +``` + +[[Back to top]](#) + +## start-report-v1 +Run report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reportdetailsV1** | **ReportdetailsV1** | | + +### Return type + +**TaskresultdetailsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ReportsDataExtractionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ReportsDataExtractionV1Api(configuration); +const reportdetailsV1: ReportdetailsV1 = ; // +const result = await apiInstance.startReportV1(reportdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/reports_data_extraction/docs/Models/AccountsExportReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/AccountsExportReportArguments.md new file mode 100644 index 00000000..a1619e3d --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/AccountsExportReportArguments.md @@ -0,0 +1,20 @@ +--- +id: v1-accounts-export-report-arguments-v1 +title: AccountsExportReportArgumentsV1 +pagination_label: AccountsExportReportArgumentsV1 +sidebar_label: AccountsExportReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsExportReportArgumentsV1', 'v1AccountsExportReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/accounts-export-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArgumentsV1', 'v1AccountsExportReportArgumentsV1'] +--- + +# AccountsExportReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **string** | Source ID. | [default to undefined] +**sourceName** | **string** | Source name. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/Errormessagedto.md b/sdk-output/reports_data_extraction/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..c5eef155 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/Errorresponsedto.md b/sdk-output/reports_data_extraction/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e53520b8 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1401Response.md b/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1401Response.md new file mode 100644 index 00000000..bbb4838f --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-report-result-v1401-response-v1 +title: GetReportResultV1401ResponseV1 +pagination_label: GetReportResultV1401ResponseV1 +sidebar_label: GetReportResultV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetReportResultV1401ResponseV1', 'v1GetReportResultV1401ResponseV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/get-report-result-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetReportResultV1401ResponseV1', 'v1GetReportResultV1401ResponseV1'] +--- + +# GetReportResultV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1429Response.md b/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1429Response.md new file mode 100644 index 00000000..917e1f1c --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/GetReportResultV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-report-result-v1429-response-v1 +title: GetReportResultV1429ResponseV1 +pagination_label: GetReportResultV1429ResponseV1 +sidebar_label: GetReportResultV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetReportResultV1429ResponseV1', 'v1GetReportResultV1429ResponseV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/get-report-result-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetReportResultV1429ResponseV1', 'v1GetReportResultV1429ResponseV1'] +--- + +# GetReportResultV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/IdentitiesDetailsReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 00000000..9d576170 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,19 @@ +--- +id: v1-identities-details-report-arguments-v1 +title: IdentitiesDetailsReportArgumentsV1 +pagination_label: IdentitiesDetailsReportArgumentsV1 +sidebar_label: IdentitiesDetailsReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitiesDetailsReportArgumentsV1', 'v1IdentitiesDetailsReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/identities-details-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArgumentsV1', 'v1IdentitiesDetailsReportArgumentsV1'] +--- + +# IdentitiesDetailsReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlatedOnly** | **boolean** | Flag to specify if only correlated identities are included in report. | [default to false] + diff --git a/sdk-output/reports_data_extraction/docs/Models/IdentitiesReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/IdentitiesReportArguments.md new file mode 100644 index 00000000..2a3918f2 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/IdentitiesReportArguments.md @@ -0,0 +1,19 @@ +--- +id: v1-identities-report-arguments-v1 +title: IdentitiesReportArgumentsV1 +pagination_label: IdentitiesReportArgumentsV1 +sidebar_label: IdentitiesReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitiesReportArgumentsV1', 'v1IdentitiesReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/identities-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArgumentsV1', 'v1IdentitiesReportArgumentsV1'] +--- + +# IdentitiesReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**correlatedOnly** | **(optional)** **boolean** | Flag to specify if only correlated identities are included in report. | [default to false] + diff --git a/sdk-output/reports_data_extraction/docs/Models/IdentityProfileIdentityErrorReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 00000000..bfd9b306 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,19 @@ +--- +id: v1-identity-profile-identity-error-report-arguments-v1 +title: IdentityProfileIdentityErrorReportArgumentsV1 +pagination_label: IdentityProfileIdentityErrorReportArgumentsV1 +sidebar_label: IdentityProfileIdentityErrorReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityProfileIdentityErrorReportArgumentsV1', 'v1IdentityProfileIdentityErrorReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/identity-profile-identity-error-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArgumentsV1', 'v1IdentityProfileIdentityErrorReportArgumentsV1'] +--- + +# IdentityProfileIdentityErrorReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authoritativeSource** | **string** | Source ID. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/Index.md b/sdk-output/reports_data_extraction/docs/Models/Index.md new file mode 100644 index 00000000..764daa43 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: reports_data_extraction-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: reports_data_extraction-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'reports_data_extraction', 'models'] +slug: /tools/sdk/typescript/reports_data_extraction/models +tags: ['SDK', 'Software Development Kit', 'reports_data_extraction', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/reports_data_extraction/docs/Models/Localeorigin.md b/sdk-output/reports_data_extraction/docs/Models/Localeorigin.md new file mode 100644 index 00000000..4a89e086 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/reports_data_extraction/docs/Models/OrphanIdentitiesReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 00000000..32342458 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,19 @@ +--- +id: v1-orphan-identities-report-arguments-v1 +title: OrphanIdentitiesReportArgumentsV1 +pagination_label: OrphanIdentitiesReportArgumentsV1 +sidebar_label: OrphanIdentitiesReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OrphanIdentitiesReportArgumentsV1', 'v1OrphanIdentitiesReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/orphan-identities-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArgumentsV1', 'v1OrphanIdentitiesReportArgumentsV1'] +--- + +# OrphanIdentitiesReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selectedFormats** | **(optional)** **Array<string>** | Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/README.md b/sdk-output/reports_data_extraction/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/reports_data_extraction/docs/Models/Reportdetails.md b/sdk-output/reports_data_extraction/docs/Models/Reportdetails.md new file mode 100644 index 00000000..0606b756 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Reportdetails.md @@ -0,0 +1,20 @@ +--- +id: v1-reportdetails-v1 +title: ReportdetailsV1 +pagination_label: ReportdetailsV1 +sidebar_label: ReportdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportdetailsV1', 'v1ReportdetailsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/reportdetails-v1 +tags: ['SDK', 'Software Development Kit', 'ReportdetailsV1', 'v1ReportdetailsV1'] +--- + +# ReportdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reportType** | **(optional)** **string** | Use this property to define what report should be processed in the RDE service. | [default to undefined] +**arguments** | **(optional)** **ReportdetailsArgumentsV1** | | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/ReportdetailsArguments.md b/sdk-output/reports_data_extraction/docs/Models/ReportdetailsArguments.md new file mode 100644 index 00000000..dffb04a1 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/ReportdetailsArguments.md @@ -0,0 +1,27 @@ +--- +id: v1-reportdetails-arguments-v1 +title: ReportdetailsArgumentsV1 +pagination_label: ReportdetailsArgumentsV1 +sidebar_label: ReportdetailsArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportdetailsArgumentsV1', 'v1ReportdetailsArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/reportdetails-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'ReportdetailsArgumentsV1', 'v1ReportdetailsArgumentsV1'] +--- + +# ReportdetailsArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application** | **string** | Source ID. | [default to undefined] +**sourceName** | **string** | Source name. | [default to undefined] +**correlatedOnly** | **boolean** | Flag to specify if only correlated identities are included in report. | [default to false] +**authoritativeSource** | **string** | Source ID. | [default to undefined] +**selectedFormats** | **(optional)** **Array<string>** | Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. | [default to undefined] +**indices** | **(optional)** **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [default to undefined] +**query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**columns** | **(optional)** **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/Reportresults.md b/sdk-output/reports_data_extraction/docs/Models/Reportresults.md new file mode 100644 index 00000000..7b129d77 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Reportresults.md @@ -0,0 +1,26 @@ +--- +id: v1-reportresults-v1 +title: ReportresultsV1 +pagination_label: ReportresultsV1 +sidebar_label: ReportresultsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportresultsV1', 'v1ReportresultsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/reportresults-v1 +tags: ['SDK', 'Software Development Kit', 'ReportresultsV1', 'v1ReportresultsV1'] +--- + +# ReportresultsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reportType** | **(optional)** **string** | Use this property to define what report should be processed in the RDE service. | [default to undefined] +**taskDefName** | **(optional)** **string** | Name of the task definition which is started to process requesting report. Usually the same as report name | [default to undefined] +**id** | **(optional)** **string** | Unique task definition identifier. | [default to undefined] +**created** | **(optional)** **string** | Report processing start date | [default to undefined] +**status** | **(optional)** **string** | Report current state or result status. | [default to undefined] +**duration** | **(optional)** **number** | Report processing time in ms. | [default to undefined] +**rows** | **(optional)** **number** | Report size in rows. | [default to undefined] +**availableFormats** | **(optional)** **Array<string>** | Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/SearchExportReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/SearchExportReportArguments.md new file mode 100644 index 00000000..14f4fbdf --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/SearchExportReportArguments.md @@ -0,0 +1,22 @@ +--- +id: v1-search-export-report-arguments-v1 +title: SearchExportReportArgumentsV1 +pagination_label: SearchExportReportArgumentsV1 +sidebar_label: SearchExportReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchExportReportArgumentsV1', 'v1SearchExportReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/search-export-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArgumentsV1', 'v1SearchExportReportArgumentsV1'] +--- + +# SearchExportReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | **(optional)** **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [default to undefined] +**query** | **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**columns** | **(optional)** **string** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/Taskresultdetails.md b/sdk-output/reports_data_extraction/docs/Models/Taskresultdetails.md new file mode 100644 index 00000000..8e668b8d --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/Taskresultdetails.md @@ -0,0 +1,32 @@ +--- +id: v1-taskresultdetails-v1 +title: TaskresultdetailsV1 +pagination_label: TaskresultdetailsV1 +sidebar_label: TaskresultdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdetailsV1', 'v1TaskresultdetailsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/taskresultdetails-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdetailsV1', 'v1TaskresultdetailsV1'] +--- + +# TaskresultdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [default to undefined] +**id** | **(optional)** **string** | Unique task definition identifier. | [default to undefined] +**reportType** | **(optional)** **string** | Use this property to define what report should be processed in the RDE service. | [default to undefined] +**description** | **(optional)** **string** | Description of the report purpose and/or contents. | [default to undefined] +**parentName** | **(optional)** **string** | Name of the parent task/report if exists. | [default to undefined] +**launcher** | **(optional)** **string** | Name of the report processing initiator. | [default to undefined] +**created** | **(optional)** **string** | Report creation date | [default to undefined] +**launched** | **(optional)** **string** | Report start date | [default to undefined] +**completed** | **(optional)** **string** | Report completion date | [default to undefined] +**completionStatus** | **(optional)** **string** | Report completion status. | [default to undefined] +**messages** | **(optional)** **Array<TaskresultdetailsMessagesInnerV1>** | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [default to undefined] +**returns** | **(optional)** **Array<TaskresultdetailsReturnsInnerV1>** | Task definition results, if necessary. | [default to undefined] +**attributes** | **(optional)** **object** | Extra attributes map(dictionary) needed for the report. | [default to undefined] +**progress** | **(optional)** **string** | Current report state. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsMessagesInner.md b/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsMessagesInner.md new file mode 100644 index 00000000..2a2aa58d --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsMessagesInner.md @@ -0,0 +1,23 @@ +--- +id: v1-taskresultdetails-messages-inner-v1 +title: TaskresultdetailsMessagesInnerV1 +pagination_label: TaskresultdetailsMessagesInnerV1 +sidebar_label: TaskresultdetailsMessagesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdetailsMessagesInnerV1', 'v1TaskresultdetailsMessagesInnerV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/taskresultdetails-messages-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdetailsMessagesInnerV1', 'v1TaskresultdetailsMessagesInnerV1'] +--- + +# TaskresultdetailsMessagesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the message. | [default to undefined] +**error** | **(optional)** **boolean** | Flag whether message is an error. | [default to false] +**warning** | **(optional)** **boolean** | Flag whether message is a warning. | [default to false] +**key** | **(optional)** **string** | Message string identifier. | [default to undefined] +**localizedText** | **(optional)** **string** | Message context with the locale based language. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsReturnsInner.md b/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsReturnsInner.md new file mode 100644 index 00000000..089a9281 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/TaskresultdetailsReturnsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-taskresultdetails-returns-inner-v1 +title: TaskresultdetailsReturnsInnerV1 +pagination_label: TaskresultdetailsReturnsInnerV1 +sidebar_label: TaskresultdetailsReturnsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdetailsReturnsInnerV1', 'v1TaskresultdetailsReturnsInnerV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/taskresultdetails-returns-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdetailsReturnsInnerV1', 'v1TaskresultdetailsReturnsInnerV1'] +--- + +# TaskresultdetailsReturnsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayLabel** | **(optional)** **string** | Attribute description. | [default to undefined] +**attributeName** | **(optional)** **string** | System or database attribute name. | [default to undefined] + diff --git a/sdk-output/reports_data_extraction/docs/Models/UncorrelatedAccountsReportArguments.md b/sdk-output/reports_data_extraction/docs/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 00000000..2e7c1cb8 --- /dev/null +++ b/sdk-output/reports_data_extraction/docs/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,19 @@ +--- +id: v1-uncorrelated-accounts-report-arguments-v1 +title: UncorrelatedAccountsReportArgumentsV1 +pagination_label: UncorrelatedAccountsReportArgumentsV1 +sidebar_label: UncorrelatedAccountsReportArgumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UncorrelatedAccountsReportArgumentsV1', 'v1UncorrelatedAccountsReportArgumentsV1'] +slug: /tools/sdk/typescript/reports_data_extraction/models/uncorrelated-accounts-report-arguments-v1 +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArgumentsV1', 'v1UncorrelatedAccountsReportArgumentsV1'] +--- + +# UncorrelatedAccountsReportArgumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**selectedFormats** | **(optional)** **Array<string>** | Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/requestable_objects/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d6a34c6d --- /dev/null +++ b/sdk-output/requestable_objects/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,23 @@ +- path: /requestable-objects/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/requestable_objects/methods/requestable-objects#list-requestable-objects-v1 + source: | + import { RequestableObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RequestableObjectsV1Api(configuration); + const identityId: string = 'e7eab60924f64aa284175b9fa3309599'; // string | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) (default to undefined) + const types: Array<'ACCESS_PROFILE' | 'ROLE'> = ACCESS_PROFILE,ROLE; // Array<'ACCESS_PROFILE' | 'ROLE'> | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) (default to undefined) + const term: string = 'Finance Role'; // string | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) (default to undefined) + const statuses: Array<RequestableobjectrequeststatusV1> = ["ASSIGNED","PENDING"]; // Array | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name sw "bob"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const result = await apiInstance.listRequestableObjectsV1(); + console.log(result); diff --git a/sdk-output/requestable_objects/docs/Methods/Index.md b/sdk-output/requestable_objects/docs/Methods/Index.md new file mode 100644 index 00000000..c7064583 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: requestable_objects-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: requestable_objects-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'requestable_objects', 'methods'] +slug: /tools/sdk/typescript/requestable_objects/methods +tags: ['SDK', 'Software Development Kit', 'requestable_objects', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/requestable_objects/docs/Methods/RequestableObjectsV1Api.md b/sdk-output/requestable_objects/docs/Methods/RequestableObjectsV1Api.md new file mode 100644 index 00000000..d9d177a3 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Methods/RequestableObjectsV1Api.md @@ -0,0 +1,79 @@ +--- +id: v1-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableObjects', 'v1RequestableObjects'] +slug: /tools/sdk/typescript/requestable_objects/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'v1RequestableObjects'] +--- + +# RequestableObjectsV1Api + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v2025/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**list-requestable-objects-v1**](#list-requestable-objects-v1) | **GET** `/requestable-objects/v1` | Requestable objects list + + +## list-requestable-objects-v1 +Requestable objects list +Get a list of acccess items that can be requested through the [Access Request endpoints](https://developer.sailpoint.com/docs/api/v2024/access-requests). Access items are marked with `AVAILABLE`, `PENDING` or `ASSIGNED` with respect to the identity provided using `identity-id` query parameter. +This endpoint only lists roles and access profiles. For gathering requestable entitlements, the [Entitlements List API](https://developer.sailpoint.com/docs/api/v2025/list-entitlements) can be used with the segmented-for-identity parameter. +Any authenticated token can call this endpoint to see their requestable access items. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-requestable-objects-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. | [optional] [default to undefined] +**types** | **Array<string>** | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. | [optional] [default to undefined] +**term** | **string** | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. | [optional] [default to undefined] +**statuses** | **Array<RequestableobjectrequeststatusV1>** | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RequestableObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RequestableObjectsV1Api(configuration); +const identityId: string = e7eab60924f64aa284175b9fa3309599; // If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) +const types: Array<'ACCESS_PROFILE' | 'ROLE'> = ACCESS_PROFILE,ROLE; // Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional) +const term: string = Finance Role; // Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional) +const statuses: Array<RequestableobjectrequeststatusV1> = ["ASSIGNED","PENDING"]; // Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses in the future without notice. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name sw "bob"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const result = await apiInstance.listRequestableObjectsV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/requestable_objects/docs/Models/Errormessagedto.md b/sdk-output/requestable_objects/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..020c36d2 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/requestable_objects/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/Errorresponsedto.md b/sdk-output/requestable_objects/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..66723e79 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/requestable_objects/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/Identityreferencewithnameandemail.md b/sdk-output/requestable_objects/docs/Models/Identityreferencewithnameandemail.md new file mode 100644 index 00000000..8a77ca40 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Identityreferencewithnameandemail.md @@ -0,0 +1,22 @@ +--- +id: v1-identityreferencewithnameandemail-v1 +title: IdentityreferencewithnameandemailV1 +pagination_label: IdentityreferencewithnameandemailV1 +sidebar_label: IdentityreferencewithnameandemailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +slug: /tools/sdk/typescript/requestable_objects/models/identityreferencewithnameandemail-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityreferencewithnameandemailV1', 'v1IdentityreferencewithnameandemailV1'] +--- + +# IdentityreferencewithnameandemailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type can only be IDENTITY. This is read-only. | [default to undefined] +**id** | **(optional)** **string** | Identity ID. | [default to undefined] +**name** | **(optional)** **string** | Identity\'s human-readable display name. This is read-only. | [default to undefined] +**email** | **(optional)** **string** | Identity\'s email address. This is read-only. | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/Index.md b/sdk-output/requestable_objects/docs/Models/Index.md new file mode 100644 index 00000000..16903885 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: requestable_objects-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: requestable_objects-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'requestable_objects', 'models'] +slug: /tools/sdk/typescript/requestable_objects/models +tags: ['SDK', 'Software Development Kit', 'requestable_objects', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1401Response.md b/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1401Response.md new file mode 100644 index 00000000..1e42aaee --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-requestable-objects-v1401-response-v1 +title: ListRequestableObjectsV1401ResponseV1 +pagination_label: ListRequestableObjectsV1401ResponseV1 +sidebar_label: ListRequestableObjectsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListRequestableObjectsV1401ResponseV1', 'v1ListRequestableObjectsV1401ResponseV1'] +slug: /tools/sdk/typescript/requestable_objects/models/list-requestable-objects-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListRequestableObjectsV1401ResponseV1', 'v1ListRequestableObjectsV1401ResponseV1'] +--- + +# ListRequestableObjectsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1429Response.md b/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1429Response.md new file mode 100644 index 00000000..c9a27353 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/ListRequestableObjectsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-requestable-objects-v1429-response-v1 +title: ListRequestableObjectsV1429ResponseV1 +pagination_label: ListRequestableObjectsV1429ResponseV1 +sidebar_label: ListRequestableObjectsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListRequestableObjectsV1429ResponseV1', 'v1ListRequestableObjectsV1429ResponseV1'] +slug: /tools/sdk/typescript/requestable_objects/models/list-requestable-objects-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListRequestableObjectsV1429ResponseV1', 'v1ListRequestableObjectsV1429ResponseV1'] +--- + +# ListRequestableObjectsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/Localeorigin.md b/sdk-output/requestable_objects/docs/Models/Localeorigin.md new file mode 100644 index 00000000..f64a8764 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/requestable_objects/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/requestable_objects/docs/Models/README.md b/sdk-output/requestable_objects/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/requestable_objects/docs/Models/Requestableobject.md b/sdk-output/requestable_objects/docs/Models/Requestableobject.md new file mode 100644 index 00000000..97bf8fbb --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Requestableobject.md @@ -0,0 +1,28 @@ +--- +id: v1-requestableobject-v1 +title: RequestableobjectV1 +pagination_label: RequestableobjectV1 +sidebar_label: RequestableobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableobjectV1', 'v1RequestableobjectV1'] +slug: /tools/sdk/typescript/requestable_objects/models/requestableobject-v1 +tags: ['SDK', 'Software Development Kit', 'RequestableobjectV1', 'v1RequestableobjectV1'] +--- + +# RequestableobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the requestable object itself | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the requestable object | [default to undefined] +**created** | **(optional)** **string** | The time when the requestable object was created | [default to undefined] +**modified** | **(optional)** **string** | The time when the requestable object was last modified | [default to undefined] +**description** | **(optional)** **string** | Description of the requestable object. | [default to undefined] +**type** | **(optional)** **RequestableobjecttypeV1** | | [default to undefined] +**requestStatus** | **(optional)** **RequestableobjectrequeststatusV1** | | [default to undefined] +**identityRequestId** | **(optional)** **string** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [default to undefined] +**ownerRef** | **(optional)** **IdentityreferencewithnameandemailV1** | | [default to undefined] +**requestCommentsRequired** | **(optional)** **boolean** | Whether the requester must provide comments when requesting the object. | [default to undefined] + diff --git a/sdk-output/requestable_objects/docs/Models/Requestableobjectrequeststatus.md b/sdk-output/requestable_objects/docs/Models/Requestableobjectrequeststatus.md new file mode 100644 index 00000000..eb5142c7 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Requestableobjectrequeststatus.md @@ -0,0 +1,23 @@ +--- +id: v1-requestableobjectrequeststatus-v1 +title: RequestableobjectrequeststatusV1 +pagination_label: RequestableobjectrequeststatusV1 +sidebar_label: RequestableobjectrequeststatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableobjectrequeststatusV1', 'v1RequestableobjectrequeststatusV1'] +slug: /tools/sdk/typescript/requestable_objects/models/requestableobjectrequeststatus-v1 +tags: ['SDK', 'Software Development Kit', 'RequestableobjectrequeststatusV1', 'v1RequestableobjectrequeststatusV1'] +--- + +# RequestableobjectrequeststatusV1 + +## Enum + + +* `Available` (value: `'AVAILABLE'`) + +* `Pending` (value: `'PENDING'`) + +* `Assigned` (value: `'ASSIGNED'`) + + diff --git a/sdk-output/requestable_objects/docs/Models/Requestableobjecttype.md b/sdk-output/requestable_objects/docs/Models/Requestableobjecttype.md new file mode 100644 index 00000000..441f4f63 --- /dev/null +++ b/sdk-output/requestable_objects/docs/Models/Requestableobjecttype.md @@ -0,0 +1,23 @@ +--- +id: v1-requestableobjecttype-v1 +title: RequestableobjecttypeV1 +pagination_label: RequestableobjecttypeV1 +sidebar_label: RequestableobjecttypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestableobjecttypeV1', 'v1RequestableobjecttypeV1'] +slug: /tools/sdk/typescript/requestable_objects/models/requestableobjecttype-v1 +tags: ['SDK', 'Software Development Kit', 'RequestableobjecttypeV1', 'v1RequestableobjecttypeV1'] +--- + +# RequestableobjecttypeV1 + +## Enum + + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `Role` (value: `'ROLE'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + + diff --git a/sdk-output/role_insights/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/role_insights/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..0941de74 --- /dev/null +++ b/sdk-output/role_insights/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,158 @@ +- path: /role-insights/v1/requests + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#create-role-insight-requests-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createRoleInsightRequestsV1(); + console.log(result); +- path: /role-insights/v1/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#download-role-insights-entitlements-changes-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const insightId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insight id (default to undefined) + const sorters: string = 'identitiesWithAccess'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) (default to undefined) + const filters: string = 'name sw "r"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.downloadRoleInsightsEntitlementsChangesV1(insightId); + console.log(result); +- path: /role-insights/v1/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-entitlement-changes-identities-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const insightId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insight id (default to undefined) + const entitlementId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The entitlement id (default to undefined) + const hasEntitlement: boolean = true; // boolean | Identity has this entitlement or not (optional) (default to false) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const filters: string = 'name sw "Jan"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getEntitlementChangesIdentitiesV1(insightId, entitlementId); + console.log(result); +- path: /role-insights/v1/{insightId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insight-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const insightId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insight id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightV1(insightId); + console.log(result); +- path: /role-insights/v1/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insights-current-entitlements-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const insightId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insight id (default to undefined) + const filters: string = 'name sw "r"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightsCurrentEntitlementsV1(insightId); + console.log(result); +- path: /role-insights/v1/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insights-entitlements-changes-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const insightId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insight id (default to undefined) + const sorters: string = 'sorters_example'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) (default to undefined) + const filters: string = 'name sw "Admin"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightsEntitlementsChangesV1(insightId); + console.log(result); +- path: /role-insights/v1/requests/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insights-requests-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const id: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | The role insights request id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightsRequestsV1(id); + console.log(result); +- path: /role-insights/v1/summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insights-summary-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightsSummaryV1(); + console.log(result); +- path: /role-insights/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_insights/methods/role-insights#get-role-insights-v1 + source: | + import { RoleInsightsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RoleInsightsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'numberOfUpdates'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) (default to undefined) + const filters: string = 'name sw "John"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleInsightsV1(); + console.log(result); diff --git a/sdk-output/role_insights/docs/Methods/Index.md b/sdk-output/role_insights/docs/Methods/Index.md new file mode 100644 index 00000000..52fc837e --- /dev/null +++ b/sdk-output/role_insights/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: role_insights-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: role_insights-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'role_insights', 'methods'] +slug: /tools/sdk/typescript/role_insights/methods +tags: ['SDK', 'Software Development Kit', 'role_insights', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/role_insights/docs/Methods/RoleInsightsV1Api.md b/sdk-output/role_insights/docs/Methods/RoleInsightsV1Api.md new file mode 100644 index 00000000..deb13768 --- /dev/null +++ b/sdk-output/role_insights/docs/Methods/RoleInsightsV1Api.md @@ -0,0 +1,449 @@ +--- +id: v1-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleInsights', 'v1RoleInsights'] +slug: /tools/sdk/typescript/role_insights/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'v1RoleInsights'] +--- + +# RoleInsightsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-insight-requests-v1**](#create-role-insight-requests-v1) | **POST** `/role-insights/v1/requests` | Generate insights for roles +[**download-role-insights-entitlements-changes-v1**](#download-role-insights-entitlements-changes-v1) | **GET** `/role-insights/v1/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**get-entitlement-changes-identities-v1**](#get-entitlement-changes-identities-v1) | **GET** `/role-insights/v1/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**get-role-insight-v1**](#get-role-insight-v1) | **GET** `/role-insights/v1/{insightId}` | Get a single role insight +[**get-role-insights-current-entitlements-v1**](#get-role-insights-current-entitlements-v1) | **GET** `/role-insights/v1/{insightId}/current-entitlements` | Get current entitlement for a role +[**get-role-insights-entitlements-changes-v1**](#get-role-insights-entitlements-changes-v1) | **GET** `/role-insights/v1/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**get-role-insights-requests-v1**](#get-role-insights-requests-v1) | **GET** `/role-insights/v1/requests/{id}` | Returns metadata from prior request. +[**get-role-insights-summary-v1**](#get-role-insights-summary-v1) | **GET** `/role-insights/v1/summary` | Get role insights summary information +[**get-role-insights-v1**](#get-role-insights-v1) | **GET** `/role-insights/v1` | Get role insights + + +## create-role-insight-requests-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Generate insights for roles +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-role-insight-requests-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleinsightsresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createRoleInsightRequestsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## download-role-insights-entitlements-changes-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Download entitlement insights for a role +This endpoint returns the entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/download-role-insights-entitlements-changes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**insightId** | **string** | The role insight id | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**string** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const insightId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insight id +const sorters: string = identitiesWithAccess; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) +const filters: string = name sw "r"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.downloadRoleInsightsEntitlementsChangesV1(insightId); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlement-changes-identities-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get identities for a suggested entitlement (for a role) +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlement-changes-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**insightId** | **string** | The role insight id | [default to undefined] +**entitlementId** | **string** | The entitlement id | [default to undefined] +**hasEntitlement** | **boolean** | Identity has this entitlement or not | [optional] [default to false] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const insightId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insight id +const entitlementId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The entitlement id +const hasEntitlement: boolean = true; // Identity has this entitlement or not (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const filters: string = name sw "Jan"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getEntitlementChangesIdentitiesV1(insightId, entitlementId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insight-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get a single role insight +This endpoint gets role insights information for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insight-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**insightId** | **string** | The role insight id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleinsightV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const insightId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insight id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightV1(insightId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insights-current-entitlements-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get current entitlement for a role +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insights-current-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**insightId** | **string** | The role insight id | [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const insightId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insight id +const filters: string = name sw "r"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightsCurrentEntitlementsV1(insightId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insights-entitlements-changes-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get entitlement insights for a role +This endpoint returns entitlement insights for a role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insights-entitlements-changes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**insightId** | **string** | The role insight id | [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const insightId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insight id +const sorters: string = sorters_example; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) +const filters: string = name sw "Admin"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightsEntitlementsChangesV1(insightId); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insights-requests-v1 +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Returns metadata from prior request. +This endpoint returns details of a prior role insights request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insights-requests-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The role insights request id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleinsightsresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const id: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role insights request id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightsRequestsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insights-summary-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get role insights summary information +This method returns high level summary information for role insights for a customer. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insights-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RoleinsightssummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightsSummaryV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-insights-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get role insights +This method returns detailed role insights for each role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-insights-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RoleInsightsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RoleInsightsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = numberOfUpdates; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) +const filters: string = name sw "John"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleInsightsV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1401Response.md b/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1401Response.md new file mode 100644 index 00000000..2e2f92e6 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-create-role-insight-requests-v1401-response-v1 +title: CreateRoleInsightRequestsV1401ResponseV1 +pagination_label: CreateRoleInsightRequestsV1401ResponseV1 +sidebar_label: CreateRoleInsightRequestsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateRoleInsightRequestsV1401ResponseV1', 'v1CreateRoleInsightRequestsV1401ResponseV1'] +slug: /tools/sdk/typescript/role_insights/models/create-role-insight-requests-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateRoleInsightRequestsV1401ResponseV1', 'v1CreateRoleInsightRequestsV1401ResponseV1'] +--- + +# CreateRoleInsightRequestsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1429Response.md b/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1429Response.md new file mode 100644 index 00000000..8fc7c991 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/CreateRoleInsightRequestsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-create-role-insight-requests-v1429-response-v1 +title: CreateRoleInsightRequestsV1429ResponseV1 +pagination_label: CreateRoleInsightRequestsV1429ResponseV1 +sidebar_label: CreateRoleInsightRequestsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateRoleInsightRequestsV1429ResponseV1', 'v1CreateRoleInsightRequestsV1429ResponseV1'] +slug: /tools/sdk/typescript/role_insights/models/create-role-insight-requests-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateRoleInsightRequestsV1429ResponseV1', 'v1CreateRoleInsightRequestsV1429ResponseV1'] +--- + +# CreateRoleInsightRequestsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Errormessagedto.md b/sdk-output/role_insights/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..ecfae8bd --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/role_insights/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Errorresponsedto.md b/sdk-output/role_insights/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..c24a83db --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/role_insights/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Index.md b/sdk-output/role_insights/docs/Models/Index.md new file mode 100644 index 00000000..cf0e4540 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: role_insights-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: role_insights-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'role_insights', 'models'] +slug: /tools/sdk/typescript/role_insights/models +tags: ['SDK', 'Software Development Kit', 'role_insights', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/role_insights/docs/Models/Localeorigin.md b/sdk-output/role_insights/docs/Models/Localeorigin.md new file mode 100644 index 00000000..8d8a27d0 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/role_insights/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/role_insights/docs/Models/README.md b/sdk-output/role_insights/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/role_insights/docs/Models/Roleinsight.md b/sdk-output/role_insights/docs/Models/Roleinsight.md new file mode 100644 index 00000000..1957f448 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsight.md @@ -0,0 +1,24 @@ +--- +id: v1-roleinsight-v1 +title: RoleinsightV1 +pagination_label: RoleinsightV1 +sidebar_label: RoleinsightV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightV1', 'v1RoleinsightV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsight-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightV1', 'v1RoleinsightV1'] +--- + +# RoleinsightV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Insight id | [default to undefined] +**numberOfUpdates** | **(optional)** **number** | Total number of updates for this role | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time insights were last created for this role. | [default to undefined] +**modifiedDate** | **(optional)** **string** | The date-time insights were last modified for this role. | [default to undefined] +**role** | **(optional)** **RoleinsightsroleV1** | | [default to undefined] +**insight** | **(optional)** **RoleinsightsinsightV1** | | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsentitlement.md b/sdk-output/role_insights/docs/Models/Roleinsightsentitlement.md new file mode 100644 index 00000000..fd0a1767 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsentitlement.md @@ -0,0 +1,24 @@ +--- +id: v1-roleinsightsentitlement-v1 +title: RoleinsightsentitlementV1 +pagination_label: RoleinsightsentitlementV1 +sidebar_label: RoleinsightsentitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsentitlementV1', 'v1RoleinsightsentitlementV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsentitlement-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsentitlementV1', 'v1RoleinsightsentitlementV1'] +--- + +# RoleinsightsentitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the entitlement | [default to undefined] +**id** | **(optional)** **string** | Id of the entitlement | [default to undefined] +**description** | **(optional)** **string** | Description for the entitlement | [default to undefined] +**source** | **(optional)** **string** | Source or the application for the entitlement | [default to undefined] +**attribute** | **(optional)** **string** | Attribute for the entitlement | [default to undefined] +**value** | **(optional)** **string** | Attribute value for the entitlement | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsentitlementchanges.md b/sdk-output/role_insights/docs/Models/Roleinsightsentitlementchanges.md new file mode 100644 index 00000000..d3b5a08b --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsentitlementchanges.md @@ -0,0 +1,25 @@ +--- +id: v1-roleinsightsentitlementchanges-v1 +title: RoleinsightsentitlementchangesV1 +pagination_label: RoleinsightsentitlementchangesV1 +sidebar_label: RoleinsightsentitlementchangesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsentitlementchangesV1', 'v1RoleinsightsentitlementchangesV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsentitlementchanges-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsentitlementchangesV1', 'v1RoleinsightsentitlementchangesV1'] +--- + +# RoleinsightsentitlementchangesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the entitlement | [default to undefined] +**id** | **(optional)** **string** | Id of the entitlement | [default to undefined] +**description** | **(optional)** **string** | Description for the entitlement | [default to undefined] +**attribute** | **(optional)** **string** | Attribute for the entitlement | [default to undefined] +**value** | **(optional)** **string** | Attribute value for the entitlement | [default to undefined] +**source** | **(optional)** **string** | Source or the application for the entitlement | [default to undefined] +**insight** | **(optional)** **RoleinsightsinsightV1** | | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsidentities.md b/sdk-output/role_insights/docs/Models/Roleinsightsidentities.md new file mode 100644 index 00000000..147d0321 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsidentities.md @@ -0,0 +1,21 @@ +--- +id: v1-roleinsightsidentities-v1 +title: RoleinsightsidentitiesV1 +pagination_label: RoleinsightsidentitiesV1 +sidebar_label: RoleinsightsidentitiesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsidentitiesV1', 'v1RoleinsightsidentitiesV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsidentities-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsidentitiesV1', 'v1RoleinsightsidentitiesV1'] +--- + +# RoleinsightsidentitiesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id for identity | [default to undefined] +**name** | **(optional)** **string** | Name for identity | [default to undefined] +**attributes** | **(optional)** | | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsinsight.md b/sdk-output/role_insights/docs/Models/Roleinsightsinsight.md new file mode 100644 index 00000000..6726429c --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsinsight.md @@ -0,0 +1,23 @@ +--- +id: v1-roleinsightsinsight-v1 +title: RoleinsightsinsightV1 +pagination_label: RoleinsightsinsightV1 +sidebar_label: RoleinsightsinsightV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsinsightV1', 'v1RoleinsightsinsightV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsinsight-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsinsightV1', 'v1RoleinsightsinsightV1'] +--- + +# RoleinsightsinsightV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The number of identities in this role with the entitlement. | [default to undefined] +**identitiesWithAccess** | **(optional)** **number** | The number of identities in this role with the entitlement. | [default to undefined] +**identitiesImpacted** | **(optional)** **number** | The number of identities in this role that do not have the specified entitlement. | [default to undefined] +**totalNumberOfIdentities** | **(optional)** **number** | The total number of identities. | [default to undefined] +**impactedIdentityNames** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsresponse.md b/sdk-output/role_insights/docs/Models/Roleinsightsresponse.md new file mode 100644 index 00000000..9f5e5fa0 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsresponse.md @@ -0,0 +1,24 @@ +--- +id: v1-roleinsightsresponse-v1 +title: RoleinsightsresponseV1 +pagination_label: RoleinsightsresponseV1 +sidebar_label: RoleinsightsresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsresponseV1', 'v1RoleinsightsresponseV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsresponseV1', 'v1RoleinsightsresponseV1'] +--- + +# RoleinsightsresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Request Id for a role insight generation request | [default to undefined] +**createdDate** | **(optional)** **string** | The date-time role insights request was created. | [default to undefined] +**lastGenerated** | **(optional)** **string** | The date-time role insights request was completed. | [default to undefined] +**numberOfUpdates** | **(optional)** **number** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [default to undefined] +**roleIds** | **(optional)** **Array<string>** | The role IDs that are in this request. | [default to undefined] +**status** | **(optional)** **string** | Request status | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightsrole.md b/sdk-output/role_insights/docs/Models/Roleinsightsrole.md new file mode 100644 index 00000000..0fd5e7a0 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightsrole.md @@ -0,0 +1,23 @@ +--- +id: v1-roleinsightsrole-v1 +title: RoleinsightsroleV1 +pagination_label: RoleinsightsroleV1 +sidebar_label: RoleinsightsroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightsroleV1', 'v1RoleinsightsroleV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightsrole-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightsroleV1', 'v1RoleinsightsroleV1'] +--- + +# RoleinsightsroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Role name | [default to undefined] +**id** | **(optional)** **string** | Role id | [default to undefined] +**description** | **(optional)** **string** | Role description | [default to undefined] +**ownerName** | **(optional)** **string** | Role owner name | [default to undefined] +**ownerId** | **(optional)** **string** | Role owner id | [default to undefined] + diff --git a/sdk-output/role_insights/docs/Models/Roleinsightssummary.md b/sdk-output/role_insights/docs/Models/Roleinsightssummary.md new file mode 100644 index 00000000..23dbc470 --- /dev/null +++ b/sdk-output/role_insights/docs/Models/Roleinsightssummary.md @@ -0,0 +1,24 @@ +--- +id: v1-roleinsightssummary-v1 +title: RoleinsightssummaryV1 +pagination_label: RoleinsightssummaryV1 +sidebar_label: RoleinsightssummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleinsightssummaryV1', 'v1RoleinsightssummaryV1'] +slug: /tools/sdk/typescript/role_insights/models/roleinsightssummary-v1 +tags: ['SDK', 'Software Development Kit', 'RoleinsightssummaryV1', 'v1RoleinsightssummaryV1'] +--- + +# RoleinsightssummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**numberOfUpdates** | **(optional)** **number** | Total number of roles with updates | [default to undefined] +**lastGenerated** | **(optional)** **string** | The date-time role insights were last found. | [default to undefined] +**entitlementsIncludedInRoles** | **(optional)** **number** | The number of entitlements included in roles (vs free radicals). | [default to undefined] +**totalNumberOfEntitlements** | **(optional)** **number** | The total number of entitlements. | [default to undefined] +**identitiesWithAccessViaRoles** | **(optional)** **number** | The number of identities in roles vs. identities with just entitlements and not in roles. | [default to undefined] +**totalNumberOfIdentities** | **(optional)** **number** | The total number of identities. | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/role_propagation/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..7d3cc03d --- /dev/null +++ b/sdk-output/role_propagation/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,93 @@ +- path: /role-propagation/v1/terminate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#cancel-role-propagation-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.cancelRolePropagationV1(); + console.log(result); +- path: /role-propagation/v1/is-running + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#get-ongoing-role-propagation-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getOngoingRolePropagationV1(); + console.log(result); +- path: /role-propagation-config/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#get-role-propagation-config-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRolePropagationConfigV1(); + console.log(result); +- path: /role-propagation/v1/{rolePropagationId}/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#get-role-propagation-status-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const rolePropagationId: string = '47b9fb02-e12e-42ba-8bfe-1860d78c88eb'; // string | The ID of the role propagation process to retrieve the status for. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRolePropagationStatusV1(rolePropagationId); + console.log(result); +- path: /role-propagation-config/v1 + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#set-role-propagation-config-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const rolePropagationConfigInputV1: RolePropagationConfigInputV1 = ; // RolePropagationConfigInputV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.setRolePropagationConfigV1(rolePropagationConfigInputV1); + console.log(result); +- path: /role-propagation/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/role_propagation/methods/role-propagation#start-role-propagation-v1 + source: | + import { RolePropagationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolePropagationV1Api(configuration); + const skipRoleRefresh: boolean = true; // boolean | When true, the role refresh is not performed. Keeping it false is recommended. (optional) (default to false) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.startRolePropagationV1(); + console.log(result); diff --git a/sdk-output/role_propagation/docs/Methods/Index.md b/sdk-output/role_propagation/docs/Methods/Index.md new file mode 100644 index 00000000..08338c4b --- /dev/null +++ b/sdk-output/role_propagation/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: role_propagation-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: role_propagation-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'role_propagation', 'methods'] +slug: /tools/sdk/typescript/role_propagation/methods +tags: ['SDK', 'Software Development Kit', 'role_propagation', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/role_propagation/docs/Methods/RolePropagationV1Api.md b/sdk-output/role_propagation/docs/Methods/RolePropagationV1Api.md new file mode 100644 index 00000000..c4c885c6 --- /dev/null +++ b/sdk-output/role_propagation/docs/Methods/RolePropagationV1Api.md @@ -0,0 +1,288 @@ +--- +id: v1-role-propagation +title: RolePropagation +pagination_label: RolePropagation +sidebar_label: RolePropagation +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagation', 'v1RolePropagation'] +slug: /tools/sdk/typescript/role_propagation/methods/role-propagation +tags: ['SDK', 'Software Development Kit', 'RolePropagation', 'v1RolePropagation'] +--- + +# RolePropagationV1Api + Role Change Propagation ensures that any changes to the composition of a role’s access objects +(entitlements, access profiles, or dimensions) are applied to all member identities. +For example: If an entitlement is removed from a role, all identities assigned to that role +should lose access to that entitlement as part of this process. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-role-propagation-v1**](#cancel-role-propagation-v1) | **POST** `/role-propagation/v1/terminate` | Terminate Role Propagation process +[**get-ongoing-role-propagation-v1**](#get-ongoing-role-propagation-v1) | **GET** `/role-propagation/v1/is-running` | Get ongoing Role Propagation process +[**get-role-propagation-config-v1**](#get-role-propagation-config-v1) | **GET** `/role-propagation-config/v1` | Get Role Change Propagation Configuration +[**get-role-propagation-status-v1**](#get-role-propagation-status-v1) | **GET** `/role-propagation/v1/{rolePropagationId}/status` | Get status of Role-Propagation process +[**set-role-propagation-config-v1**](#set-role-propagation-config-v1) | **PUT** `/role-propagation-config/v1` | Update Role Change Propagation Configuration +[**start-role-propagation-v1**](#start-role-propagation-v1) | **POST** `/role-propagation/v1` | Initiate Role Propagation process + + +## cancel-role-propagation-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Terminate Role Propagation process +This endpoint terminates the ongoing role change propagation process for a tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-role-propagation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.cancelRolePropagationV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-ongoing-role-propagation-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get ongoing Role Propagation process +This endpoint returns the information of ongoing role change propagation process for a tenant. It returns the information whether the role propagation process is currently running or not, If it is running it returns the details of the ongoing role propagation process. The execution stage of the role propagation process can be one of the following: - PENDING - The role propagation process is queued to be executed. - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. - SUCCEEDED - The role propagation process has successfully completed. - FAILED - The role propagation process has failed. - TERMINATED - The role propagation process was externally terminated. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-ongoing-role-propagation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RolePropagationOngoingResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getOngoingRolePropagationV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-propagation-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get Role Change Propagation Configuration +This endpoint fetches the Role Change Propagation Configuration for the tenant + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-propagation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RolePropagationConfigResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRolePropagationConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-propagation-status-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get status of Role-Propagation process +This endpoint returns the information of the specified role change propagation process. The execution stage of the role propagation process can be one of the following: + - PENDING - The role propagation process is queued to be executed. + - DATA_AGGREGATION_RUNNING - The role propagation process is currently aggregating data. + - LAUNCH_PROVISIONING - The role propagation process has started to provision the access to the identities. + - SUCCEEDED - The role propagation process has successfully completed. + - FAILED - The role propagation process has failed. + - TERMINATED - The role propagation process was externally terminated. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-propagation-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolePropagationId** | **string** | The ID of the role propagation process to retrieve the status for. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RolePropagationStatusResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const rolePropagationId: string = 47b9fb02-e12e-42ba-8bfe-1860d78c88eb; // The ID of the role propagation process to retrieve the status for. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRolePropagationStatusV1(rolePropagationId); +console.log(result); +``` + +[[Back to top]](#) + +## set-role-propagation-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update Role Change Propagation Configuration +This endpoint enables or disables the Role Change Propagation Process for the tenant + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-role-propagation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolePropagationConfigInputV1** | **RolePropagationConfigInputV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RolePropagationConfigResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const rolePropagationConfigInputV1: RolePropagationConfigInputV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.setRolePropagationConfigV1(rolePropagationConfigInputV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-role-propagation-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Initiate Role Propagation process +This endpoint initiates a role change propagation process for a tenant asynchronously. If all preconditions are met, the request is accepted and a rolePropagationId is returned which can be used to view the status. +API throws 4xx if any of the following conditions are met - Role propagation feature is disabled - There is an ongoing role propagation for the tenant - Role refresh needs to be kicked off as part of the role propagation (skipRoleRefresh=false) and there is an ongoing refresh for the tenant + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-role-propagation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**skipRoleRefresh** | **boolean** | When true, the role refresh is not performed. Keeping it false is recommended. | [optional] [default to false] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**RolePropagationResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolePropagationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolePropagationV1Api(configuration); +const skipRoleRefresh: boolean = true; // When true, the role refresh is not performed. Keeping it false is recommended. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.startRolePropagationV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/role_propagation/docs/Models/Errormessagedto.md b/sdk-output/role_propagation/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..342ba5dd --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/role_propagation/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/Errorresponsedto.md b/sdk-output/role_propagation/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..c379c87d --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/role_propagation/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/Index.md b/sdk-output/role_propagation/docs/Models/Index.md new file mode 100644 index 00000000..09583269 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: role_propagation-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: role_propagation-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'role_propagation', 'models'] +slug: /tools/sdk/typescript/role_propagation/models +tags: ['SDK', 'Software Development Kit', 'role_propagation', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/role_propagation/docs/Models/Localeorigin.md b/sdk-output/role_propagation/docs/Models/Localeorigin.md new file mode 100644 index 00000000..561540c1 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/role_propagation/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/role_propagation/docs/Models/README.md b/sdk-output/role_propagation/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationConfigInput.md b/sdk-output/role_propagation/docs/Models/RolePropagationConfigInput.md new file mode 100644 index 00000000..09c314a5 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationConfigInput.md @@ -0,0 +1,19 @@ +--- +id: v1-role-propagation-config-input-v1 +title: RolePropagationConfigInputV1 +pagination_label: RolePropagationConfigInputV1 +sidebar_label: RolePropagationConfigInputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationConfigInputV1', 'v1RolePropagationConfigInputV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-config-input-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationConfigInputV1', 'v1RolePropagationConfigInputV1'] +--- + +# RolePropagationConfigInputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if the Role Change Propagation process should be enabled for the tenant | [default to false] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationConfigResponse.md b/sdk-output/role_propagation/docs/Models/RolePropagationConfigResponse.md new file mode 100644 index 00000000..9c573a86 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationConfigResponse.md @@ -0,0 +1,22 @@ +--- +id: v1-role-propagation-config-response-v1 +title: RolePropagationConfigResponseV1 +pagination_label: RolePropagationConfigResponseV1 +sidebar_label: RolePropagationConfigResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationConfigResponseV1', 'v1RolePropagationConfigResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-config-response-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationConfigResponseV1', 'v1RolePropagationConfigResponseV1'] +--- + +# RolePropagationConfigResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if the Role Change Propagation process is enabled for the tenant | [default to false] +**enabledDate** | **(optional)** **string** | The time when Role Change Propagation Process was last enabled on the tenant | [default to undefined] +**createdDate** | **(optional)** **string** | The time when Role Change Propagation Configuration was first created for the tenant | [default to undefined] +**modifiedDate** | **(optional)** **string** | The time when Role Change Propagation Config was updated on the tenant | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponse.md b/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponse.md new file mode 100644 index 00000000..7e5cc6a6 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponse.md @@ -0,0 +1,20 @@ +--- +id: v1-role-propagation-ongoing-response-v1 +title: RolePropagationOngoingResponseV1 +pagination_label: RolePropagationOngoingResponseV1 +sidebar_label: RolePropagationOngoingResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationOngoingResponseV1', 'v1RolePropagationOngoingResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-ongoing-response-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationOngoingResponseV1', 'v1RolePropagationOngoingResponseV1'] +--- + +# RolePropagationOngoingResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isRunning** | **(optional)** **boolean** | Indicates if the role propagation process is currently running on the tenant | [default to false] +**rolePropagationDetails** | **(optional)** **RolePropagationOngoingResponseRolePropagationDetailsV1** | | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponseRolePropagationDetails.md b/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponseRolePropagationDetails.md new file mode 100644 index 00000000..94c210fd --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationOngoingResponseRolePropagationDetails.md @@ -0,0 +1,27 @@ +--- +id: v1-role-propagation-ongoing-response-role-propagation-details-v1 +title: RolePropagationOngoingResponseRolePropagationDetailsV1 +pagination_label: RolePropagationOngoingResponseRolePropagationDetailsV1 +sidebar_label: RolePropagationOngoingResponseRolePropagationDetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationOngoingResponseRolePropagationDetailsV1', 'v1RolePropagationOngoingResponseRolePropagationDetailsV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-ongoing-response-role-propagation-details-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationOngoingResponseRolePropagationDetailsV1', 'v1RolePropagationOngoingResponseRolePropagationDetailsV1'] +--- + +# RolePropagationOngoingResponseRolePropagationDetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the Role Propagation process triggered. | [default to undefined] +**status** | **(optional)** **string** | Status of the Role Propagation process. | [default to undefined] +**executionStage** | **(optional)** **string** | Current execution stage of the Role Propagation process. | [default to undefined] +**launched** | **(optional)** **string** | Time when the Role Propagation process was launched. | [default to undefined] +**launchedBy** | **(optional)** **RolePropagationStatusResponseLaunchedByV1** | | [default to undefined] +**terminatedBy** | **(optional)** **RolePropagationStatusResponseTerminatedByV1** | | [default to undefined] +**completed** | **(optional)** **string** | Time when the Role Propagation process was completed. | [default to undefined] +**failureReason** | **(optional)** **string** | Reason for failure if the Role Propagation process failed. | [default to undefined] +**skipRoleRefresh** | **(optional)** **boolean** | Indicates if the role refresh was skipped during the Role Propagation process. | [default to false] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationResponse.md b/sdk-output/role_propagation/docs/Models/RolePropagationResponse.md new file mode 100644 index 00000000..6a5f6628 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationResponse.md @@ -0,0 +1,19 @@ +--- +id: v1-role-propagation-response-v1 +title: RolePropagationResponseV1 +pagination_label: RolePropagationResponseV1 +sidebar_label: RolePropagationResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationResponseV1', 'v1RolePropagationResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-response-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationResponseV1', 'v1RolePropagationResponseV1'] +--- + +# RolePropagationResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rolePropagationId** | **(optional)** **string** | Id of the Role Propagation process triggered. | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponse.md b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponse.md new file mode 100644 index 00000000..645425d7 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponse.md @@ -0,0 +1,27 @@ +--- +id: v1-role-propagation-status-response-v1 +title: RolePropagationStatusResponseV1 +pagination_label: RolePropagationStatusResponseV1 +sidebar_label: RolePropagationStatusResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationStatusResponseV1', 'v1RolePropagationStatusResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-status-response-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationStatusResponseV1', 'v1RolePropagationStatusResponseV1'] +--- + +# RolePropagationStatusResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Id of the Role Propagation process triggered. | [default to undefined] +**status** | **(optional)** **string** | Status of the Role Propagation process. | [default to undefined] +**executionStage** | **(optional)** **string** | Current execution stage of the Role Propagation process. | [default to undefined] +**launched** | **(optional)** **string** | Time when the Role Propagation process was launched. | [default to undefined] +**launchedBy** | **(optional)** **RolePropagationStatusResponseLaunchedByV1** | | [default to undefined] +**terminatedBy** | **(optional)** **RolePropagationStatusResponseTerminatedByV1** | | [default to undefined] +**completed** | **(optional)** **string** | Time when the Role Propagation process was completed. | [default to undefined] +**failureReason** | **(optional)** **string** | Reason for failure if the Role Propagation process failed. | [default to undefined] +**skipRoleRefresh** | **(optional)** **boolean** | Indicates if the role refresh was skipped during the Role Propagation process. | [default to false] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseLaunchedBy.md b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseLaunchedBy.md new file mode 100644 index 00000000..b86d5525 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseLaunchedBy.md @@ -0,0 +1,21 @@ +--- +id: v1-role-propagation-status-response-launched-by-v1 +title: RolePropagationStatusResponseLaunchedByV1 +pagination_label: RolePropagationStatusResponseLaunchedByV1 +sidebar_label: RolePropagationStatusResponseLaunchedByV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationStatusResponseLaunchedByV1', 'v1RolePropagationStatusResponseLaunchedByV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-status-response-launched-by-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationStatusResponseLaunchedByV1', 'v1RolePropagationStatusResponseLaunchedByV1'] +--- + +# RolePropagationStatusResponseLaunchedByV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of the identity who launched the Role Propagation process. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity who launched the Role Propagation process. | [default to undefined] +**name** | **(optional)** **string** | Name of the identity who launched the Role Propagation process. | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseTerminatedBy.md b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseTerminatedBy.md new file mode 100644 index 00000000..4bd5ec4e --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/RolePropagationStatusResponseTerminatedBy.md @@ -0,0 +1,21 @@ +--- +id: v1-role-propagation-status-response-terminated-by-v1 +title: RolePropagationStatusResponseTerminatedByV1 +pagination_label: RolePropagationStatusResponseTerminatedByV1 +sidebar_label: RolePropagationStatusResponseTerminatedByV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolePropagationStatusResponseTerminatedByV1', 'v1RolePropagationStatusResponseTerminatedByV1'] +slug: /tools/sdk/typescript/role_propagation/models/role-propagation-status-response-terminated-by-v1 +tags: ['SDK', 'Software Development Kit', 'RolePropagationStatusResponseTerminatedByV1', 'v1RolePropagationStatusResponseTerminatedByV1'] +--- + +# RolePropagationStatusResponseTerminatedByV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of the Identity who terminated the Role Propagation process. | [default to undefined] +**id** | **(optional)** **string** | ID of the Identity who terminated the Role Propagation process. | [default to undefined] +**name** | **(optional)** **string** | Name of the Identity who terminated the Role Propagation process. | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/StartRolePropagationV1401Response.md b/sdk-output/role_propagation/docs/Models/StartRolePropagationV1401Response.md new file mode 100644 index 00000000..786d6fa2 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/StartRolePropagationV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-role-propagation-v1401-response-v1 +title: StartRolePropagationV1401ResponseV1 +pagination_label: StartRolePropagationV1401ResponseV1 +sidebar_label: StartRolePropagationV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartRolePropagationV1401ResponseV1', 'v1StartRolePropagationV1401ResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/start-role-propagation-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartRolePropagationV1401ResponseV1', 'v1StartRolePropagationV1401ResponseV1'] +--- + +# StartRolePropagationV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/role_propagation/docs/Models/StartRolePropagationV1429Response.md b/sdk-output/role_propagation/docs/Models/StartRolePropagationV1429Response.md new file mode 100644 index 00000000..894105a9 --- /dev/null +++ b/sdk-output/role_propagation/docs/Models/StartRolePropagationV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-role-propagation-v1429-response-v1 +title: StartRolePropagationV1429ResponseV1 +pagination_label: StartRolePropagationV1429ResponseV1 +sidebar_label: StartRolePropagationV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartRolePropagationV1429ResponseV1', 'v1StartRolePropagationV1429ResponseV1'] +slug: /tools/sdk/typescript/role_propagation/models/start-role-propagation-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartRolePropagationV1429ResponseV1', 'v1StartRolePropagationV1429ResponseV1'] +--- + +# StartRolePropagationV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/roles/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/roles/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..323d4d40 --- /dev/null +++ b/sdk-output/roles/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,269 @@ +- path: /roles/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#create-role-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const roleV1: RoleV1 = ; // RoleV1 | + const result = await apiInstance.createRoleV1(roleV1); + console.log(result); +- path: /roles/v1/bulk-delete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#delete-bulk-roles-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const rolebulkdeleterequestV1: RolebulkdeleterequestV1 = {"roleIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // RolebulkdeleterequestV1 | + const result = await apiInstance.deleteBulkRolesV1(rolebulkdeleterequestV1); + console.log(result); +- path: /roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#delete-metadata-from-role-by-key-and-value-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808c74ff913f0175097daa9d59cd'; // string | The role\'s id. (default to undefined) + const attributeKey: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const attributeValue: string = 'public'; // string | Technical name of the Attribute Value. (default to undefined) + const result = await apiInstance.deleteMetadataFromRoleByKeyAndValueV1(id, attributeKey, attributeValue); + console.log(result); +- path: /roles/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#delete-role-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the Role (default to undefined) + const result = await apiInstance.deleteRoleV1(id); + console.log(result); +- path: /roles/v1/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#get-bulk-update-status-by-id-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = 'c24359c389374d0fb8585698a2189e3d'; // string | The Id of the bulk update task. (default to undefined) + const result = await apiInstance.getBulkUpdateStatusByIdV1(id); + console.log(result); +- path: /roles/v1/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#get-bulk-update-status-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const result = await apiInstance.getBulkUpdateStatusV1(); + console.log(result); +- path: /roles/v1/{id}/assigned-identities + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#get-role-assigned-identities-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the Role for which the assigned Identities are to be listed (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name sw Joe'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) (default to undefined) + const sorters: string = 'aliasName,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) (default to undefined) + const result = await apiInstance.getRoleAssignedIdentitiesV1(id); + console.log(result); +- path: /roles/v1/{id}/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#get-role-entitlements-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808a7813090a017814121919ecca'; // string | Containing role\'s ID. (default to undefined) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'attribute eq "memberOf"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getRoleEntitlementsV1(id); + console.log(result); +- path: /roles/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#get-role-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the Role (default to undefined) + const result = await apiInstance.getRoleV1(id); + console.log(result); +- path: /roles/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#list-roles-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const forSubadmin: string = '5168015d32f890ca15812c9180835d2e'; // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) (default to undefined) + const limit: number = 50; // number | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'requestable eq false'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const forSegmentIds: string = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d'; // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) (default to undefined) + const includeUnsegmented: boolean = false; // boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + const result = await apiInstance.listRolesV1(); + console.log(result); +- path: /roles/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#patch-role-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = '2c91808a7813090a017814121e121518'; // string | ID of the Role to patch (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/requestable","value":true},{"op":"replace","path":"/enabled","value":true}]; // Array | + const result = await apiInstance.patchRoleV1(id, jsonpatchoperationV1); + console.log(result); +- path: /roles/v1/filter + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#search-roles-by-filter-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const forSubadmin: string = '5168015d32f890ca15812c9180835d2e'; // string | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) (default to undefined) + const limit: number = 50; // number | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) (default to undefined) + const forSegmentIds: string = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d'; // string | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) (default to undefined) + const includeUnsegmented: boolean = false; // boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to true) + const rolelistfilterdtoV1: RolelistfilterdtoV1 = {"filters":"dimensional eq false","ammKeyValues":[{"attribute":"iscFederalClassifications","values":["secret"]}]}; // RolelistfilterdtoV1 | (optional) + const result = await apiInstance.searchRolesByFilterV1(); + console.log(result); +- path: /roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#update-attribute-key-and-value-to-role-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const id: string = 'c24359c389374d0fb8585698a2189e3d'; // string | The Id of a role (default to undefined) + const attributeKey: string = 'iscPrivacy'; // string | Technical name of the Attribute. (default to undefined) + const attributeValue: string = 'public'; // string | Technical name of the Attribute Value. (default to undefined) + const result = await apiInstance.updateAttributeKeyAndValueToRoleV1(id, attributeKey, attributeValue); + console.log(result); +- path: /roles/v1/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#update-roles-metadata-by-filter-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const rolemetadatabulkupdatebyfilterrequestV1: RolemetadatabulkupdatebyfilterrequestV1 = {"operation":"ADD","replaceScope":"ALL","filters":"requestable eq false","values":[{"attribute":"iscFederalClassifications","values":["topSecret"]}]}; // RolemetadatabulkupdatebyfilterrequestV1 | + const result = await apiInstance.updateRolesMetadataByFilterV1(rolemetadatabulkupdatebyfilterrequestV1); + console.log(result); +- path: /roles/v1/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#update-roles-metadata-by-ids-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const rolemetadatabulkupdatebyidrequestV1: RolemetadatabulkupdatebyidrequestV1 = ; // RolemetadatabulkupdatebyidrequestV1 | + const result = await apiInstance.updateRolesMetadataByIdsV1(rolemetadatabulkupdatebyidrequestV1); + console.log(result); +- path: /roles/v1/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/roles/methods/roles#update-roles-metadata-by-query-v1 + source: | + import { RolesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new RolesV1Api(configuration); + const rolemetadatabulkupdatebyqueryrequestV1: RolemetadatabulkupdatebyqueryrequestV1 = {"example of a success update":{"query":{"indices":["roles"],"queryType":"TEXT","textQuery":{"terms":["test123"],"fields":["id"],"matchAny":false,"contains":true},"includeNested":false},"operation":"REPLACE","replaceScope":"ALL","values":[{"attribute":"iscFederalClassifications","values":["secret"]}]}}; // RolemetadatabulkupdatebyqueryrequestV1 | + const result = await apiInstance.updateRolesMetadataByQueryV1(rolemetadatabulkupdatebyqueryrequestV1); + console.log(result); diff --git a/sdk-output/roles/docs/Methods/Index.md b/sdk-output/roles/docs/Methods/Index.md new file mode 100644 index 00000000..471f2ab6 --- /dev/null +++ b/sdk-output/roles/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: roles-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: roles-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'roles', 'methods'] +slug: /tools/sdk/typescript/roles/methods +tags: ['SDK', 'Software Development Kit', 'roles', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/roles/docs/Methods/RolesV1Api.md b/sdk-output/roles/docs/Methods/RolesV1Api.md new file mode 100644 index 00000000..30c8cfc2 --- /dev/null +++ b/sdk-output/roles/docs/Methods/RolesV1Api.md @@ -0,0 +1,786 @@ +--- +id: v1-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Roles', 'v1Roles'] +slug: /tools/sdk/typescript/roles/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'v1Roles'] +--- + +# RolesV1Api + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-role-v1**](#create-role-v1) | **POST** `/roles/v1` | Create a role +[**delete-bulk-roles-v1**](#delete-bulk-roles-v1) | **POST** `/roles/v1/bulk-delete` | Delete role(s) +[**delete-metadata-from-role-by-key-and-value-v1**](#delete-metadata-from-role-by-key-and-value-v1) | **DELETE** `/roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role. +[**delete-role-v1**](#delete-role-v1) | **DELETE** `/roles/v1/{id}` | Delete a role +[**get-bulk-update-status-by-id-v1**](#get-bulk-update-status-by-id-v1) | **GET** `/roles/v1/access-model-metadata/bulk-update/id` | Get bulk-update status by id +[**get-bulk-update-status-v1**](#get-bulk-update-status-v1) | **GET** `/roles/v1/access-model-metadata/bulk-update` | Get bulk-update statuses +[**get-role-assigned-identities-v1**](#get-role-assigned-identities-v1) | **GET** `/roles/v1/{id}/assigned-identities` | List identities assigned a role +[**get-role-entitlements-v1**](#get-role-entitlements-v1) | **GET** `/roles/v1/{id}/entitlements` | List role\'s entitlements +[**get-role-v1**](#get-role-v1) | **GET** `/roles/v1/{id}` | Get a role +[**list-roles-v1**](#list-roles-v1) | **GET** `/roles/v1` | List roles +[**patch-role-v1**](#patch-role-v1) | **PATCH** `/roles/v1/{id}` | Patch a specified role +[**search-roles-by-filter-v1**](#search-roles-by-filter-v1) | **POST** `/roles/v1/filter` | Filter roles by metadata +[**update-attribute-key-and-value-to-role-v1**](#update-attribute-key-and-value-to-role-v1) | **POST** `/roles/v1/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role. +[**update-roles-metadata-by-filter-v1**](#update-roles-metadata-by-filter-v1) | **POST** `/roles/v1/access-model-metadata/bulk-update/filter` | Bulk-update roles\' metadata by filters +[**update-roles-metadata-by-ids-v1**](#update-roles-metadata-by-ids-v1) | **POST** `/roles/v1/access-model-metadata/bulk-update/ids` | Bulk-update roles\' metadata by id +[**update-roles-metadata-by-query-v1**](#update-roles-metadata-by-query-v1) | **POST** `/roles/v1/access-model-metadata/bulk-update/query` | Bulk-update roles\' metadata by query + + +## create-role-v1 +Create a role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**roleV1** | **RoleV1** | | + +### Return type + +**RoleV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const roleV1: RoleV1 = ; // +const result = await apiInstance.createRoleV1(roleV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-bulk-roles-v1 +Delete role(s) +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-bulk-roles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolebulkdeleterequestV1** | **RolebulkdeleterequestV1** | | + +### Return type + +**TaskresultdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const rolebulkdeleterequestV1: RolebulkdeleterequestV1 = {"roleIds":["2c91808876438bb2017668b91919ecca","2c91808876438ba801766e129f151816"]}; // +const result = await apiInstance.deleteBulkRolesV1(rolebulkdeleterequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-metadata-from-role-by-key-and-value-v1 +Remove a metadata from role. +This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-metadata-from-role-by-key-and-value-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The role\'s id. | [default to undefined] +**attributeKey** | **string** | Technical name of the Attribute. | [default to undefined] +**attributeValue** | **string** | Technical name of the Attribute Value. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808c74ff913f0175097daa9d59cd; // The role\'s id. +const attributeKey: string = iscPrivacy; // Technical name of the Attribute. +const attributeValue: string = public; // Technical name of the Attribute Value. +const result = await apiInstance.deleteMetadataFromRoleByKeyAndValueV1(id, attributeKey, attributeValue); +console.log(result); +``` + +[[Back to top]](#) + +## delete-role-v1 +Delete a role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Role | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the Role +const result = await apiInstance.deleteRoleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-bulk-update-status-by-id-v1 +Get bulk-update status by id + +This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-bulk-update-status-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Id of the bulk update task. | [default to undefined] + +### Return type + +**RolebulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = c24359c389374d0fb8585698a2189e3d; // The Id of the bulk update task. +const result = await apiInstance.getBulkUpdateStatusByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-bulk-update-status-v1 +Get bulk-update statuses +This API returns a list of all unfinished bulk update process status of the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-bulk-update-status-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const result = await apiInstance.getBulkUpdateStatusV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-assigned-identities-v1 +List identities assigned a role + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-assigned-identities-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Role for which the assigned Identities are to be listed | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the Role for which the assigned Identities are to be listed +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name sw Joe; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) +const sorters: string = aliasName,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) +const result = await apiInstance.getRoleAssignedIdentitiesV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-entitlements-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List role\'s entitlements +Get a list of entitlements associated with a specified role. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Containing role\'s ID. | [default to undefined] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808a7813090a017814121919ecca; // Containing role\'s ID. +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = attribute eq "memberOf"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getRoleEntitlementsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-role-v1 +Get a role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Role | [default to undefined] + +### Return type + +**RoleV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the Role +const result = await apiInstance.getRoleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-roles-v1 +List roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-roles-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | [optional] [default to undefined] +**limit** | **number** | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] +**forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | [optional] [default to undefined] +**includeUnsegmented** | **boolean** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [optional] [default to true] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const forSubadmin: string = 5168015d32f890ca15812c9180835d2e; // If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +const limit: number = 50; // Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = requestable eq false; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const forSegmentIds: string = 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d; // If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +const includeUnsegmented: boolean = false; // Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) +const result = await apiInstance.listRolesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-role-v1 +Patch a specified role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* additionalOwners +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Role to patch | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**RoleV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = 2c91808a7813090a017814121e121518; // ID of the Role to patch +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/requestable","value":true},{"op":"replace","path":"/enabled","value":true}]; // +const result = await apiInstance.patchRoleV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## search-roles-by-filter-v1 +Filter roles by metadata +This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-roles-by-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**forSubadmin** | **string** | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 50] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** | [optional] [default to undefined] +**forSegmentIds** | **string** | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. | [optional] [default to undefined] +**includeUnsegmented** | **boolean** | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. | [optional] [default to true] +**rolelistfilterdtoV1** | **RolelistfilterdtoV1** | | [optional] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const forSubadmin: string = 5168015d32f890ca15812c9180835d2e; // If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +const limit: number = 50; // Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // Boolean indicating whether a total count is returned, factoring in any filter parameters, in the X-Total-Count response header. The value is the total size of the collection that would be returned if limit and offset were ignored. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +const forSegmentIds: string = 0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d; // If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +const includeUnsegmented: boolean = false; // Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) +const rolelistfilterdtoV1: RolelistfilterdtoV1 = {"filters":"dimensional eq false","ammKeyValues":[{"attribute":"iscFederalClassifications","values":["secret"]}]}; // (optional) +const result = await apiInstance.searchRolesByFilterV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-attribute-key-and-value-to-role-v1 +Add a metadata to role. +This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-attribute-key-and-value-to-role-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Id of a role | [default to undefined] +**attributeKey** | **string** | Technical name of the Attribute. | [default to undefined] +**attributeValue** | **string** | Technical name of the Attribute Value. | [default to undefined] + +### Return type + +**RoleV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const id: string = c24359c389374d0fb8585698a2189e3d; // The Id of a role +const attributeKey: string = iscPrivacy; // Technical name of the Attribute. +const attributeValue: string = public; // Technical name of the Attribute Value. +const result = await apiInstance.updateAttributeKeyAndValueToRoleV1(id, attributeKey, attributeValue); +console.log(result); +``` + +[[Back to top]](#) + +## update-roles-metadata-by-filter-v1 +Bulk-update roles\' metadata by filters +This API initiates a bulk update of metadata for one or more Roles by filter. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolemetadatabulkupdatebyfilterrequestV1** | **RolemetadatabulkupdatebyfilterrequestV1** | | + +### Return type + +**RolebulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const rolemetadatabulkupdatebyfilterrequestV1: RolemetadatabulkupdatebyfilterrequestV1 = {"operation":"ADD","replaceScope":"ALL","filters":"requestable eq false","values":[{"attribute":"iscFederalClassifications","values":["topSecret"]}]}; // +const result = await apiInstance.updateRolesMetadataByFilterV1(rolemetadatabulkupdatebyfilterrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-roles-metadata-by-ids-v1 +Bulk-update roles\' metadata by id +This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-ids-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolemetadatabulkupdatebyidrequestV1** | **RolemetadatabulkupdatebyidrequestV1** | | + +### Return type + +**RolebulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const rolemetadatabulkupdatebyidrequestV1: RolemetadatabulkupdatebyidrequestV1 = ; // +const result = await apiInstance.updateRolesMetadataByIdsV1(rolemetadatabulkupdatebyidrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-roles-metadata-by-query-v1 +Bulk-update roles\' metadata by query +This API initiates a bulk update of metadata for one or more Roles by query. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-roles-metadata-by-query-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**rolemetadatabulkupdatebyqueryrequestV1** | **RolemetadatabulkupdatebyqueryrequestV1** | | + +### Return type + +**RolebulkupdateresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { RolesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new RolesV1Api(configuration); +const rolemetadatabulkupdatebyqueryrequestV1: RolemetadatabulkupdatebyqueryrequestV1 = {"example of a success update":{"query":{"indices":["roles"],"queryType":"TEXT","textQuery":{"terms":["test123"],"fields":["id"],"matchAny":false,"contains":true},"includeNested":false},"operation":"REPLACE","replaceScope":"ALL","values":[{"attribute":"iscFederalClassifications","values":["secret"]}]}}; // +const result = await apiInstance.updateRolesMetadataByQueryV1(rolemetadatabulkupdatebyqueryrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/roles/docs/Models/Accessduration.md b/sdk-output/roles/docs/Models/Accessduration.md new file mode 100644 index 00000000..7fb55c3c --- /dev/null +++ b/sdk-output/roles/docs/Models/Accessduration.md @@ -0,0 +1,20 @@ +--- +id: v1-accessduration-v1 +title: AccessdurationV1 +pagination_label: AccessdurationV1 +sidebar_label: AccessdurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessdurationV1', 'v1AccessdurationV1'] +slug: /tools/sdk/typescript/roles/models/accessduration-v1 +tags: ['SDK', 'Software Development Kit', 'AccessdurationV1', 'v1AccessdurationV1'] +--- + +# AccessdurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value representing the amount of time, which is defined in the **timeUnit**. | [default to undefined] +**timeUnit** | **(optional)** **string** | The unit of time that corresponds to the **value**. It defines the scale of the time period. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Accessmodelmetadata.md b/sdk-output/roles/docs/Models/Accessmodelmetadata.md new file mode 100644 index 00000000..a1cf5ed0 --- /dev/null +++ b/sdk-output/roles/docs/Models/Accessmodelmetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-accessmodelmetadata-v1 +title: AccessmodelmetadataV1 +pagination_label: AccessmodelmetadataV1 +sidebar_label: AccessmodelmetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +slug: /tools/sdk/typescript/roles/models/accessmodelmetadata-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataV1', 'v1AccessmodelmetadataV1'] +--- + +# AccessmodelmetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Unique identifier for the metadata type | [default to undefined] +**name** | **(optional)** **string** | Human readable name of the metadata type | [default to undefined] +**multiselect** | **(optional)** **boolean** | Allows selecting multiple values | [default to false] +**status** | **(optional)** **string** | The state of the metadata item | [default to undefined] +**type** | **(optional)** **string** | The type of the metadata item | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | The types of objects | [default to undefined] +**description** | **(optional)** **string** | Describes the metadata item | [default to undefined] +**values** | **(optional)** **Array<AccessmodelmetadataValuesInnerV1>** | The value to assign to the metadata item | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/AccessmodelmetadataValuesInner.md b/sdk-output/roles/docs/Models/AccessmodelmetadataValuesInner.md new file mode 100644 index 00000000..d8d81a92 --- /dev/null +++ b/sdk-output/roles/docs/Models/AccessmodelmetadataValuesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accessmodelmetadata-values-inner-v1 +title: AccessmodelmetadataValuesInnerV1 +pagination_label: AccessmodelmetadataValuesInnerV1 +sidebar_label: AccessmodelmetadataValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +slug: /tools/sdk/typescript/roles/models/accessmodelmetadata-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessmodelmetadataValuesInnerV1', 'v1AccessmodelmetadataValuesInnerV1'] +--- + +# AccessmodelmetadataValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The value to assign to the metdata item | [default to undefined] +**name** | **(optional)** **string** | Display name of the value | [default to undefined] +**status** | **(optional)** **string** | The status of the individual value | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Accessprofileref.md b/sdk-output/roles/docs/Models/Accessprofileref.md new file mode 100644 index 00000000..c849281c --- /dev/null +++ b/sdk-output/roles/docs/Models/Accessprofileref.md @@ -0,0 +1,21 @@ +--- +id: v1-accessprofileref-v1 +title: AccessprofilerefV1 +pagination_label: AccessprofilerefV1 +sidebar_label: AccessprofilerefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessprofilerefV1', 'v1AccessprofilerefV1'] +slug: /tools/sdk/typescript/roles/models/accessprofileref-v1 +tags: ['SDK', 'Software Development Kit', 'AccessprofilerefV1', 'v1AccessprofilerefV1'] +--- + +# AccessprofilerefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the Access Profile | [default to undefined] +**type** | **(optional)** **string** | Type of requested object. This field must be either left null or set to \'ACCESS_PROFILE\' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the Access Profile. This field is ignored on input. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Additionalownerref.md b/sdk-output/roles/docs/Models/Additionalownerref.md new file mode 100644 index 00000000..5d545971 --- /dev/null +++ b/sdk-output/roles/docs/Models/Additionalownerref.md @@ -0,0 +1,21 @@ +--- +id: v1-additionalownerref-v1 +title: AdditionalownerrefV1 +pagination_label: AdditionalownerrefV1 +sidebar_label: AdditionalownerrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +slug: /tools/sdk/typescript/roles/models/additionalownerref-v1 +tags: ['SDK', 'Software Development Kit', 'AdditionalownerrefV1', 'v1AdditionalownerrefV1'] +--- + +# AdditionalownerrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the additional owner; IDENTITY for an identity, GOVERNANCE_GROUP for a governance group. | [default to undefined] +**id** | **(optional)** **string** | ID of the identity or governance group. | [default to undefined] +**name** | **(optional)** **string** | Display name. It may be left null or omitted on input. If set, it must match the current display name of the identity or governance group, otherwise a 400 Bad Request error may result. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Approvalschemeforrole.md b/sdk-output/roles/docs/Models/Approvalschemeforrole.md new file mode 100644 index 00000000..44685899 --- /dev/null +++ b/sdk-output/roles/docs/Models/Approvalschemeforrole.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalschemeforrole-v1 +title: ApprovalschemeforroleV1 +pagination_label: ApprovalschemeforroleV1 +sidebar_label: ApprovalschemeforroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalschemeforroleV1', 'v1ApprovalschemeforroleV1'] +slug: /tools/sdk/typescript/roles/models/approvalschemeforrole-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalschemeforroleV1', 'v1ApprovalschemeforroleV1'] +--- + +# ApprovalschemeforroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field. Workflow is exclusive to other types of approvals and License required. **ALL_OWNERS**: All owners of the Role, including the primary owner and any secondary owners **ADDITIONAL_OWNER**: An additional owner of the Role, the ID of which is specified by the **approverId** field **ADDITIONAL_GOVERNANCE_GROUP**: An additional Governance Group, the ID of which is specified by the **approverId** field | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used when approverType is GOVERNANCE_GROUP, WORKFLOW, or ADDITIONAL_GOVERNANCE_GROUP. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/ArrayInner.md b/sdk-output/roles/docs/Models/ArrayInner.md new file mode 100644 index 00000000..100e14d2 --- /dev/null +++ b/sdk-output/roles/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/roles/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/roles/docs/Models/Attributedto.md b/sdk-output/roles/docs/Models/Attributedto.md new file mode 100644 index 00000000..c73c1055 --- /dev/null +++ b/sdk-output/roles/docs/Models/Attributedto.md @@ -0,0 +1,26 @@ +--- +id: v1-attributedto-v1 +title: AttributedtoV1 +pagination_label: AttributedtoV1 +sidebar_label: AttributedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtoV1', 'v1AttributedtoV1'] +slug: /tools/sdk/typescript/roles/models/attributedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtoV1', 'v1AttributedtoV1'] +--- + +# AttributedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the key. | [default to undefined] +**multiselect** | **(optional)** **boolean** | Indicates whether the attribute can have multiple values. | [default to false] +**status** | **(optional)** **string** | The status of the Attribute. | [default to undefined] +**type** | **(optional)** **string** | The type of the Attribute. This can be either \"custom\" or \"governance\". | [default to undefined] +**objectTypes** | **(optional)** **Array<string>** | An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. | [default to undefined] +**description** | **(optional)** **string** | The description of the Attribute. | [default to undefined] +**values** | **(optional)** **Array<AttributevaluedtoV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Attributedtolist.md b/sdk-output/roles/docs/Models/Attributedtolist.md new file mode 100644 index 00000000..d59bacf1 --- /dev/null +++ b/sdk-output/roles/docs/Models/Attributedtolist.md @@ -0,0 +1,19 @@ +--- +id: v1-attributedtolist-v1 +title: AttributedtolistV1 +pagination_label: AttributedtolistV1 +sidebar_label: AttributedtolistV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedtolistV1', 'v1AttributedtolistV1'] +slug: /tools/sdk/typescript/roles/models/attributedtolist-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedtolistV1', 'v1AttributedtolistV1'] +--- + +# AttributedtolistV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AttributedtoV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Attributevaluedto.md b/sdk-output/roles/docs/Models/Attributevaluedto.md new file mode 100644 index 00000000..9360a73d --- /dev/null +++ b/sdk-output/roles/docs/Models/Attributevaluedto.md @@ -0,0 +1,21 @@ +--- +id: v1-attributevaluedto-v1 +title: AttributevaluedtoV1 +pagination_label: AttributevaluedtoV1 +sidebar_label: AttributevaluedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +slug: /tools/sdk/typescript/roles/models/attributevaluedto-v1 +tags: ['SDK', 'Software Development Kit', 'AttributevaluedtoV1', 'v1AttributevaluedtoV1'] +--- + +# AttributevaluedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [default to undefined] +**name** | **(optional)** **string** | The display name of the Attribute value. | [default to undefined] +**status** | **(optional)** **string** | The status of the Attribute value. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Dimensionattribute.md b/sdk-output/roles/docs/Models/Dimensionattribute.md new file mode 100644 index 00000000..7e0703f9 --- /dev/null +++ b/sdk-output/roles/docs/Models/Dimensionattribute.md @@ -0,0 +1,21 @@ +--- +id: v1-dimensionattribute-v1 +title: DimensionattributeV1 +pagination_label: DimensionattributeV1 +sidebar_label: DimensionattributeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionattributeV1', 'v1DimensionattributeV1'] +slug: /tools/sdk/typescript/roles/models/dimensionattribute-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionattributeV1', 'v1DimensionattributeV1'] +--- + +# DimensionattributeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the attribute | [default to undefined] +**displayName** | **(optional)** **string** | Display name of the attribute | [default to undefined] +**derived** | **(optional)** **boolean** | If an attribute is derived, its value comes from the identity. Otherwise, it can be provided with access request | [default to true] + diff --git a/sdk-output/roles/docs/Models/Dimensionref.md b/sdk-output/roles/docs/Models/Dimensionref.md new file mode 100644 index 00000000..46eb97e7 --- /dev/null +++ b/sdk-output/roles/docs/Models/Dimensionref.md @@ -0,0 +1,21 @@ +--- +id: v1-dimensionref-v1 +title: DimensionrefV1 +pagination_label: DimensionrefV1 +sidebar_label: DimensionrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionrefV1', 'v1DimensionrefV1'] +slug: /tools/sdk/typescript/roles/models/dimensionref-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionrefV1', 'v1DimensionrefV1'] +--- + +# DimensionrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of the object to which this reference applies | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Dimensionschema.md b/sdk-output/roles/docs/Models/Dimensionschema.md new file mode 100644 index 00000000..4204a503 --- /dev/null +++ b/sdk-output/roles/docs/Models/Dimensionschema.md @@ -0,0 +1,19 @@ +--- +id: v1-dimensionschema-v1 +title: DimensionschemaV1 +pagination_label: DimensionschemaV1 +sidebar_label: DimensionschemaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DimensionschemaV1', 'v1DimensionschemaV1'] +slug: /tools/sdk/typescript/roles/models/dimensionschema-v1 +tags: ['SDK', 'Software Development Kit', 'DimensionschemaV1', 'v1DimensionschemaV1'] +--- + +# DimensionschemaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dimensionAttributes** | **(optional)** **Array<DimensionattributeV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Dtotype.md b/sdk-output/roles/docs/Models/Dtotype.md new file mode 100644 index 00000000..c3cd504b --- /dev/null +++ b/sdk-output/roles/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/roles/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/roles/docs/Models/Entitlement.md b/sdk-output/roles/docs/Models/Entitlement.md new file mode 100644 index 00000000..3033c947 --- /dev/null +++ b/sdk-output/roles/docs/Models/Entitlement.md @@ -0,0 +1,37 @@ +--- +id: v1-entitlement-v1 +title: EntitlementV1 +pagination_label: EntitlementV1 +sidebar_label: EntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementV1', 'v1EntitlementV1'] +slug: /tools/sdk/typescript/roles/models/entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementV1', 'v1EntitlementV1'] +--- + +# EntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The entitlement id | [default to undefined] +**name** | **(optional)** **string** | The entitlement name | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement | [default to undefined] +**sourceSchemaObjectType** | **(optional)** **string** | The object type of the entitlement from the source schema | [default to undefined] +**description** | **(optional)** **string** | The description of the entitlement | [default to undefined] +**privileged** | **(optional)** **boolean** | True if the entitlement is privileged | [default to false] +**cloudGoverned** | **(optional)** **boolean** | True if the entitlement is cloud governed | [default to false] +**requestable** | **(optional)** **boolean** | True if the entitlement is able to be directly requested | [default to false] +**owner** | **(optional)** **EntitlementOwnerV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**manuallyUpdatedFields** | **(optional)** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [default to undefined] +**accessModelMetadata** | **(optional)** **EntitlementAccessModelMetadataV1** | | [default to undefined] +**created** | **(optional)** **string** | Time when the entitlement was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the entitlement was last modified | [default to undefined] +**source** | **(optional)** **EntitlementSourceV1** | | [default to undefined] +**attributes** | **(optional)** | A map of free-form key-value pairs from the source system | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Entitlement is assigned. | [default to undefined] +**directPermissions** | **(optional)** **Array<PermissiondtoV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/EntitlementAccessModelMetadata.md b/sdk-output/roles/docs/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 00000000..0ece07d0 --- /dev/null +++ b/sdk-output/roles/docs/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlement-access-model-metadata-v1 +title: EntitlementAccessModelMetadataV1 +pagination_label: EntitlementAccessModelMetadataV1 +sidebar_label: EntitlementAccessModelMetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +slug: /tools/sdk/typescript/roles/models/entitlement-access-model-metadata-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadataV1', 'v1EntitlementAccessModelMetadataV1'] +--- + +# EntitlementAccessModelMetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | **(optional)** **Array<AccessmodelmetadataV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/EntitlementOwner.md b/sdk-output/roles/docs/Models/EntitlementOwner.md new file mode 100644 index 00000000..9ab16e58 --- /dev/null +++ b/sdk-output/roles/docs/Models/EntitlementOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-owner-v1 +title: EntitlementOwnerV1 +pagination_label: EntitlementOwnerV1 +sidebar_label: EntitlementOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +slug: /tools/sdk/typescript/roles/models/entitlement-owner-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementOwnerV1', 'v1EntitlementOwnerV1'] +--- + +# EntitlementOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The identity ID | [default to undefined] +**type** | **(optional)** **string** | The type of object | [default to undefined] +**name** | **(optional)** **string** | The display name of the identity | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/EntitlementSource.md b/sdk-output/roles/docs/Models/EntitlementSource.md new file mode 100644 index 00000000..4953ea02 --- /dev/null +++ b/sdk-output/roles/docs/Models/EntitlementSource.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlement-source-v1 +title: EntitlementSourceV1 +pagination_label: EntitlementSourceV1 +sidebar_label: EntitlementSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +slug: /tools/sdk/typescript/roles/models/entitlement-source-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceV1', 'v1EntitlementSourceV1'] +--- + +# EntitlementSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The source ID | [default to undefined] +**type** | **(optional)** **string** | The source type, will always be \"SOURCE\" | [default to undefined] +**name** | **(optional)** **string** | The source name | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Entitlementref.md b/sdk-output/roles/docs/Models/Entitlementref.md new file mode 100644 index 00000000..6d69a172 --- /dev/null +++ b/sdk-output/roles/docs/Models/Entitlementref.md @@ -0,0 +1,21 @@ +--- +id: v1-entitlementref-v1 +title: EntitlementrefV1 +pagination_label: EntitlementrefV1 +sidebar_label: EntitlementrefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrefV1', 'v1EntitlementrefV1'] +slug: /tools/sdk/typescript/roles/models/entitlementref-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrefV1', 'v1EntitlementrefV1'] +--- + +# EntitlementrefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Entitlement\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Entitlement\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Entitlement\'s display name. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Errormessagedto.md b/sdk-output/roles/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b8226d6e --- /dev/null +++ b/sdk-output/roles/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/roles/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Errorresponsedto.md b/sdk-output/roles/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..c456b9b7 --- /dev/null +++ b/sdk-output/roles/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/roles/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Index.md b/sdk-output/roles/docs/Models/Index.md new file mode 100644 index 00000000..45b98a56 --- /dev/null +++ b/sdk-output/roles/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: roles-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: roles-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'roles', 'models'] +slug: /tools/sdk/typescript/roles/models +tags: ['SDK', 'Software Development Kit', 'roles', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/roles/docs/Models/Jsonpatchoperation.md b/sdk-output/roles/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..c29a8fe2 --- /dev/null +++ b/sdk-output/roles/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/roles/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/JsonpatchoperationValue.md b/sdk-output/roles/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..39300237 --- /dev/null +++ b/sdk-output/roles/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/roles/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/roles/docs/Models/ListRolesV1401Response.md b/sdk-output/roles/docs/Models/ListRolesV1401Response.md new file mode 100644 index 00000000..8686902f --- /dev/null +++ b/sdk-output/roles/docs/Models/ListRolesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-roles-v1401-response-v1 +title: ListRolesV1401ResponseV1 +pagination_label: ListRolesV1401ResponseV1 +sidebar_label: ListRolesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListRolesV1401ResponseV1', 'v1ListRolesV1401ResponseV1'] +slug: /tools/sdk/typescript/roles/models/list-roles-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListRolesV1401ResponseV1', 'v1ListRolesV1401ResponseV1'] +--- + +# ListRolesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/ListRolesV1429Response.md b/sdk-output/roles/docs/Models/ListRolesV1429Response.md new file mode 100644 index 00000000..c83b14fb --- /dev/null +++ b/sdk-output/roles/docs/Models/ListRolesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-roles-v1429-response-v1 +title: ListRolesV1429ResponseV1 +pagination_label: ListRolesV1429ResponseV1 +sidebar_label: ListRolesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListRolesV1429ResponseV1', 'v1ListRolesV1429ResponseV1'] +slug: /tools/sdk/typescript/roles/models/list-roles-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListRolesV1429ResponseV1', 'v1ListRolesV1429ResponseV1'] +--- + +# ListRolesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Localeorigin.md b/sdk-output/roles/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d5445cf4 --- /dev/null +++ b/sdk-output/roles/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/roles/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/roles/docs/Models/Ownerreference.md b/sdk-output/roles/docs/Models/Ownerreference.md new file mode 100644 index 00000000..847f6289 --- /dev/null +++ b/sdk-output/roles/docs/Models/Ownerreference.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerreference-v1 +title: OwnerreferenceV1 +pagination_label: OwnerreferenceV1 +sidebar_label: OwnerreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +slug: /tools/sdk/typescript/roles/models/ownerreference-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerreferenceV1', 'v1OwnerreferenceV1'] +--- + +# OwnerreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Permissiondto.md b/sdk-output/roles/docs/Models/Permissiondto.md new file mode 100644 index 00000000..3bc93af1 --- /dev/null +++ b/sdk-output/roles/docs/Models/Permissiondto.md @@ -0,0 +1,20 @@ +--- +id: v1-permissiondto-v1 +title: PermissiondtoV1 +pagination_label: PermissiondtoV1 +sidebar_label: PermissiondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PermissiondtoV1', 'v1PermissiondtoV1'] +slug: /tools/sdk/typescript/roles/models/permissiondto-v1 +tags: ['SDK', 'Software Development Kit', 'PermissiondtoV1', 'v1PermissiondtoV1'] +--- + +# PermissiondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rights** | **(optional)** **Array<string>** | All the rights (e.g. actions) that this permission allows on the target | [readonly] [default to undefined] +**target** | **(optional)** **string** | The target the permission would grants rights on. | [readonly] [default to undefined] + diff --git a/sdk-output/roles/docs/Models/README.md b/sdk-output/roles/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/roles/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/roles/docs/Models/Requestabilityforrole.md b/sdk-output/roles/docs/Models/Requestabilityforrole.md new file mode 100644 index 00000000..a2d62165 --- /dev/null +++ b/sdk-output/roles/docs/Models/Requestabilityforrole.md @@ -0,0 +1,26 @@ +--- +id: v1-requestabilityforrole-v1 +title: RequestabilityforroleV1 +pagination_label: RequestabilityforroleV1 +sidebar_label: RequestabilityforroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RequestabilityforroleV1', 'v1RequestabilityforroleV1'] +slug: /tools/sdk/typescript/roles/models/requestabilityforrole-v1 +tags: ['SDK', 'Software Development Kit', 'RequestabilityforroleV1', 'v1RequestabilityforroleV1'] +--- + +# RequestabilityforroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentsRequired** | **(optional)** **boolean** | Whether the requester of the containing object must provide comments justifying the request | [default to false] +**denialCommentsRequired** | **(optional)** **boolean** | Whether an approver must provide comments when denying the request | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Indicates whether reauthorization is required for the request. | [default to false] +**requireEndDate** | **(optional)** **boolean** | Indicates whether the requester of the containing object must provide access end date. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **AccessdurationV1** | | [default to undefined] +**approvalSchemes** | **(optional)** **Array<ApprovalschemeforroleV1>** | List describing the steps in approving the request | [default to undefined] +**dimensionSchema** | **(optional)** **DimensionschemaV1** | | [default to undefined] +**formDefinitionId** | **(optional)** **string** | The ID of the form definition used for the access request. If specified, the form is presented to the requester during the access request process. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Revocabilityforrole.md b/sdk-output/roles/docs/Models/Revocabilityforrole.md new file mode 100644 index 00000000..646e12e0 --- /dev/null +++ b/sdk-output/roles/docs/Models/Revocabilityforrole.md @@ -0,0 +1,21 @@ +--- +id: v1-revocabilityforrole-v1 +title: RevocabilityforroleV1 +pagination_label: RevocabilityforroleV1 +sidebar_label: RevocabilityforroleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RevocabilityforroleV1', 'v1RevocabilityforroleV1'] +slug: /tools/sdk/typescript/roles/models/revocabilityforrole-v1 +tags: ['SDK', 'Software Development Kit', 'RevocabilityforroleV1', 'v1RevocabilityforroleV1'] +--- + +# RevocabilityforroleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**commentsRequired** | **(optional)** **boolean** | Whether the requester of the containing object must provide comments justifying the request | [default to false] +**denialCommentsRequired** | **(optional)** **boolean** | Whether an approver must provide comments when denying the request | [default to false] +**approvalSchemes** | **(optional)** **Array<ApprovalschemeforroleV1>** | List describing the steps in approving the revocation request | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Role.md b/sdk-output/roles/docs/Models/Role.md new file mode 100644 index 00000000..98c30913 --- /dev/null +++ b/sdk-output/roles/docs/Models/Role.md @@ -0,0 +1,38 @@ +--- +id: v1-role-v1 +title: RoleV1 +pagination_label: RoleV1 +sidebar_label: RoleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleV1', 'v1RoleV1'] +slug: /tools/sdk/typescript/roles/models/role-v1 +tags: ['SDK', 'Software Development Kit', 'RoleV1', 'v1RoleV1'] +--- + +# RoleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [default to undefined] +**name** | **string** | The human-readable display name of the Role | [default to undefined] +**created** | **(optional)** **string** | Date the Role was created | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Date the Role was last modified. | [readonly] [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the Role | [default to undefined] +**owner** | **OwnerreferenceV1** | | [default to undefined] +**additionalOwners** | **(optional)** **Array<AdditionalownerrefV1>** | List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP). | [default to undefined] +**accessProfiles** | **(optional)** **Array<AccessprofilerefV1>** | | [default to undefined] +**entitlements** | **(optional)** **Array<EntitlementrefV1>** | | [default to undefined] +**membership** | **(optional)** **RolemembershipselectorV1** | | [default to undefined] +**legacyMembershipInfo** | **(optional)** | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [default to undefined] +**enabled** | **(optional)** **boolean** | Whether the Role is enabled or not. | [default to false] +**requestable** | **(optional)** **boolean** | Whether the Role can be the target of access requests. | [default to false] +**accessRequestConfig** | **(optional)** **RequestabilityforroleV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **RevocabilityforroleV1** | | [default to undefined] +**segments** | **(optional)** **Array<string>** | List of IDs of segments, if any, to which this Role is assigned. | [default to undefined] +**dimensional** | **(optional)** **boolean** | Whether the Role is dimensional. | [default to false] +**dimensionRefs** | **(optional)** **Array<DimensionrefV1>** | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [default to undefined] +**accessModelMetadata** | **(optional)** **AttributedtolistV1** | | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The privilege level of the role, if applicable. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Roleassignmentsourcetype.md b/sdk-output/roles/docs/Models/Roleassignmentsourcetype.md new file mode 100644 index 00000000..c4851b55 --- /dev/null +++ b/sdk-output/roles/docs/Models/Roleassignmentsourcetype.md @@ -0,0 +1,21 @@ +--- +id: v1-roleassignmentsourcetype-v1 +title: RoleassignmentsourcetypeV1 +pagination_label: RoleassignmentsourcetypeV1 +sidebar_label: RoleassignmentsourcetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleassignmentsourcetypeV1', 'v1RoleassignmentsourcetypeV1'] +slug: /tools/sdk/typescript/roles/models/roleassignmentsourcetype-v1 +tags: ['SDK', 'Software Development Kit', 'RoleassignmentsourcetypeV1', 'v1RoleassignmentsourcetypeV1'] +--- + +# RoleassignmentsourcetypeV1 + +## Enum + + +* `AccessRequest` (value: `'ACCESS_REQUEST'`) + +* `RoleMembership` (value: `'ROLE_MEMBERSHIP'`) + + diff --git a/sdk-output/roles/docs/Models/Rolebulkdeleterequest.md b/sdk-output/roles/docs/Models/Rolebulkdeleterequest.md new file mode 100644 index 00000000..6879e20b --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolebulkdeleterequest.md @@ -0,0 +1,19 @@ +--- +id: v1-rolebulkdeleterequest-v1 +title: RolebulkdeleterequestV1 +pagination_label: RolebulkdeleterequestV1 +sidebar_label: RolebulkdeleterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolebulkdeleterequestV1', 'v1RolebulkdeleterequestV1'] +slug: /tools/sdk/typescript/roles/models/rolebulkdeleterequest-v1 +tags: ['SDK', 'Software Development Kit', 'RolebulkdeleterequestV1', 'v1RolebulkdeleterequestV1'] +--- + +# RolebulkdeleterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roleIds** | **Array<string>** | List of IDs of Roles to be deleted. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolebulkupdateresponse.md b/sdk-output/roles/docs/Models/Rolebulkupdateresponse.md new file mode 100644 index 00000000..3c40fc6d --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolebulkupdateresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-rolebulkupdateresponse-v1 +title: RolebulkupdateresponseV1 +pagination_label: RolebulkupdateresponseV1 +sidebar_label: RolebulkupdateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolebulkupdateresponseV1', 'v1RolebulkupdateresponseV1'] +slug: /tools/sdk/typescript/roles/models/rolebulkupdateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RolebulkupdateresponseV1', 'v1RolebulkupdateresponseV1'] +--- + +# RolebulkupdateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [default to undefined] +**type** | **(optional)** **string** | Type of the bulk update object. | [default to undefined] +**status** | **(optional)** **string** | The status of the bulk update request, could also checked by getBulkUpdateStatus API | [default to undefined] +**created** | **(optional)** **string** | Time when the bulk update request was created | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolecriteriakey.md b/sdk-output/roles/docs/Models/Rolecriteriakey.md new file mode 100644 index 00000000..455a2b8e --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriteriakey.md @@ -0,0 +1,21 @@ +--- +id: v1-rolecriteriakey-v1 +title: RolecriteriakeyV1 +pagination_label: RolecriteriakeyV1 +sidebar_label: RolecriteriakeyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolecriteriakeyV1', 'v1RolecriteriakeyV1'] +slug: /tools/sdk/typescript/roles/models/rolecriteriakey-v1 +tags: ['SDK', 'Software Development Kit', 'RolecriteriakeyV1', 'v1RolecriteriakeyV1'] +--- + +# RolecriteriakeyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **RolecriteriakeytypeV1** | | [default to undefined] +**property** | **string** | The name of the attribute or entitlement to which the associated criteria applies. | [default to undefined] +**sourceId** | **(optional)** **string** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolecriteriakeytype.md b/sdk-output/roles/docs/Models/Rolecriteriakeytype.md new file mode 100644 index 00000000..2be8cfd5 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriteriakeytype.md @@ -0,0 +1,23 @@ +--- +id: v1-rolecriteriakeytype-v1 +title: RolecriteriakeytypeV1 +pagination_label: RolecriteriakeytypeV1 +sidebar_label: RolecriteriakeytypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolecriteriakeytypeV1', 'v1RolecriteriakeytypeV1'] +slug: /tools/sdk/typescript/roles/models/rolecriteriakeytype-v1 +tags: ['SDK', 'Software Development Kit', 'RolecriteriakeytypeV1', 'v1RolecriteriakeytypeV1'] +--- + +# RolecriteriakeytypeV1 + +## Enum + + +* `Identity` (value: `'IDENTITY'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + + diff --git a/sdk-output/roles/docs/Models/Rolecriterialevel1.md b/sdk-output/roles/docs/Models/Rolecriterialevel1.md new file mode 100644 index 00000000..afbcb373 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriterialevel1.md @@ -0,0 +1,22 @@ +--- +id: v1-rolecriterialevel1-v1 +title: Rolecriterialevel1V1 +pagination_label: Rolecriterialevel1V1 +sidebar_label: Rolecriterialevel1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Rolecriterialevel1V1', 'v1Rolecriterialevel1V1'] +slug: /tools/sdk/typescript/roles/models/rolecriterialevel1-v1 +tags: ['SDK', 'Software Development Kit', 'Rolecriterialevel1V1', 'v1Rolecriterialevel1V1'] +--- + +# Rolecriterialevel1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **RolecriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **RolecriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [default to undefined] +**children** | **(optional)** **Array<Rolecriterialevel2V1>** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolecriterialevel2.md b/sdk-output/roles/docs/Models/Rolecriterialevel2.md new file mode 100644 index 00000000..09195a46 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriterialevel2.md @@ -0,0 +1,22 @@ +--- +id: v1-rolecriterialevel2-v1 +title: Rolecriterialevel2V1 +pagination_label: Rolecriterialevel2V1 +sidebar_label: Rolecriterialevel2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Rolecriterialevel2V1', 'v1Rolecriterialevel2V1'] +slug: /tools/sdk/typescript/roles/models/rolecriterialevel2-v1 +tags: ['SDK', 'Software Development Kit', 'Rolecriterialevel2V1', 'v1Rolecriterialevel2V1'] +--- + +# Rolecriterialevel2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **RolecriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **RolecriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [default to undefined] +**children** | **(optional)** **Array<Rolecriterialevel3V1>** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolecriterialevel3.md b/sdk-output/roles/docs/Models/Rolecriterialevel3.md new file mode 100644 index 00000000..409a60ef --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriterialevel3.md @@ -0,0 +1,21 @@ +--- +id: v1-rolecriterialevel3-v1 +title: Rolecriterialevel3V1 +pagination_label: Rolecriterialevel3V1 +sidebar_label: Rolecriterialevel3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Rolecriterialevel3V1', 'v1Rolecriterialevel3V1'] +slug: /tools/sdk/typescript/roles/models/rolecriterialevel3-v1 +tags: ['SDK', 'Software Development Kit', 'Rolecriterialevel3V1', 'v1Rolecriterialevel3V1'] +--- + +# Rolecriterialevel3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **(optional)** **RolecriteriaoperationV1** | | [default to undefined] +**key** | **(optional)** **RolecriteriakeyV1** | | [default to undefined] +**stringValue** | **(optional)** **string** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, DOES_NOT_CONTAIN, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolecriteriaoperation.md b/sdk-output/roles/docs/Models/Rolecriteriaoperation.md new file mode 100644 index 00000000..c92cf0d6 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolecriteriaoperation.md @@ -0,0 +1,41 @@ +--- +id: v1-rolecriteriaoperation-v1 +title: RolecriteriaoperationV1 +pagination_label: RolecriteriaoperationV1 +sidebar_label: RolecriteriaoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolecriteriaoperationV1', 'v1RolecriteriaoperationV1'] +slug: /tools/sdk/typescript/roles/models/rolecriteriaoperation-v1 +tags: ['SDK', 'Software Development Kit', 'RolecriteriaoperationV1', 'v1RolecriteriaoperationV1'] +--- + +# RolecriteriaoperationV1 + +## Enum + + +* `Equals` (value: `'EQUALS'`) + +* `NotEquals` (value: `'NOT_EQUALS'`) + +* `Contains` (value: `'CONTAINS'`) + +* `DoesNotContain` (value: `'DOES_NOT_CONTAIN'`) + +* `StartsWith` (value: `'STARTS_WITH'`) + +* `EndsWith` (value: `'ENDS_WITH'`) + +* `GreaterThan` (value: `'GREATER_THAN'`) + +* `LessThan` (value: `'LESS_THAN'`) + +* `GreaterThanEquals` (value: `'GREATER_THAN_EQUALS'`) + +* `LessThanEquals` (value: `'LESS_THAN_EQUALS'`) + +* `And` (value: `'AND'`) + +* `Or` (value: `'OR'`) + + diff --git a/sdk-output/roles/docs/Models/Rolegetallbulkupdateresponse.md b/sdk-output/roles/docs/Models/Rolegetallbulkupdateresponse.md new file mode 100644 index 00000000..861ba2b3 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolegetallbulkupdateresponse.md @@ -0,0 +1,22 @@ +--- +id: v1-rolegetallbulkupdateresponse-v1 +title: RolegetallbulkupdateresponseV1 +pagination_label: RolegetallbulkupdateresponseV1 +sidebar_label: RolegetallbulkupdateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolegetallbulkupdateresponseV1', 'v1RolegetallbulkupdateresponseV1'] +slug: /tools/sdk/typescript/roles/models/rolegetallbulkupdateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'RolegetallbulkupdateresponseV1', 'v1RolegetallbulkupdateresponseV1'] +--- + +# RolegetallbulkupdateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the task which is executing the bulk update. This also used in to the bulk-update/_** API to track status. | [default to undefined] +**type** | **(optional)** **string** | Type of the bulk update object. | [default to undefined] +**status** | **(optional)** **string** | The status of the bulk update request, only list unfinished request\'s status, the status could also checked by getBulkUpdateStatus API | [default to undefined] +**created** | **(optional)** **string** | Time when the bulk update request was created | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Roleidentity.md b/sdk-output/roles/docs/Models/Roleidentity.md new file mode 100644 index 00000000..aed44352 --- /dev/null +++ b/sdk-output/roles/docs/Models/Roleidentity.md @@ -0,0 +1,23 @@ +--- +id: v1-roleidentity-v1 +title: RoleidentityV1 +pagination_label: RoleidentityV1 +sidebar_label: RoleidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RoleidentityV1', 'v1RoleidentityV1'] +slug: /tools/sdk/typescript/roles/models/roleidentity-v1 +tags: ['SDK', 'Software Development Kit', 'RoleidentityV1', 'v1RoleidentityV1'] +--- + +# RoleidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the Identity | [default to undefined] +**aliasName** | **(optional)** **string** | The alias / username of the Identity | [default to undefined] +**name** | **(optional)** **string** | The human-readable display name of the Identity | [default to undefined] +**email** | **(optional)** **string** | Email address of the Identity | [default to undefined] +**roleAssignmentSource** | **(optional)** **RoleassignmentsourcetypeV1** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolelistfilterdto.md b/sdk-output/roles/docs/Models/Rolelistfilterdto.md new file mode 100644 index 00000000..9920f96f --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolelistfilterdto.md @@ -0,0 +1,20 @@ +--- +id: v1-rolelistfilterdto-v1 +title: RolelistfilterdtoV1 +pagination_label: RolelistfilterdtoV1 +sidebar_label: RolelistfilterdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolelistfilterdtoV1', 'v1RolelistfilterdtoV1'] +slug: /tools/sdk/typescript/roles/models/rolelistfilterdto-v1 +tags: ['SDK', 'Software Development Kit', 'RolelistfilterdtoV1', 'v1RolelistfilterdtoV1'] +--- + +# RolelistfilterdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **(optional)** **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* | [default to undefined] +**ammKeyValues** | **(optional)** **Array<RolelistfilterdtoAmmKeyValuesInnerV1>** | | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/RolelistfilterdtoAmmKeyValuesInner.md b/sdk-output/roles/docs/Models/RolelistfilterdtoAmmKeyValuesInner.md new file mode 100644 index 00000000..7b4da156 --- /dev/null +++ b/sdk-output/roles/docs/Models/RolelistfilterdtoAmmKeyValuesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-rolelistfilterdto-amm-key-values-inner-v1 +title: RolelistfilterdtoAmmKeyValuesInnerV1 +pagination_label: RolelistfilterdtoAmmKeyValuesInnerV1 +sidebar_label: RolelistfilterdtoAmmKeyValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolelistfilterdtoAmmKeyValuesInnerV1', 'v1RolelistfilterdtoAmmKeyValuesInnerV1'] +slug: /tools/sdk/typescript/roles/models/rolelistfilterdto-amm-key-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'RolelistfilterdtoAmmKeyValuesInnerV1', 'v1RolelistfilterdtoAmmKeyValuesInnerV1'] +--- + +# RolelistfilterdtoAmmKeyValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **(optional)** **string** | attribute key of a metadata. | [default to undefined] +**values** | **(optional)** **Array<string>** | A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolemembershipidentity.md b/sdk-output/roles/docs/Models/Rolemembershipidentity.md new file mode 100644 index 00000000..5df8c933 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemembershipidentity.md @@ -0,0 +1,22 @@ +--- +id: v1-rolemembershipidentity-v1 +title: RolemembershipidentityV1 +pagination_label: RolemembershipidentityV1 +sidebar_label: RolemembershipidentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemembershipidentityV1', 'v1RolemembershipidentityV1'] +slug: /tools/sdk/typescript/roles/models/rolemembershipidentity-v1 +tags: ['SDK', 'Software Development Kit', 'RolemembershipidentityV1', 'v1RolemembershipidentityV1'] +--- + +# RolemembershipidentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the Identity. | [default to undefined] +**aliasName** | **(optional)** **string** | User name of the Identity | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolemembershipselector.md b/sdk-output/roles/docs/Models/Rolemembershipselector.md new file mode 100644 index 00000000..b03ff5f8 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemembershipselector.md @@ -0,0 +1,21 @@ +--- +id: v1-rolemembershipselector-v1 +title: RolemembershipselectorV1 +pagination_label: RolemembershipselectorV1 +sidebar_label: RolemembershipselectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemembershipselectorV1', 'v1RolemembershipselectorV1'] +slug: /tools/sdk/typescript/roles/models/rolemembershipselector-v1 +tags: ['SDK', 'Software Development Kit', 'RolemembershipselectorV1', 'v1RolemembershipselectorV1'] +--- + +# RolemembershipselectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **RolemembershipselectortypeV1** | | [default to undefined] +**criteria** | **(optional)** **Rolecriterialevel1V1** | | [default to undefined] +**identities** | **(optional)** **Array<RolemembershipidentityV1>** | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolemembershipselectortype.md b/sdk-output/roles/docs/Models/Rolemembershipselectortype.md new file mode 100644 index 00000000..c1e6c1cb --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemembershipselectortype.md @@ -0,0 +1,21 @@ +--- +id: v1-rolemembershipselectortype-v1 +title: RolemembershipselectortypeV1 +pagination_label: RolemembershipselectortypeV1 +sidebar_label: RolemembershipselectortypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemembershipselectortypeV1', 'v1RolemembershipselectortypeV1'] +slug: /tools/sdk/typescript/roles/models/rolemembershipselectortype-v1 +tags: ['SDK', 'Software Development Kit', 'RolemembershipselectortypeV1', 'v1RolemembershipselectortypeV1'] +--- + +# RolemembershipselectortypeV1 + +## Enum + + +* `Standard` (value: `'STANDARD'`) + +* `IdentityList` (value: `'IDENTITY_LIST'`) + + diff --git a/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyfilterrequest.md b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyfilterrequest.md new file mode 100644 index 00000000..6274cfaf --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyfilterrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-rolemetadatabulkupdatebyfilterrequest-v1 +title: RolemetadatabulkupdatebyfilterrequestV1 +pagination_label: RolemetadatabulkupdatebyfilterrequestV1 +sidebar_label: RolemetadatabulkupdatebyfilterrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyfilterrequestV1', 'v1RolemetadatabulkupdatebyfilterrequestV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyfilterrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyfilterrequestV1', 'v1RolemetadatabulkupdatebyfilterrequestV1'] +--- + +# RolemetadatabulkupdatebyfilterrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filters** | **string** | Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* | [default to undefined] +**operation** | **string** | The operation to be performed | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **Array<RolemetadatabulkupdatebyfilterrequestValuesInnerV1>** | The metadata to be updated, including attribute key and value. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyfilterrequestValuesInner.md b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyfilterrequestValuesInner.md new file mode 100644 index 00000000..6ee48634 --- /dev/null +++ b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyfilterrequestValuesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-rolemetadatabulkupdatebyfilterrequest-values-inner-v1 +title: RolemetadatabulkupdatebyfilterrequestValuesInnerV1 +pagination_label: RolemetadatabulkupdatebyfilterrequestValuesInnerV1 +sidebar_label: RolemetadatabulkupdatebyfilterrequestValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyfilterrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyfilterrequestValuesInnerV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyfilterrequest-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyfilterrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyfilterrequestValuesInnerV1'] +--- + +# RolemetadatabulkupdatebyfilterrequestValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeKey** | **(optional)** **string** | the key of metadata attribute | [default to undefined] +**values** | **Array<string>** | the values of attribute to be updated | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyidrequest.md b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyidrequest.md new file mode 100644 index 00000000..1aed53b0 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyidrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-rolemetadatabulkupdatebyidrequest-v1 +title: RolemetadatabulkupdatebyidrequestV1 +pagination_label: RolemetadatabulkupdatebyidrequestV1 +sidebar_label: RolemetadatabulkupdatebyidrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyidrequestV1', 'v1RolemetadatabulkupdatebyidrequestV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyidrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyidrequestV1', 'v1RolemetadatabulkupdatebyidrequestV1'] +--- + +# RolemetadatabulkupdatebyidrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**roles** | **Array<string>** | Roles\' Id to be updated | [default to undefined] +**operation** | **string** | The operation to be performed | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **Array<RolemetadatabulkupdatebyidrequestValuesInnerV1>** | The metadata to be updated, including attribute key and value. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyidrequestValuesInner.md b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyidrequestValuesInner.md new file mode 100644 index 00000000..5b7ba37a --- /dev/null +++ b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyidrequestValuesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-rolemetadatabulkupdatebyidrequest-values-inner-v1 +title: RolemetadatabulkupdatebyidrequestValuesInnerV1 +pagination_label: RolemetadatabulkupdatebyidrequestValuesInnerV1 +sidebar_label: RolemetadatabulkupdatebyidrequestValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyidrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyidrequestValuesInnerV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyidrequest-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyidrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyidrequestValuesInnerV1'] +--- + +# RolemetadatabulkupdatebyidrequestValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **string** | the key of metadata attribute | [default to undefined] +**values** | **Array<string>** | the values of attribute to be updated | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyqueryrequest.md b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyqueryrequest.md new file mode 100644 index 00000000..882b9f07 --- /dev/null +++ b/sdk-output/roles/docs/Models/Rolemetadatabulkupdatebyqueryrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-rolemetadatabulkupdatebyqueryrequest-v1 +title: RolemetadatabulkupdatebyqueryrequestV1 +pagination_label: RolemetadatabulkupdatebyqueryrequestV1 +sidebar_label: RolemetadatabulkupdatebyqueryrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyqueryrequestV1', 'v1RolemetadatabulkupdatebyqueryrequestV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyqueryrequest-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyqueryrequestV1', 'v1RolemetadatabulkupdatebyqueryrequestV1'] +--- + +# RolemetadatabulkupdatebyqueryrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **object** | query the identities to be updated | [default to undefined] +**operation** | **string** | The operation to be performed | [default to undefined] +**replaceScope** | **(optional)** **string** | The choice of update scope. | [default to undefined] +**values** | **Array<RolemetadatabulkupdatebyqueryrequestValuesInnerV1>** | The metadata to be updated, including attribute key and value. | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyqueryrequestValuesInner.md b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyqueryrequestValuesInner.md new file mode 100644 index 00000000..71c1ff46 --- /dev/null +++ b/sdk-output/roles/docs/Models/RolemetadatabulkupdatebyqueryrequestValuesInner.md @@ -0,0 +1,20 @@ +--- +id: v1-rolemetadatabulkupdatebyqueryrequest-values-inner-v1 +title: RolemetadatabulkupdatebyqueryrequestValuesInnerV1 +pagination_label: RolemetadatabulkupdatebyqueryrequestValuesInnerV1 +sidebar_label: RolemetadatabulkupdatebyqueryrequestValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RolemetadatabulkupdatebyqueryrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyqueryrequestValuesInnerV1'] +slug: /tools/sdk/typescript/roles/models/rolemetadatabulkupdatebyqueryrequest-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'RolemetadatabulkupdatebyqueryrequestValuesInnerV1', 'v1RolemetadatabulkupdatebyqueryrequestValuesInnerV1'] +--- + +# RolemetadatabulkupdatebyqueryrequestValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeKey** | **(optional)** **string** | the key of metadata attribute | [default to undefined] +**attributeValue** | **(optional)** **Array<string>** | the values of attribute to be updated | [default to undefined] + diff --git a/sdk-output/roles/docs/Models/Taskresultdto.md b/sdk-output/roles/docs/Models/Taskresultdto.md new file mode 100644 index 00000000..56446941 --- /dev/null +++ b/sdk-output/roles/docs/Models/Taskresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taskresultdto-v1 +title: TaskresultdtoV1 +pagination_label: TaskresultdtoV1 +sidebar_label: TaskresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +slug: /tools/sdk/typescript/roles/models/taskresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +--- + +# TaskresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Task result DTO type. | [default to undefined] +**id** | **(optional)** **string** | Task result ID. | [default to undefined] +**name** | **(optional)** **string** | Task result display name. | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/saved_search/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..2c460b46 --- /dev/null +++ b/sdk-output/saved_search/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,95 @@ +- path: /saved-searches/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#create-saved-search-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const createSavedSearchV1RequestV1: CreateSavedSearchV1RequestV1 = ; // CreateSavedSearchV1RequestV1 | The saved search to persist. + const result = await apiInstance.createSavedSearchV1(createSavedSearchV1RequestV1); + console.log(result); +- path: /saved-searches/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#delete-saved-search-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const result = await apiInstance.deleteSavedSearchV1(id); + console.log(result); +- path: /saved-searches/v1/{id}/execute + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#execute-saved-search-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const searchargumentsV1: SearchargumentsV1 = ; // SearchargumentsV1 | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + const result = await apiInstance.executeSavedSearchV1(id, searchargumentsV1); + console.log(result); +- path: /saved-searches/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#get-saved-search-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const result = await apiInstance.getSavedSearchV1(id); + console.log(result); +- path: /saved-searches/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#list-saved-searches-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) (default to undefined) + const result = await apiInstance.listSavedSearchesV1(); + console.log(result); +- path: /saved-searches/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/saved_search/methods/saved-search#put-saved-search-v1 + source: | + import { SavedSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SavedSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const savedsearchV1: SavedsearchV1 = ; // SavedsearchV1 | The saved search to persist. + const result = await apiInstance.putSavedSearchV1(id, savedsearchV1); + console.log(result); diff --git a/sdk-output/saved_search/docs/Methods/Index.md b/sdk-output/saved_search/docs/Methods/Index.md new file mode 100644 index 00000000..c2b176bf --- /dev/null +++ b/sdk-output/saved_search/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: saved_search-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: saved_search-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'saved_search', 'methods'] +slug: /tools/sdk/typescript/saved_search/methods +tags: ['SDK', 'Software Development Kit', 'saved_search', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/saved_search/docs/Methods/SavedSearchV1Api.md b/sdk-output/saved_search/docs/Methods/SavedSearchV1Api.md new file mode 100644 index 00000000..4b54942d --- /dev/null +++ b/sdk-output/saved_search/docs/Methods/SavedSearchV1Api.md @@ -0,0 +1,281 @@ +--- +id: v1-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedSearch', 'v1SavedSearch'] +slug: /tools/sdk/typescript/saved_search/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'v1SavedSearch'] +--- + +# SavedSearchV1Api + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v2025/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-saved-search-v1**](#create-saved-search-v1) | **POST** `/saved-searches/v1` | Create a saved search +[**delete-saved-search-v1**](#delete-saved-search-v1) | **DELETE** `/saved-searches/v1/{id}` | Delete document by id +[**execute-saved-search-v1**](#execute-saved-search-v1) | **POST** `/saved-searches/v1/{id}/execute` | Execute a saved search by id +[**get-saved-search-v1**](#get-saved-search-v1) | **GET** `/saved-searches/v1/{id}` | Return saved search by id +[**list-saved-searches-v1**](#list-saved-searches-v1) | **GET** `/saved-searches/v1` | A list of saved searches +[**put-saved-search-v1**](#put-saved-search-v1) | **PUT** `/saved-searches/v1/{id}` | Updates an existing saved search + + +## create-saved-search-v1 +Create a saved search +Creates a new saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-saved-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createSavedSearchV1RequestV1** | **CreateSavedSearchV1RequestV1** | The saved search to persist. | + +### Return type + +**SavedsearchV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const createSavedSearchV1RequestV1: CreateSavedSearchV1RequestV1 = ; // The saved search to persist. +const result = await apiInstance.createSavedSearchV1(createSavedSearchV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-saved-search-v1 +Delete document by id +Deletes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-saved-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const result = await apiInstance.deleteSavedSearchV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## execute-saved-search-v1 +Execute a saved search by id +Executes the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/execute-saved-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] +**searchargumentsV1** | **SearchargumentsV1** | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const searchargumentsV1: SearchargumentsV1 = ; // When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. +const result = await apiInstance.executeSavedSearchV1(id, searchargumentsV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-saved-search-v1 +Return saved search by id +Returns the specified saved search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-saved-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] + +### Return type + +**SavedsearchV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const result = await apiInstance.getSavedSearchV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-saved-searches-v1 +A list of saved searches +Returns a list of saved searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-saved-searches-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) +const result = await apiInstance.listSavedSearchesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-saved-search-v1 +Updates an existing saved search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-saved-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] +**savedsearchV1** | **SavedsearchV1** | The saved search to persist. | + +### Return type + +**SavedsearchV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SavedSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SavedSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const savedsearchV1: SavedsearchV1 = ; // The saved search to persist. +const result = await apiInstance.putSavedSearchV1(id, savedsearchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/saved_search/docs/Models/Bound.md b/sdk-output/saved_search/docs/Models/Bound.md new file mode 100644 index 00000000..8e6a58a0 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Bound.md @@ -0,0 +1,20 @@ +--- +id: v1-bound-v1 +title: BoundV1 +pagination_label: BoundV1 +sidebar_label: BoundV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BoundV1', 'v1BoundV1'] +slug: /tools/sdk/typescript/saved_search/models/bound-v1 +tags: ['SDK', 'Software Development Kit', 'BoundV1', 'v1BoundV1'] +--- + +# BoundV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **string** | The value of the range\'s endpoint. | [default to undefined] +**inclusive** | **(optional)** **boolean** | Indicates if the endpoint is included in the range. | [default to false] + diff --git a/sdk-output/saved_search/docs/Models/Column.md b/sdk-output/saved_search/docs/Models/Column.md new file mode 100644 index 00000000..94b98783 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Column.md @@ -0,0 +1,20 @@ +--- +id: v1-column-v1 +title: ColumnV1 +pagination_label: ColumnV1 +sidebar_label: ColumnV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ColumnV1', 'v1ColumnV1'] +slug: /tools/sdk/typescript/saved_search/models/column-v1 +tags: ['SDK', 'Software Development Kit', 'ColumnV1', 'v1ColumnV1'] +--- + +# ColumnV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**field** | **string** | The name of the field. | [default to undefined] +**header** | **(optional)** **string** | The value of the header. | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/CreateSavedSearchV1Request.md b/sdk-output/saved_search/docs/Models/CreateSavedSearchV1Request.md new file mode 100644 index 00000000..3696ee40 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/CreateSavedSearchV1Request.md @@ -0,0 +1,29 @@ +--- +id: v1-create-saved-search-v1-request-v1 +title: CreateSavedSearchV1RequestV1 +pagination_label: CreateSavedSearchV1RequestV1 +sidebar_label: CreateSavedSearchV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateSavedSearchV1RequestV1', 'v1CreateSavedSearchV1RequestV1'] +slug: /tools/sdk/typescript/saved_search/models/create-saved-search-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchV1RequestV1', 'v1CreateSavedSearchV1RequestV1'] +--- + +# CreateSavedSearchV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the saved search. | [default to undefined] +**description** | **(optional)** **string** | The description of the saved search. | [default to undefined] +**created** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**modified** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**indices** | **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. | [default to undefined] +**columns** | **(optional)** | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [default to undefined] +**query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [default to undefined] +**fields** | **(optional)** **Array<string>** | The fields to be searched against in a multi-field query. | [default to undefined] +**orderBy** | **(optional)** | Sort by index. This takes precedence over the `sort` property. | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. | [default to undefined] +**filters** | **(optional)** **SavedsearchdetailFiltersV1** | | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Dtotype.md b/sdk-output/saved_search/docs/Models/Dtotype.md new file mode 100644 index 00000000..c74b60c1 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/saved_search/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/saved_search/docs/Models/Errormessagedto.md b/sdk-output/saved_search/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..de11b71c --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/saved_search/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Errorresponsedto.md b/sdk-output/saved_search/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..89e107e8 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/saved_search/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Filter.md b/sdk-output/saved_search/docs/Models/Filter.md new file mode 100644 index 00000000..46271524 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Filter.md @@ -0,0 +1,22 @@ +--- +id: v1-filter-v1 +title: FilterV1 +pagination_label: FilterV1 +sidebar_label: FilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FilterV1', 'v1FilterV1'] +slug: /tools/sdk/typescript/saved_search/models/filter-v1 +tags: ['SDK', 'Software Development Kit', 'FilterV1', 'v1FilterV1'] +--- + +# FilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **FiltertypeV1** | | [default to undefined] +**range** | **(optional)** **RangeV1** | | [default to undefined] +**terms** | **(optional)** **Array<string>** | The terms to be filtered. | [default to undefined] +**exclude** | **(optional)** **boolean** | Indicates if the filter excludes results. | [default to false] + diff --git a/sdk-output/saved_search/docs/Models/Filtertype.md b/sdk-output/saved_search/docs/Models/Filtertype.md new file mode 100644 index 00000000..f6084b1e --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Filtertype.md @@ -0,0 +1,23 @@ +--- +id: v1-filtertype-v1 +title: FiltertypeV1 +pagination_label: FiltertypeV1 +sidebar_label: FiltertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FiltertypeV1', 'v1FiltertypeV1'] +slug: /tools/sdk/typescript/saved_search/models/filtertype-v1 +tags: ['SDK', 'Software Development Kit', 'FiltertypeV1', 'v1FiltertypeV1'] +--- + +# FiltertypeV1 + +## Enum + + +* `Exists` (value: `'EXISTS'`) + +* `Range` (value: `'RANGE'`) + +* `Terms` (value: `'TERMS'`) + + diff --git a/sdk-output/saved_search/docs/Models/Index.md b/sdk-output/saved_search/docs/Models/Index.md new file mode 100644 index 00000000..10155272 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: saved_search-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: saved_search-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'saved_search', 'models'] +slug: /tools/sdk/typescript/saved_search/models +tags: ['SDK', 'Software Development Kit', 'saved_search', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/saved_search/docs/Models/ListSavedSearchesV1401Response.md b/sdk-output/saved_search/docs/Models/ListSavedSearchesV1401Response.md new file mode 100644 index 00000000..70b4be06 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/ListSavedSearchesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-saved-searches-v1401-response-v1 +title: ListSavedSearchesV1401ResponseV1 +pagination_label: ListSavedSearchesV1401ResponseV1 +sidebar_label: ListSavedSearchesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSavedSearchesV1401ResponseV1', 'v1ListSavedSearchesV1401ResponseV1'] +slug: /tools/sdk/typescript/saved_search/models/list-saved-searches-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSavedSearchesV1401ResponseV1', 'v1ListSavedSearchesV1401ResponseV1'] +--- + +# ListSavedSearchesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/ListSavedSearchesV1429Response.md b/sdk-output/saved_search/docs/Models/ListSavedSearchesV1429Response.md new file mode 100644 index 00000000..ae0835de --- /dev/null +++ b/sdk-output/saved_search/docs/Models/ListSavedSearchesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-saved-searches-v1429-response-v1 +title: ListSavedSearchesV1429ResponseV1 +pagination_label: ListSavedSearchesV1429ResponseV1 +sidebar_label: ListSavedSearchesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSavedSearchesV1429ResponseV1', 'v1ListSavedSearchesV1429ResponseV1'] +slug: /tools/sdk/typescript/saved_search/models/list-saved-searches-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSavedSearchesV1429ResponseV1', 'v1ListSavedSearchesV1429ResponseV1'] +--- + +# ListSavedSearchesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Localeorigin.md b/sdk-output/saved_search/docs/Models/Localeorigin.md new file mode 100644 index 00000000..afb1f46e --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/saved_search/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/saved_search/docs/Models/README.md b/sdk-output/saved_search/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/saved_search/docs/Models/Range.md b/sdk-output/saved_search/docs/Models/Range.md new file mode 100644 index 00000000..172476dc --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Range.md @@ -0,0 +1,20 @@ +--- +id: v1-range-v1 +title: RangeV1 +pagination_label: RangeV1 +sidebar_label: RangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RangeV1', 'v1RangeV1'] +slug: /tools/sdk/typescript/saved_search/models/range-v1 +tags: ['SDK', 'Software Development Kit', 'RangeV1', 'v1RangeV1'] +--- + +# RangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | **(optional)** **BoundV1** | | [default to undefined] +**upper** | **(optional)** **BoundV1** | | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Savedsearch.md b/sdk-output/saved_search/docs/Models/Savedsearch.md new file mode 100644 index 00000000..4372b8c6 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Savedsearch.md @@ -0,0 +1,33 @@ +--- +id: v1-savedsearch-v1 +title: SavedsearchV1 +pagination_label: SavedsearchV1 +sidebar_label: SavedsearchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchV1', 'v1SavedsearchV1'] +slug: /tools/sdk/typescript/saved_search/models/savedsearch-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchV1', 'v1SavedsearchV1'] +--- + +# SavedsearchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the saved search. | [default to undefined] +**description** | **(optional)** **string** | The description of the saved search. | [default to undefined] +**created** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**modified** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**indices** | **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. | [default to undefined] +**columns** | **(optional)** | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [default to undefined] +**query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [default to undefined] +**fields** | **(optional)** **Array<string>** | The fields to be searched against in a multi-field query. | [default to undefined] +**orderBy** | **(optional)** | Sort by index. This takes precedence over the `sort` property. | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. | [default to undefined] +**filters** | **(optional)** **SavedsearchdetailFiltersV1** | | [default to undefined] +**id** | **(optional)** **string** | The saved search ID. | [default to undefined] +**owner** | **(optional)** **TypedreferenceV1** | | [default to undefined] +**ownerId** | **(optional)** **string** | The ID of the identity that owns this saved search. | [default to undefined] +**_public** | **(optional)** **boolean** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [default to false] + diff --git a/sdk-output/saved_search/docs/Models/Savedsearchdetail.md b/sdk-output/saved_search/docs/Models/Savedsearchdetail.md new file mode 100644 index 00000000..9df3e8ae --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Savedsearchdetail.md @@ -0,0 +1,27 @@ +--- +id: v1-savedsearchdetail-v1 +title: SavedsearchdetailV1 +pagination_label: SavedsearchdetailV1 +sidebar_label: SavedsearchdetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchdetailV1', 'v1SavedsearchdetailV1'] +slug: /tools/sdk/typescript/saved_search/models/savedsearchdetail-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchdetailV1', 'v1SavedsearchdetailV1'] +--- + +# SavedsearchdetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**modified** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**indices** | **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. | [default to undefined] +**columns** | **(optional)** | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [default to undefined] +**query** | **string** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [default to undefined] +**fields** | **(optional)** **Array<string>** | The fields to be searched against in a multi-field query. | [default to undefined] +**orderBy** | **(optional)** | Sort by index. This takes precedence over the `sort` property. | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. | [default to undefined] +**filters** | **(optional)** **SavedsearchdetailFiltersV1** | | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/SavedsearchdetailFilters.md b/sdk-output/saved_search/docs/Models/SavedsearchdetailFilters.md new file mode 100644 index 00000000..50263822 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/SavedsearchdetailFilters.md @@ -0,0 +1,22 @@ +--- +id: v1-savedsearchdetail-filters-v1 +title: SavedsearchdetailFiltersV1 +pagination_label: SavedsearchdetailFiltersV1 +sidebar_label: SavedsearchdetailFiltersV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchdetailFiltersV1', 'v1SavedsearchdetailFiltersV1'] +slug: /tools/sdk/typescript/saved_search/models/savedsearchdetail-filters-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchdetailFiltersV1', 'v1SavedsearchdetailFiltersV1'] +--- + +# SavedsearchdetailFiltersV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **FiltertypeV1** | | [default to undefined] +**range** | **(optional)** **RangeV1** | | [default to undefined] +**terms** | **(optional)** **Array<string>** | The terms to be filtered. | [default to undefined] +**exclude** | **(optional)** **boolean** | Indicates if the filter excludes results. | [default to false] + diff --git a/sdk-output/saved_search/docs/Models/Savedsearchname.md b/sdk-output/saved_search/docs/Models/Savedsearchname.md new file mode 100644 index 00000000..8e061c5c --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Savedsearchname.md @@ -0,0 +1,20 @@ +--- +id: v1-savedsearchname-v1 +title: SavedsearchnameV1 +pagination_label: SavedsearchnameV1 +sidebar_label: SavedsearchnameV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchnameV1', 'v1SavedsearchnameV1'] +slug: /tools/sdk/typescript/saved_search/models/savedsearchname-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchnameV1', 'v1SavedsearchnameV1'] +--- + +# SavedsearchnameV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the saved search. | [default to undefined] +**description** | **(optional)** **string** | The description of the saved search. | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Searcharguments.md b/sdk-output/saved_search/docs/Models/Searcharguments.md new file mode 100644 index 00000000..c8250edf --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Searcharguments.md @@ -0,0 +1,21 @@ +--- +id: v1-searcharguments-v1 +title: SearchargumentsV1 +pagination_label: SearchargumentsV1 +sidebar_label: SearchargumentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchargumentsV1', 'v1SearchargumentsV1'] +slug: /tools/sdk/typescript/saved_search/models/searcharguments-v1 +tags: ['SDK', 'Software Development Kit', 'SearchargumentsV1', 'v1SearchargumentsV1'] +--- + +# SearchargumentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scheduleId** | **(optional)** **string** | The ID of the scheduled search that triggered the saved search execution. | [default to undefined] +**owner** | **(optional)** **TypedreferenceV1** | The owner of the scheduled search being tested. | [default to undefined] +**recipients** | **(optional)** **Array<TypedreferenceV1>** | The email recipients of the scheduled search being tested. | [default to undefined] + diff --git a/sdk-output/saved_search/docs/Models/Typedreference.md b/sdk-output/saved_search/docs/Models/Typedreference.md new file mode 100644 index 00000000..d63afe54 --- /dev/null +++ b/sdk-output/saved_search/docs/Models/Typedreference.md @@ -0,0 +1,20 @@ +--- +id: v1-typedreference-v1 +title: TypedreferenceV1 +pagination_label: TypedreferenceV1 +sidebar_label: TypedreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TypedreferenceV1', 'v1TypedreferenceV1'] +slug: /tools/sdk/typescript/saved_search/models/typedreference-v1 +tags: ['SDK', 'Software Development Kit', 'TypedreferenceV1', 'v1TypedreferenceV1'] +--- + +# TypedreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **DtotypeV1** | | [default to undefined] +**id** | **string** | The id of the object. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/scheduled_search/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..3abba19a --- /dev/null +++ b/sdk-output/scheduled_search/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,95 @@ +- path: /scheduled-searches/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#create-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const createScheduledSearchV1RequestV1: CreateScheduledSearchV1RequestV1 = {"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"DAILY","hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}; // CreateScheduledSearchV1RequestV1 | The scheduled search to persist. + const result = await apiInstance.createScheduledSearchV1(createScheduledSearchV1RequestV1); + console.log(result); +- path: /scheduled-searches/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#delete-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const result = await apiInstance.deleteScheduledSearchV1(id); + console.log(result); +- path: /scheduled-searches/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#get-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const result = await apiInstance.getScheduledSearchV1(id); + console.log(result); +- path: /scheduled-searches/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#list-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) (default to undefined) + const result = await apiInstance.listScheduledSearchV1(); + console.log(result); +- path: /scheduled-searches/v1/{id}/unsubscribe + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#unsubscribe-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const typedreferenceV1: TypedreferenceV1 = ; // TypedreferenceV1 | The recipient to be removed from the scheduled search. + const result = await apiInstance.unsubscribeScheduledSearchV1(id, typedreferenceV1); + console.log(result); +- path: /scheduled-searches/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/scheduled_search/methods/scheduled-search#update-scheduled-search-v1 + source: | + import { ScheduledSearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ScheduledSearchV1Api(configuration); + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const scheduledsearchV1: ScheduledsearchV1 = ; // ScheduledsearchV1 | The scheduled search to persist. + const result = await apiInstance.updateScheduledSearchV1(id, scheduledsearchV1); + console.log(result); diff --git a/sdk-output/scheduled_search/docs/Methods/Index.md b/sdk-output/scheduled_search/docs/Methods/Index.md new file mode 100644 index 00000000..f98c3794 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: scheduled_search-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: scheduled_search-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'scheduled_search', 'methods'] +slug: /tools/sdk/typescript/scheduled_search/methods +tags: ['SDK', 'Software Development Kit', 'scheduled_search', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/scheduled_search/docs/Methods/ScheduledSearchV1Api.md b/sdk-output/scheduled_search/docs/Methods/ScheduledSearchV1Api.md new file mode 100644 index 00000000..03f9aebf --- /dev/null +++ b/sdk-output/scheduled_search/docs/Methods/ScheduledSearchV1Api.md @@ -0,0 +1,294 @@ +--- +id: v1-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledSearch', 'v1ScheduledSearch'] +slug: /tools/sdk/typescript/scheduled_search/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'v1ScheduledSearch'] +--- + +# ScheduledSearchV1Api + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-scheduled-search-v1**](#create-scheduled-search-v1) | **POST** `/scheduled-searches/v1` | Create a new scheduled search +[**delete-scheduled-search-v1**](#delete-scheduled-search-v1) | **DELETE** `/scheduled-searches/v1/{id}` | Delete a scheduled search +[**get-scheduled-search-v1**](#get-scheduled-search-v1) | **GET** `/scheduled-searches/v1/{id}` | Get a scheduled search +[**list-scheduled-search-v1**](#list-scheduled-search-v1) | **GET** `/scheduled-searches/v1` | List scheduled searches +[**unsubscribe-scheduled-search-v1**](#unsubscribe-scheduled-search-v1) | **POST** `/scheduled-searches/v1/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**update-scheduled-search-v1**](#update-scheduled-search-v1) | **PUT** `/scheduled-searches/v1/{id}` | Update an existing scheduled search + + +## create-scheduled-search-v1 +Create a new scheduled search +Creates a new scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createScheduledSearchV1RequestV1** | **CreateScheduledSearchV1RequestV1** | The scheduled search to persist. | + +### Return type + +**ScheduledsearchV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const createScheduledSearchV1RequestV1: CreateScheduledSearchV1RequestV1 = {"savedSearchId":"9c620e13-cd33-4804-a13d-403bd7bcdbad","schedule":{"type":"DAILY","hours":{"type":"LIST","values":["9"]}},"recipients":[{"type":"IDENTITY","id":"2c9180867624cbd7017642d8c8c81f67"}]}; // The scheduled search to persist. +const result = await apiInstance.createScheduledSearchV1(createScheduledSearchV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-scheduled-search-v1 +Delete a scheduled search +Deletes the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const result = await apiInstance.deleteScheduledSearchV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-scheduled-search-v1 +Get a scheduled search +Returns the specified scheduled search. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] + +### Return type + +**ScheduledsearchV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const result = await apiInstance.getScheduledSearchV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-scheduled-search-v1 +List scheduled searches +Returns a list of scheduled searches. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) +const result = await apiInstance.listScheduledSearchV1(); +console.log(result); +``` + +[[Back to top]](#) + +## unsubscribe-scheduled-search-v1 +Unsubscribe a recipient from scheduled search +Unsubscribes a recipient from the specified scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/unsubscribe-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] +**typedreferenceV1** | **TypedreferenceV1** | The recipient to be removed from the scheduled search. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const typedreferenceV1: TypedreferenceV1 = ; // The recipient to be removed from the scheduled search. +const result = await apiInstance.unsubscribeScheduledSearchV1(id, typedreferenceV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-scheduled-search-v1 +Update an existing scheduled search +Updates an existing scheduled search. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-scheduled-search-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the requested document. | [default to undefined] +**scheduledsearchV1** | **ScheduledsearchV1** | The scheduled search to persist. | + +### Return type + +**ScheduledsearchV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ScheduledSearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ScheduledSearchV1Api(configuration); +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const scheduledsearchV1: ScheduledsearchV1 = ; // The scheduled search to persist. +const result = await apiInstance.updateScheduledSearchV1(id, scheduledsearchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/scheduled_search/docs/Models/CreateScheduledSearchV1Request.md b/sdk-output/scheduled_search/docs/Models/CreateScheduledSearchV1Request.md new file mode 100644 index 00000000..fa139ea4 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/CreateScheduledSearchV1Request.md @@ -0,0 +1,28 @@ +--- +id: v1-create-scheduled-search-v1-request-v1 +title: CreateScheduledSearchV1RequestV1 +pagination_label: CreateScheduledSearchV1RequestV1 +sidebar_label: CreateScheduledSearchV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateScheduledSearchV1RequestV1', 'v1CreateScheduledSearchV1RequestV1'] +slug: /tools/sdk/typescript/scheduled_search/models/create-scheduled-search-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchV1RequestV1', 'v1CreateScheduledSearchV1RequestV1'] +--- + +# CreateScheduledSearchV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the scheduled search. | [default to undefined] +**description** | **(optional)** **string** | The description of the scheduled search. | [default to undefined] +**savedSearchId** | **string** | The ID of the saved search that will be executed. | [default to undefined] +**created** | **(optional)** **string** | The date the scheduled search was initially created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | The last date the scheduled search was modified. | [readonly] [default to undefined] +**schedule** | **ScheduleV1** | | [default to undefined] +**recipients** | **Array<SearchscheduleRecipientsInnerV1>** | A list of identities that should receive the scheduled search report via email. | [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates if the scheduled search is enabled. | [default to false] +**emailEmptyResults** | **(optional)** **boolean** | Indicates if email generation should occur when search returns no results. | [default to false] +**displayQueryDetails** | **(optional)** **boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [default to false] + diff --git a/sdk-output/scheduled_search/docs/Models/Dtotype.md b/sdk-output/scheduled_search/docs/Models/Dtotype.md new file mode 100644 index 00000000..42371931 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/scheduled_search/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/scheduled_search/docs/Models/Errormessagedto.md b/sdk-output/scheduled_search/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..02a12e3c --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/scheduled_search/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Errorresponsedto.md b/sdk-output/scheduled_search/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..9deb1e59 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/scheduled_search/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Index.md b/sdk-output/scheduled_search/docs/Models/Index.md new file mode 100644 index 00000000..5f63c54e --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: scheduled_search-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: scheduled_search-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'scheduled_search', 'models'] +slug: /tools/sdk/typescript/scheduled_search/models +tags: ['SDK', 'Software Development Kit', 'scheduled_search', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1401Response.md b/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1401Response.md new file mode 100644 index 00000000..57dba1e6 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-scheduled-search-v1401-response-v1 +title: ListScheduledSearchV1401ResponseV1 +pagination_label: ListScheduledSearchV1401ResponseV1 +sidebar_label: ListScheduledSearchV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListScheduledSearchV1401ResponseV1', 'v1ListScheduledSearchV1401ResponseV1'] +slug: /tools/sdk/typescript/scheduled_search/models/list-scheduled-search-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListScheduledSearchV1401ResponseV1', 'v1ListScheduledSearchV1401ResponseV1'] +--- + +# ListScheduledSearchV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1429Response.md b/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1429Response.md new file mode 100644 index 00000000..6aa1f449 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ListScheduledSearchV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-scheduled-search-v1429-response-v1 +title: ListScheduledSearchV1429ResponseV1 +pagination_label: ListScheduledSearchV1429ResponseV1 +sidebar_label: ListScheduledSearchV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListScheduledSearchV1429ResponseV1', 'v1ListScheduledSearchV1429ResponseV1'] +slug: /tools/sdk/typescript/scheduled_search/models/list-scheduled-search-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListScheduledSearchV1429ResponseV1', 'v1ListScheduledSearchV1429ResponseV1'] +--- + +# ListScheduledSearchV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Localeorigin.md b/sdk-output/scheduled_search/docs/Models/Localeorigin.md new file mode 100644 index 00000000..734f602a --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/scheduled_search/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/scheduled_search/docs/Models/README.md b/sdk-output/scheduled_search/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/scheduled_search/docs/Models/Schedule.md b/sdk-output/scheduled_search/docs/Models/Schedule.md new file mode 100644 index 00000000..a9f3c725 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Schedule.md @@ -0,0 +1,24 @@ +--- +id: v1-schedule-v1 +title: ScheduleV1 +pagination_label: ScheduleV1 +sidebar_label: ScheduleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleV1', 'v1ScheduleV1'] +slug: /tools/sdk/typescript/scheduled_search/models/schedule-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleV1', 'v1ScheduleV1'] +--- + +# ScheduleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **ScheduletypeV1** | | [default to undefined] +**months** | **(optional)** **ScheduleMonthsV1** | | [default to undefined] +**days** | **(optional)** **ScheduleDaysV1** | | [default to undefined] +**hours** | **ScheduleHoursV1** | | [default to undefined] +**expiration** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**timeZoneId** | **(optional)** **string** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/ScheduleDays.md b/sdk-output/scheduled_search/docs/Models/ScheduleDays.md new file mode 100644 index 00000000..51bab053 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ScheduleDays.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-days-v1 +title: ScheduleDaysV1 +pagination_label: ScheduleDaysV1 +sidebar_label: ScheduleDaysV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleDaysV1', 'v1ScheduleDaysV1'] +slug: /tools/sdk/typescript/scheduled_search/models/schedule-days-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleDaysV1', 'v1ScheduleDaysV1'] +--- + +# ScheduleDaysV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/ScheduleHours.md b/sdk-output/scheduled_search/docs/Models/ScheduleHours.md new file mode 100644 index 00000000..18a28842 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ScheduleHours.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-hours-v1 +title: ScheduleHoursV1 +pagination_label: ScheduleHoursV1 +sidebar_label: ScheduleHoursV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleHoursV1', 'v1ScheduleHoursV1'] +slug: /tools/sdk/typescript/scheduled_search/models/schedule-hours-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleHoursV1', 'v1ScheduleHoursV1'] +--- + +# ScheduleHoursV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/ScheduleMonths.md b/sdk-output/scheduled_search/docs/Models/ScheduleMonths.md new file mode 100644 index 00000000..40c4c9cd --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ScheduleMonths.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-months-v1 +title: ScheduleMonthsV1 +pagination_label: ScheduleMonthsV1 +sidebar_label: ScheduleMonthsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleMonthsV1', 'v1ScheduleMonthsV1'] +slug: /tools/sdk/typescript/scheduled_search/models/schedule-months-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleMonthsV1', 'v1ScheduleMonthsV1'] +--- + +# ScheduleMonthsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Scheduledsearch.md b/sdk-output/scheduled_search/docs/Models/Scheduledsearch.md new file mode 100644 index 00000000..67c8cd82 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Scheduledsearch.md @@ -0,0 +1,31 @@ +--- +id: v1-scheduledsearch-v1 +title: ScheduledsearchV1 +pagination_label: ScheduledsearchV1 +sidebar_label: ScheduledsearchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledsearchV1', 'v1ScheduledsearchV1'] +slug: /tools/sdk/typescript/scheduled_search/models/scheduledsearch-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledsearchV1', 'v1ScheduledsearchV1'] +--- + +# ScheduledsearchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the scheduled search. | [default to undefined] +**description** | **(optional)** **string** | The description of the scheduled search. | [default to undefined] +**savedSearchId** | **string** | The ID of the saved search that will be executed. | [default to undefined] +**created** | **(optional)** **string** | The date the scheduled search was initially created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | The last date the scheduled search was modified. | [readonly] [default to undefined] +**schedule** | **ScheduleV1** | | [default to undefined] +**recipients** | **Array<SearchscheduleRecipientsInnerV1>** | A list of identities that should receive the scheduled search report via email. | [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates if the scheduled search is enabled. | [default to false] +**emailEmptyResults** | **(optional)** **boolean** | Indicates if email generation should occur when search returns no results. | [default to false] +**displayQueryDetails** | **(optional)** **boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [default to false] +**id** | **string** | The scheduled search ID. | [readonly] [default to undefined] +**owner** | **ScheduledsearchAllOfOwnerV1** | | [default to undefined] +**ownerId** | **string** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [readonly] [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/ScheduledsearchAllOfOwner.md b/sdk-output/scheduled_search/docs/Models/ScheduledsearchAllOfOwner.md new file mode 100644 index 00000000..7c7fce0f --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/ScheduledsearchAllOfOwner.md @@ -0,0 +1,20 @@ +--- +id: v1-scheduledsearch-all-of-owner-v1 +title: ScheduledsearchAllOfOwnerV1 +pagination_label: ScheduledsearchAllOfOwnerV1 +sidebar_label: ScheduledsearchAllOfOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledsearchAllOfOwnerV1', 'v1ScheduledsearchAllOfOwnerV1'] +slug: /tools/sdk/typescript/scheduled_search/models/scheduledsearch-all-of-owner-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledsearchAllOfOwnerV1', 'v1ScheduledsearchAllOfOwnerV1'] +--- + +# ScheduledsearchAllOfOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of object being referenced | [default to undefined] +**id** | **string** | The ID of the referenced object | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Scheduledsearchname.md b/sdk-output/scheduled_search/docs/Models/Scheduledsearchname.md new file mode 100644 index 00000000..d405e78f --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Scheduledsearchname.md @@ -0,0 +1,20 @@ +--- +id: v1-scheduledsearchname-v1 +title: ScheduledsearchnameV1 +pagination_label: ScheduledsearchnameV1 +sidebar_label: ScheduledsearchnameV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduledsearchnameV1', 'v1ScheduledsearchnameV1'] +slug: /tools/sdk/typescript/scheduled_search/models/scheduledsearchname-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduledsearchnameV1', 'v1ScheduledsearchnameV1'] +--- + +# ScheduledsearchnameV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the scheduled search. | [default to undefined] +**description** | **(optional)** **string** | The description of the scheduled search. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Scheduletype.md b/sdk-output/scheduled_search/docs/Models/Scheduletype.md new file mode 100644 index 00000000..e38e6039 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Scheduletype.md @@ -0,0 +1,27 @@ +--- +id: v1-scheduletype-v1 +title: ScheduletypeV1 +pagination_label: ScheduletypeV1 +sidebar_label: ScheduletypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduletypeV1', 'v1ScheduletypeV1'] +slug: /tools/sdk/typescript/scheduled_search/models/scheduletype-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduletypeV1', 'v1ScheduletypeV1'] +--- + +# ScheduletypeV1 + +## Enum + + +* `Daily` (value: `'DAILY'`) + +* `Weekly` (value: `'WEEKLY'`) + +* `Monthly` (value: `'MONTHLY'`) + +* `Calendar` (value: `'CALENDAR'`) + +* `Annually` (value: `'ANNUALLY'`) + + diff --git a/sdk-output/scheduled_search/docs/Models/Searchschedule.md b/sdk-output/scheduled_search/docs/Models/Searchschedule.md new file mode 100644 index 00000000..abf641e0 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Searchschedule.md @@ -0,0 +1,26 @@ +--- +id: v1-searchschedule-v1 +title: SearchscheduleV1 +pagination_label: SearchscheduleV1 +sidebar_label: SearchscheduleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchscheduleV1', 'v1SearchscheduleV1'] +slug: /tools/sdk/typescript/scheduled_search/models/searchschedule-v1 +tags: ['SDK', 'Software Development Kit', 'SearchscheduleV1', 'v1SearchscheduleV1'] +--- + +# SearchscheduleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**savedSearchId** | **string** | The ID of the saved search that will be executed. | [default to undefined] +**created** | **(optional)** **string** | The date the scheduled search was initially created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | The last date the scheduled search was modified. | [readonly] [default to undefined] +**schedule** | **ScheduleV1** | | [default to undefined] +**recipients** | **Array<SearchscheduleRecipientsInnerV1>** | A list of identities that should receive the scheduled search report via email. | [default to undefined] +**enabled** | **(optional)** **boolean** | Indicates if the scheduled search is enabled. | [default to false] +**emailEmptyResults** | **(optional)** **boolean** | Indicates if email generation should occur when search returns no results. | [default to false] +**displayQueryDetails** | **(optional)** **boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [default to false] + diff --git a/sdk-output/scheduled_search/docs/Models/SearchscheduleRecipientsInner.md b/sdk-output/scheduled_search/docs/Models/SearchscheduleRecipientsInner.md new file mode 100644 index 00000000..277108f7 --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/SearchscheduleRecipientsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-searchschedule-recipients-inner-v1 +title: SearchscheduleRecipientsInnerV1 +pagination_label: SearchscheduleRecipientsInnerV1 +sidebar_label: SearchscheduleRecipientsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchscheduleRecipientsInnerV1', 'v1SearchscheduleRecipientsInnerV1'] +slug: /tools/sdk/typescript/scheduled_search/models/searchschedule-recipients-inner-v1 +tags: ['SDK', 'Software Development Kit', 'SearchscheduleRecipientsInnerV1', 'v1SearchscheduleRecipientsInnerV1'] +--- + +# SearchscheduleRecipientsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of object being referenced | [default to undefined] +**id** | **string** | The ID of the referenced object | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Selector.md b/sdk-output/scheduled_search/docs/Models/Selector.md new file mode 100644 index 00000000..afd251bc --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Selector.md @@ -0,0 +1,21 @@ +--- +id: v1-selector-v1 +title: SelectorV1 +pagination_label: SelectorV1 +sidebar_label: SelectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SelectorV1', 'v1SelectorV1'] +slug: /tools/sdk/typescript/scheduled_search/models/selector-v1 +tags: ['SDK', 'Software Development Kit', 'SelectorV1', 'v1SelectorV1'] +--- + +# SelectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/scheduled_search/docs/Models/Selectortype.md b/sdk-output/scheduled_search/docs/Models/Selectortype.md new file mode 100644 index 00000000..2c818eea --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Selectortype.md @@ -0,0 +1,21 @@ +--- +id: v1-selectortype-v1 +title: SelectortypeV1 +pagination_label: SelectortypeV1 +sidebar_label: SelectortypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SelectortypeV1', 'v1SelectortypeV1'] +slug: /tools/sdk/typescript/scheduled_search/models/selectortype-v1 +tags: ['SDK', 'Software Development Kit', 'SelectortypeV1', 'v1SelectortypeV1'] +--- + +# SelectortypeV1 + +## Enum + + +* `List` (value: `'LIST'`) + +* `Range` (value: `'RANGE'`) + + diff --git a/sdk-output/scheduled_search/docs/Models/Typedreference.md b/sdk-output/scheduled_search/docs/Models/Typedreference.md new file mode 100644 index 00000000..b603fd8b --- /dev/null +++ b/sdk-output/scheduled_search/docs/Models/Typedreference.md @@ -0,0 +1,20 @@ +--- +id: v1-typedreference-v1 +title: TypedreferenceV1 +pagination_label: TypedreferenceV1 +sidebar_label: TypedreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TypedreferenceV1', 'v1TypedreferenceV1'] +slug: /tools/sdk/typescript/scheduled_search/models/typedreference-v1 +tags: ['SDK', 'Software Development Kit', 'TypedreferenceV1', 'v1TypedreferenceV1'] +--- + +# TypedreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **DtotypeV1** | | [default to undefined] +**id** | **string** | The id of the object. | [default to undefined] + diff --git a/sdk-output/search/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/search/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..ea4b1dd7 --- /dev/null +++ b/sdk-output/search/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,67 @@ +- path: /search/v1/aggregate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search/methods/search#search-aggregate-v1 + source: | + import { SearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchV1Api(configuration); + const searchV1: SearchV1 = ; // SearchV1 | + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.searchAggregateV1(searchV1); + console.log(result); +- path: /search/v1/count + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search/methods/search#search-count-v1 + source: | + import { SearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchV1Api(configuration); + const searchV1: SearchV1 = ; // SearchV1 | + const result = await apiInstance.searchCountV1(searchV1); + console.log(result); +- path: /search/v1/{index}/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search/methods/search#search-get-v1 + source: | + import { SearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchV1Api(configuration); + const index: string = 'identities'; // 'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles' | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. (default to undefined) + const id: string = '2c91808568c529c60168cca6f90c1313'; // string | ID of the requested document. (default to undefined) + const result = await apiInstance.searchGetV1(index, id); + console.log(result); +- path: /search/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search/methods/search#search-post-v1 + source: | + import { SearchV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchV1Api(configuration); + const searchV1: SearchV1 = ; // SearchV1 | + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 10000; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.searchPostV1(searchV1); + console.log(result); diff --git a/sdk-output/search/docs/Methods/Index.md b/sdk-output/search/docs/Methods/Index.md new file mode 100644 index 00000000..953926cf --- /dev/null +++ b/sdk-output/search/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: search-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: search-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'search', 'methods'] +slug: /tools/sdk/typescript/search/methods +tags: ['SDK', 'Software Development Kit', 'search', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/search/docs/Methods/SearchV1Api.md b/sdk-output/search/docs/Methods/SearchV1Api.md new file mode 100644 index 00000000..e4eea7fc --- /dev/null +++ b/sdk-output/search/docs/Methods/SearchV1Api.md @@ -0,0 +1,212 @@ +--- +id: v1-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Search', 'v1Search'] +slug: /tools/sdk/typescript/search/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'v1Search'] +--- + +# SearchV1Api + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**search-aggregate-v1**](#search-aggregate-v1) | **POST** `/search/v1/aggregate` | Perform a search query aggregation +[**search-count-v1**](#search-count-v1) | **POST** `/search/v1/count` | Count documents satisfying a query +[**search-get-v1**](#search-get-v1) | **GET** `/search/v1/{index}/{id}` | Get a document by id +[**search-post-v1**](#search-post-v1) | **POST** `/search/v1` | Perform search + + +## search-aggregate-v1 +Perform a search query aggregation +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-aggregate-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**searchV1** | **SearchV1** | | +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**AggregationresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example + +```typescript +import { SearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchV1Api(configuration); +const searchV1: SearchV1 = ; // +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.searchAggregateV1(searchV1); +console.log(result); +``` + +[[Back to top]](#) + +## search-count-v1 +Count documents satisfying a query +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-count-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**searchV1** | **SearchV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchV1Api(configuration); +const searchV1: SearchV1 = ; // +const result = await apiInstance.searchCountV1(searchV1); +console.log(result); +``` + +[[Back to top]](#) + +## search-get-v1 +Get a document by id +Fetches a single document from the specified index, using the specified document ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-get-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**index** | **'accessprofiles' | 'accountactivities' | 'entitlements' | 'events' | 'identities' | 'roles'** | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. | [default to undefined] +**id** | **string** | ID of the requested document. | [default to undefined] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchV1Api(configuration); +const index: string = identities; // The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +const id: string = 2c91808568c529c60168cca6f90c1313; // ID of the requested document. +const result = await apiInstance.searchGetV1(index, id); +console.log(result); +``` + +[[Back to top]](#) + +## search-post-v1 +Perform search +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. The search query itself has a size limitation of approximately 800 objects when filtering by large lists of IDs or values (e.g., using `terms` filters with extensive lists). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-post-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**searchV1** | **SearchV1** | | +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SearchV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchV1Api(configuration); +const searchV1: SearchV1 = ; // +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 10000; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.searchPostV1(searchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/search/docs/Models/Aggregationresult.md b/sdk-output/search/docs/Models/Aggregationresult.md new file mode 100644 index 00000000..65ecb0a3 --- /dev/null +++ b/sdk-output/search/docs/Models/Aggregationresult.md @@ -0,0 +1,20 @@ +--- +id: v1-aggregationresult-v1 +title: AggregationresultV1 +pagination_label: AggregationresultV1 +sidebar_label: AggregationresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AggregationresultV1', 'v1AggregationresultV1'] +slug: /tools/sdk/typescript/search/models/aggregationresult-v1 +tags: ['SDK', 'Software Development Kit', 'AggregationresultV1', 'v1AggregationresultV1'] +--- + +# AggregationresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**aggregations** | **(optional)** **object** | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [default to undefined] +**hits** | **(optional)** **Array<object>** | The results of the aggregation search query. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Aggregations.md b/sdk-output/search/docs/Models/Aggregations.md new file mode 100644 index 00000000..5d2e4625 --- /dev/null +++ b/sdk-output/search/docs/Models/Aggregations.md @@ -0,0 +1,22 @@ +--- +id: v1-aggregations-v1 +title: AggregationsV1 +pagination_label: AggregationsV1 +sidebar_label: AggregationsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AggregationsV1', 'v1AggregationsV1'] +slug: /tools/sdk/typescript/search/models/aggregations-v1 +tags: ['SDK', 'Software Development Kit', 'AggregationsV1', 'v1AggregationsV1'] +--- + +# AggregationsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Aggregationtype.md b/sdk-output/search/docs/Models/Aggregationtype.md new file mode 100644 index 00000000..a82d38ab --- /dev/null +++ b/sdk-output/search/docs/Models/Aggregationtype.md @@ -0,0 +1,21 @@ +--- +id: v1-aggregationtype-v1 +title: AggregationtypeV1 +pagination_label: AggregationtypeV1 +sidebar_label: AggregationtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AggregationtypeV1', 'v1AggregationtypeV1'] +slug: /tools/sdk/typescript/search/models/aggregationtype-v1 +tags: ['SDK', 'Software Development Kit', 'AggregationtypeV1', 'v1AggregationtypeV1'] +--- + +# AggregationtypeV1 + +## Enum + + +* `Dsl` (value: `'DSL'`) + +* `Sailpoint` (value: `'SAILPOINT'`) + + diff --git a/sdk-output/search/docs/Models/Bound.md b/sdk-output/search/docs/Models/Bound.md new file mode 100644 index 00000000..38715d3f --- /dev/null +++ b/sdk-output/search/docs/Models/Bound.md @@ -0,0 +1,20 @@ +--- +id: v1-bound-v1 +title: BoundV1 +pagination_label: BoundV1 +sidebar_label: BoundV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BoundV1', 'v1BoundV1'] +slug: /tools/sdk/typescript/search/models/bound-v1 +tags: ['SDK', 'Software Development Kit', 'BoundV1', 'v1BoundV1'] +--- + +# BoundV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **string** | The value of the range\'s endpoint. | [default to undefined] +**inclusive** | **(optional)** **boolean** | Indicates if the endpoint is included in the range. | [default to false] + diff --git a/sdk-output/search/docs/Models/Bucketaggregation.md b/sdk-output/search/docs/Models/Bucketaggregation.md new file mode 100644 index 00000000..8d554308 --- /dev/null +++ b/sdk-output/search/docs/Models/Bucketaggregation.md @@ -0,0 +1,23 @@ +--- +id: v1-bucketaggregation-v1 +title: BucketaggregationV1 +pagination_label: BucketaggregationV1 +sidebar_label: BucketaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BucketaggregationV1', 'v1BucketaggregationV1'] +slug: /tools/sdk/typescript/search/models/bucketaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'BucketaggregationV1', 'v1BucketaggregationV1'] +--- + +# BucketaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the bucket aggregate to be included in the result. | [default to undefined] +**type** | **(optional)** **BuckettypeV1** | | [default to undefined] +**field** | **string** | The field to bucket on. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] +**size** | **(optional)** **number** | Maximum number of buckets to include. | [default to undefined] +**minDocCount** | **(optional)** **number** | Minimum number of documents a bucket should have. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Buckettype.md b/sdk-output/search/docs/Models/Buckettype.md new file mode 100644 index 00000000..6572f00b --- /dev/null +++ b/sdk-output/search/docs/Models/Buckettype.md @@ -0,0 +1,19 @@ +--- +id: v1-buckettype-v1 +title: BuckettypeV1 +pagination_label: BuckettypeV1 +sidebar_label: BuckettypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BuckettypeV1', 'v1BuckettypeV1'] +slug: /tools/sdk/typescript/search/models/buckettype-v1 +tags: ['SDK', 'Software Development Kit', 'BuckettypeV1', 'v1BuckettypeV1'] +--- + +# BuckettypeV1 + +## Enum + + +* `Terms` (value: `'TERMS'`) + + diff --git a/sdk-output/search/docs/Models/Errormessagedto.md b/sdk-output/search/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..1dbccd75 --- /dev/null +++ b/sdk-output/search/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/search/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Errorresponsedto.md b/sdk-output/search/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..4204cf16 --- /dev/null +++ b/sdk-output/search/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/search/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Filter.md b/sdk-output/search/docs/Models/Filter.md new file mode 100644 index 00000000..54c23d05 --- /dev/null +++ b/sdk-output/search/docs/Models/Filter.md @@ -0,0 +1,22 @@ +--- +id: v1-filter-v1 +title: FilterV1 +pagination_label: FilterV1 +sidebar_label: FilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FilterV1', 'v1FilterV1'] +slug: /tools/sdk/typescript/search/models/filter-v1 +tags: ['SDK', 'Software Development Kit', 'FilterV1', 'v1FilterV1'] +--- + +# FilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **FiltertypeV1** | | [default to undefined] +**range** | **(optional)** **RangeV1** | | [default to undefined] +**terms** | **(optional)** **Array<string>** | The terms to be filtered. | [default to undefined] +**exclude** | **(optional)** **boolean** | Indicates if the filter excludes results. | [default to false] + diff --git a/sdk-output/search/docs/Models/Filteraggregation.md b/sdk-output/search/docs/Models/Filteraggregation.md new file mode 100644 index 00000000..b7f408e5 --- /dev/null +++ b/sdk-output/search/docs/Models/Filteraggregation.md @@ -0,0 +1,22 @@ +--- +id: v1-filteraggregation-v1 +title: FilteraggregationV1 +pagination_label: FilteraggregationV1 +sidebar_label: FilteraggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FilteraggregationV1', 'v1FilteraggregationV1'] +slug: /tools/sdk/typescript/search/models/filteraggregation-v1 +tags: ['SDK', 'Software Development Kit', 'FilteraggregationV1', 'v1FilteraggregationV1'] +--- + +# FilteraggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the filter aggregate to be included in the result. | [default to undefined] +**type** | **(optional)** **SearchfiltertypeV1** | | [default to undefined] +**field** | **string** | The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] +**value** | **string** | The value to filter on. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Filtertype.md b/sdk-output/search/docs/Models/Filtertype.md new file mode 100644 index 00000000..0fd42500 --- /dev/null +++ b/sdk-output/search/docs/Models/Filtertype.md @@ -0,0 +1,23 @@ +--- +id: v1-filtertype-v1 +title: FiltertypeV1 +pagination_label: FiltertypeV1 +sidebar_label: FiltertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FiltertypeV1', 'v1FiltertypeV1'] +slug: /tools/sdk/typescript/search/models/filtertype-v1 +tags: ['SDK', 'Software Development Kit', 'FiltertypeV1', 'v1FiltertypeV1'] +--- + +# FiltertypeV1 + +## Enum + + +* `Exists` (value: `'EXISTS'`) + +* `Range` (value: `'RANGE'`) + +* `Terms` (value: `'TERMS'`) + + diff --git a/sdk-output/search/docs/Models/Index.md b/sdk-output/search/docs/Models/Index.md new file mode 100644 index 00000000..9ce8b567 --- /dev/null +++ b/sdk-output/search/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: search-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: search-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'search', 'models'] +slug: /tools/sdk/typescript/search/models +tags: ['SDK', 'Software Development Kit', 'search', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/search/docs/Models/Innerhit.md b/sdk-output/search/docs/Models/Innerhit.md new file mode 100644 index 00000000..27e79fe7 --- /dev/null +++ b/sdk-output/search/docs/Models/Innerhit.md @@ -0,0 +1,20 @@ +--- +id: v1-innerhit-v1 +title: InnerhitV1 +pagination_label: InnerhitV1 +sidebar_label: InnerhitV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InnerhitV1', 'v1InnerhitV1'] +slug: /tools/sdk/typescript/search/models/innerhit-v1 +tags: ['SDK', 'Software Development Kit', 'InnerhitV1', 'v1InnerhitV1'] +--- + +# InnerhitV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **string** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**type** | **string** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Localeorigin.md b/sdk-output/search/docs/Models/Localeorigin.md new file mode 100644 index 00000000..4647af45 --- /dev/null +++ b/sdk-output/search/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/search/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/search/docs/Models/Metricaggregation.md b/sdk-output/search/docs/Models/Metricaggregation.md new file mode 100644 index 00000000..7d0692f9 --- /dev/null +++ b/sdk-output/search/docs/Models/Metricaggregation.md @@ -0,0 +1,21 @@ +--- +id: v1-metricaggregation-v1 +title: MetricaggregationV1 +pagination_label: MetricaggregationV1 +sidebar_label: MetricaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MetricaggregationV1', 'v1MetricaggregationV1'] +slug: /tools/sdk/typescript/search/models/metricaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'MetricaggregationV1', 'v1MetricaggregationV1'] +--- + +# MetricaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | [default to undefined] +**type** | **(optional)** **MetrictypeV1** | | [default to undefined] +**field** | **string** | The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Metrictype.md b/sdk-output/search/docs/Models/Metrictype.md new file mode 100644 index 00000000..ef101d09 --- /dev/null +++ b/sdk-output/search/docs/Models/Metrictype.md @@ -0,0 +1,31 @@ +--- +id: v1-metrictype-v1 +title: MetrictypeV1 +pagination_label: MetrictypeV1 +sidebar_label: MetrictypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MetrictypeV1', 'v1MetrictypeV1'] +slug: /tools/sdk/typescript/search/models/metrictype-v1 +tags: ['SDK', 'Software Development Kit', 'MetrictypeV1', 'v1MetrictypeV1'] +--- + +# MetrictypeV1 + +## Enum + + +* `Count` (value: `'COUNT'`) + +* `UniqueCount` (value: `'UNIQUE_COUNT'`) + +* `Avg` (value: `'AVG'`) + +* `Sum` (value: `'SUM'`) + +* `Median` (value: `'MEDIAN'`) + +* `Min` (value: `'MIN'`) + +* `Max` (value: `'MAX'`) + + diff --git a/sdk-output/search/docs/Models/Nestedaggregation.md b/sdk-output/search/docs/Models/Nestedaggregation.md new file mode 100644 index 00000000..60f29f21 --- /dev/null +++ b/sdk-output/search/docs/Models/Nestedaggregation.md @@ -0,0 +1,20 @@ +--- +id: v1-nestedaggregation-v1 +title: NestedaggregationV1 +pagination_label: NestedaggregationV1 +sidebar_label: NestedaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NestedaggregationV1', 'v1NestedaggregationV1'] +slug: /tools/sdk/typescript/search/models/nestedaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'NestedaggregationV1', 'v1NestedaggregationV1'] +--- + +# NestedaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the nested aggregate to be included in the result. | [default to undefined] +**type** | **string** | The type of the nested object. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Query.md b/sdk-output/search/docs/Models/Query.md new file mode 100644 index 00000000..2e3b2fc4 --- /dev/null +++ b/sdk-output/search/docs/Models/Query.md @@ -0,0 +1,22 @@ +--- +id: v1-query-v1 +title: QueryV1 +pagination_label: QueryV1 +sidebar_label: QueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryV1', 'v1QueryV1'] +slug: /tools/sdk/typescript/search/models/query-v1 +tags: ['SDK', 'Software Development Kit', 'QueryV1', 'v1QueryV1'] +--- + +# QueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **(optional)** **string** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [default to undefined] +**fields** | **(optional)** **string** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. | [default to undefined] +**timeZone** | **(optional)** **string** | The time zone to be applied to any range query related to dates. | [default to undefined] +**innerHit** | **(optional)** **InnerhitV1** | | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Queryresultfilter.md b/sdk-output/search/docs/Models/Queryresultfilter.md new file mode 100644 index 00000000..5fa167bc --- /dev/null +++ b/sdk-output/search/docs/Models/Queryresultfilter.md @@ -0,0 +1,20 @@ +--- +id: v1-queryresultfilter-v1 +title: QueryresultfilterV1 +pagination_label: QueryresultfilterV1 +sidebar_label: QueryresultfilterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueryresultfilterV1', 'v1QueryresultfilterV1'] +slug: /tools/sdk/typescript/search/models/queryresultfilter-v1 +tags: ['SDK', 'Software Development Kit', 'QueryresultfilterV1', 'v1QueryresultfilterV1'] +--- + +# QueryresultfilterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includes** | **(optional)** **Array<string>** | The list of field names to include in the result documents. | [default to undefined] +**excludes** | **(optional)** **Array<string>** | The list of field names to exclude from the result documents. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Querytype.md b/sdk-output/search/docs/Models/Querytype.md new file mode 100644 index 00000000..1fbeeb46 --- /dev/null +++ b/sdk-output/search/docs/Models/Querytype.md @@ -0,0 +1,25 @@ +--- +id: v1-querytype-v1 +title: QuerytypeV1 +pagination_label: QuerytypeV1 +sidebar_label: QuerytypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QuerytypeV1', 'v1QuerytypeV1'] +slug: /tools/sdk/typescript/search/models/querytype-v1 +tags: ['SDK', 'Software Development Kit', 'QuerytypeV1', 'v1QuerytypeV1'] +--- + +# QuerytypeV1 + +## Enum + + +* `Dsl` (value: `'DSL'`) + +* `Sailpoint` (value: `'SAILPOINT'`) + +* `Text` (value: `'TEXT'`) + +* `Typeahead` (value: `'TYPEAHEAD'`) + + diff --git a/sdk-output/search/docs/Models/README.md b/sdk-output/search/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/search/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/search/docs/Models/Range.md b/sdk-output/search/docs/Models/Range.md new file mode 100644 index 00000000..8b609978 --- /dev/null +++ b/sdk-output/search/docs/Models/Range.md @@ -0,0 +1,20 @@ +--- +id: v1-range-v1 +title: RangeV1 +pagination_label: RangeV1 +sidebar_label: RangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RangeV1', 'v1RangeV1'] +slug: /tools/sdk/typescript/search/models/range-v1 +tags: ['SDK', 'Software Development Kit', 'RangeV1', 'v1RangeV1'] +--- + +# RangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | **(optional)** **BoundV1** | | [default to undefined] +**upper** | **(optional)** **BoundV1** | | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Search.md b/sdk-output/search/docs/Models/Search.md new file mode 100644 index 00000000..f65be445 --- /dev/null +++ b/sdk-output/search/docs/Models/Search.md @@ -0,0 +1,34 @@ +--- +id: v1-search-v1 +title: SearchV1 +pagination_label: SearchV1 +sidebar_label: SearchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchV1', 'v1SearchV1'] +slug: /tools/sdk/typescript/search/models/search-v1 +tags: ['SDK', 'Software Development Kit', 'SearchV1', 'v1SearchV1'] +--- + +# SearchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | **(optional)** **Array<IndexV1>** | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [default to undefined] +**queryType** | **(optional)** **QuerytypeV1** | | [default to undefined] +**queryVersion** | **(optional)** **string** | | [default to undefined] +**query** | **(optional)** **QueryV1** | | [default to undefined] +**queryDsl** | **(optional)** **object** | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [default to undefined] +**textQuery** | **(optional)** **TextqueryV1** | | [default to undefined] +**typeAheadQuery** | **(optional)** **TypeaheadqueryV1** | | [default to undefined] +**includeNested** | **(optional)** **boolean** | Indicates whether nested objects from returned search results should be included. | [default to true] +**queryResultFilter** | **(optional)** **QueryresultfilterV1** | | [default to undefined] +**aggregationType** | **(optional)** **AggregationtypeV1** | | [default to undefined] +**aggregationsVersion** | **(optional)** **string** | | [default to undefined] +**aggregationsDsl** | **(optional)** **object** | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [default to undefined] +**aggregations** | **(optional)** **SearchaggregationspecificationV1** | | [default to undefined] +**sort** | **(optional)** **Array<string>** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [default to undefined] +**searchAfter** | **(optional)** **Array<string>** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] | [default to undefined] +**filters** | **(optional)** | The filters to be applied for each filtered field name. | [default to undefined] + diff --git a/sdk-output/search/docs/Models/SearchPostV1401Response.md b/sdk-output/search/docs/Models/SearchPostV1401Response.md new file mode 100644 index 00000000..ab3d2049 --- /dev/null +++ b/sdk-output/search/docs/Models/SearchPostV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-search-post-v1401-response-v1 +title: SearchPostV1401ResponseV1 +pagination_label: SearchPostV1401ResponseV1 +sidebar_label: SearchPostV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchPostV1401ResponseV1', 'v1SearchPostV1401ResponseV1'] +slug: /tools/sdk/typescript/search/models/search-post-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'SearchPostV1401ResponseV1', 'v1SearchPostV1401ResponseV1'] +--- + +# SearchPostV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/search/docs/Models/SearchPostV1429Response.md b/sdk-output/search/docs/Models/SearchPostV1429Response.md new file mode 100644 index 00000000..2a12eac7 --- /dev/null +++ b/sdk-output/search/docs/Models/SearchPostV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-search-post-v1429-response-v1 +title: SearchPostV1429ResponseV1 +pagination_label: SearchPostV1429ResponseV1 +sidebar_label: SearchPostV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchPostV1429ResponseV1', 'v1SearchPostV1429ResponseV1'] +slug: /tools/sdk/typescript/search/models/search-post-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'SearchPostV1429ResponseV1', 'v1SearchPostV1429ResponseV1'] +--- + +# SearchPostV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Searchaggregationspecification.md b/sdk-output/search/docs/Models/Searchaggregationspecification.md new file mode 100644 index 00000000..4161d3f8 --- /dev/null +++ b/sdk-output/search/docs/Models/Searchaggregationspecification.md @@ -0,0 +1,23 @@ +--- +id: v1-searchaggregationspecification-v1 +title: SearchaggregationspecificationV1 +pagination_label: SearchaggregationspecificationV1 +sidebar_label: SearchaggregationspecificationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchaggregationspecificationV1', 'v1SearchaggregationspecificationV1'] +slug: /tools/sdk/typescript/search/models/searchaggregationspecification-v1 +tags: ['SDK', 'Software Development Kit', 'SearchaggregationspecificationV1', 'v1SearchaggregationspecificationV1'] +--- + +# SearchaggregationspecificationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] +**subAggregation** | **(optional)** **SubsearchaggregationspecificationV1** | | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Searchfiltertype.md b/sdk-output/search/docs/Models/Searchfiltertype.md new file mode 100644 index 00000000..064da591 --- /dev/null +++ b/sdk-output/search/docs/Models/Searchfiltertype.md @@ -0,0 +1,19 @@ +--- +id: v1-searchfiltertype-v1 +title: SearchfiltertypeV1 +pagination_label: SearchfiltertypeV1 +sidebar_label: SearchfiltertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchfiltertypeV1', 'v1SearchfiltertypeV1'] +slug: /tools/sdk/typescript/search/models/searchfiltertype-v1 +tags: ['SDK', 'Software Development Kit', 'SearchfiltertypeV1', 'v1SearchfiltertypeV1'] +--- + +# SearchfiltertypeV1 + +## Enum + + +* `Term` (value: `'TERM'`) + + diff --git a/sdk-output/search/docs/Models/Subsearchaggregationspecification.md b/sdk-output/search/docs/Models/Subsearchaggregationspecification.md new file mode 100644 index 00000000..0d3d441e --- /dev/null +++ b/sdk-output/search/docs/Models/Subsearchaggregationspecification.md @@ -0,0 +1,23 @@ +--- +id: v1-subsearchaggregationspecification-v1 +title: SubsearchaggregationspecificationV1 +pagination_label: SubsearchaggregationspecificationV1 +sidebar_label: SubsearchaggregationspecificationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubsearchaggregationspecificationV1', 'v1SubsearchaggregationspecificationV1'] +slug: /tools/sdk/typescript/search/models/subsearchaggregationspecification-v1 +tags: ['SDK', 'Software Development Kit', 'SubsearchaggregationspecificationV1', 'v1SubsearchaggregationspecificationV1'] +--- + +# SubsearchaggregationspecificationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**nested** | **(optional)** **NestedaggregationV1** | | [default to undefined] +**metric** | **(optional)** **MetricaggregationV1** | | [default to undefined] +**filter** | **(optional)** **FilteraggregationV1** | | [default to undefined] +**bucket** | **(optional)** **BucketaggregationV1** | | [default to undefined] +**subAggregation** | **(optional)** **AggregationsV1** | | [default to undefined] + diff --git a/sdk-output/search/docs/Models/Textquery.md b/sdk-output/search/docs/Models/Textquery.md new file mode 100644 index 00000000..93afa395 --- /dev/null +++ b/sdk-output/search/docs/Models/Textquery.md @@ -0,0 +1,22 @@ +--- +id: v1-textquery-v1 +title: TextqueryV1 +pagination_label: TextqueryV1 +sidebar_label: TextqueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TextqueryV1', 'v1TextqueryV1'] +slug: /tools/sdk/typescript/search/models/textquery-v1 +tags: ['SDK', 'Software Development Kit', 'TextqueryV1', 'v1TextqueryV1'] +--- + +# TextqueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terms** | **Array<string>** | Words or characters that specify a particular thing to be searched for. | [default to undefined] +**fields** | **Array<string>** | The fields to be searched. | [default to undefined] +**matchAny** | **(optional)** **boolean** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [default to false] +**contains** | **(optional)** **boolean** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [default to false] + diff --git a/sdk-output/search/docs/Models/Typeaheadquery.md b/sdk-output/search/docs/Models/Typeaheadquery.md new file mode 100644 index 00000000..3912e363 --- /dev/null +++ b/sdk-output/search/docs/Models/Typeaheadquery.md @@ -0,0 +1,25 @@ +--- +id: v1-typeaheadquery-v1 +title: TypeaheadqueryV1 +pagination_label: TypeaheadqueryV1 +sidebar_label: TypeaheadqueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TypeaheadqueryV1', 'v1TypeaheadqueryV1'] +slug: /tools/sdk/typescript/search/models/typeaheadquery-v1 +tags: ['SDK', 'Software Development Kit', 'TypeaheadqueryV1', 'v1TypeaheadqueryV1'] +--- + +# TypeaheadqueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **string** | The type ahead query string used to construct a phrase prefix match query. | [default to undefined] +**field** | **string** | The field on which to perform the type ahead search. | [default to undefined] +**nestedType** | **(optional)** **string** | The nested type. | [default to undefined] +**maxExpansions** | **(optional)** **number** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [default to 10] +**size** | **(optional)** **number** | The max amount of records the search will return. | [default to 100] +**sort** | **(optional)** **string** | The sort order of the returned records. | [default to 'desc'] +**sortByValue** | **(optional)** **boolean** | The flag that defines the sort type, by count or value. | [default to false] + diff --git a/sdk-output/search_attribute_configuration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/search_attribute_configuration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a934e5f7 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,82 @@ +- path: /accounts/v1/search-attribute-config + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration#create-search-attribute-config-v1 + source: | + import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchAttributeConfigurationV1Api(configuration); + const searchattributeconfigV1: SearchattributeconfigV1 = {"name":"newMailAttribute","displayName":"New Mail Attribute","applicationAttributes":{"2c9180866166b5b0016167c32ef31a66":"mail","2c9180866166b5b0016167c32ef31a67":"mail"}}; // SearchattributeconfigV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createSearchAttributeConfigV1(searchattributeconfigV1); + console.log(result); +- path: /accounts/v1/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration#delete-search-attribute-config-v1 + source: | + import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchAttributeConfigurationV1Api(configuration); + const name: string = 'newMailAttribute'; // string | Name of the extended search attribute configuration to delete. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteSearchAttributeConfigV1(name); + console.log(result); +- path: /accounts/v1/search-attribute-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration#get-search-attribute-config-v1 + source: | + import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchAttributeConfigurationV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSearchAttributeConfigV1(); + console.log(result); +- path: /accounts/v1/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration#get-single-search-attribute-config-v1 + source: | + import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchAttributeConfigurationV1Api(configuration); + const name: string = 'newMailAttribute'; // string | Name of the extended search attribute configuration to get. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSingleSearchAttributeConfigV1(name); + console.log(result); +- path: /accounts/v1/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration#patch-search-attribute-config-v1 + source: | + import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SearchAttributeConfigurationV1Api(configuration); + const name: string = 'promotedMailAttribute'; // string | Name of the search attribute configuration to patch. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"newAttributeName"},{"op":"replace","path":"/displayName","value":"new attribute display name"},{"op":"add","path":"/applicationAttributes","value":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber"}}]; // Array | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchSearchAttributeConfigV1(name, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/search_attribute_configuration/docs/Methods/Index.md b/sdk-output/search_attribute_configuration/docs/Methods/Index.md new file mode 100644 index 00000000..96b55966 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: search_attribute_configuration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: search_attribute_configuration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'search_attribute_configuration', 'methods'] +slug: /tools/sdk/typescript/search_attribute_configuration/methods +tags: ['SDK', 'Software Development Kit', 'search_attribute_configuration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationV1Api.md b/sdk-output/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationV1Api.md new file mode 100644 index 00000000..fb202eb2 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationV1Api.md @@ -0,0 +1,264 @@ +--- +id: v1-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchAttributeConfiguration', 'v1SearchAttributeConfiguration'] +slug: /tools/sdk/typescript/search_attribute_configuration/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'v1SearchAttributeConfiguration'] +--- + +# SearchAttributeConfigurationV1Api + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v2025/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Search Attribute Configuration](https://developer.sailpoint.com/docs/extensibility/rules/rule-utility/#configuration-of-search-attributes-within-identity-security-cloud) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-search-attribute-config-v1**](#create-search-attribute-config-v1) | **POST** `/accounts/v1/search-attribute-config` | Create extended search attributes +[**delete-search-attribute-config-v1**](#delete-search-attribute-config-v1) | **DELETE** `/accounts/v1/search-attribute-config/{name}` | Delete extended search attribute +[**get-search-attribute-config-v1**](#get-search-attribute-config-v1) | **GET** `/accounts/v1/search-attribute-config` | List extended search attributes +[**get-single-search-attribute-config-v1**](#get-single-search-attribute-config-v1) | **GET** `/accounts/v1/search-attribute-config/{name}` | Get extended search attribute +[**patch-search-attribute-config-v1**](#patch-search-attribute-config-v1) | **PATCH** `/accounts/v1/search-attribute-config/{name}` | Update extended search attribute + + +## create-search-attribute-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create extended search attributes +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig. +>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-search-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**searchattributeconfigV1** | **SearchattributeconfigV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**object** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchAttributeConfigurationV1Api(configuration); +const searchattributeconfigV1: SearchattributeconfigV1 = {"name":"newMailAttribute","displayName":"New Mail Attribute","applicationAttributes":{"2c9180866166b5b0016167c32ef31a66":"mail","2c9180866166b5b0016167c32ef31a67":"mail"}}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createSearchAttributeConfigV1(searchattributeconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-search-attribute-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete extended search attribute +Delete an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-search-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | Name of the extended search attribute configuration to delete. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchAttributeConfigurationV1Api(configuration); +const name: string = newMailAttribute; // Name of the extended search attribute configuration to delete. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteSearchAttributeConfigV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## get-search-attribute-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List extended search attributes +Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-search-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchAttributeConfigurationV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSearchAttributeConfigV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-single-search-attribute-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get extended search attribute +Get an extended attribute configuration by name. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-single-search-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | Name of the extended search attribute configuration to get. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SearchattributeconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchAttributeConfigurationV1Api(configuration); +const name: string = newMailAttribute; // Name of the extended search attribute configuration to get. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSingleSearchAttributeConfigV1(name); +console.log(result); +``` + +[[Back to top]](#) + +## patch-search-attribute-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update extended search attribute +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-search-attribute-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**name** | **string** | Name of the search attribute configuration to patch. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SearchattributeconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SearchAttributeConfigurationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SearchAttributeConfigurationV1Api(configuration); +const name: string = promotedMailAttribute; // Name of the search attribute configuration to patch. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"newAttributeName"},{"op":"replace","path":"/displayName","value":"new attribute display name"},{"op":"add","path":"/applicationAttributes","value":{"2c91808b79fd2422017a0b35d30f3968":"employeeNumber"}}]; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchSearchAttributeConfigV1(name, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/search_attribute_configuration/docs/Models/ArrayInner.md b/sdk-output/search_attribute_configuration/docs/Models/ArrayInner.md new file mode 100644 index 00000000..ad5255d2 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/search_attribute_configuration/docs/Models/Errormessagedto.md b/sdk-output/search_attribute_configuration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..a75d5219 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/search_attribute_configuration/docs/Models/Errorresponsedto.md b/sdk-output/search_attribute_configuration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fb0a81ce --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1401Response.md b/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1401Response.md new file mode 100644 index 00000000..eb9725d8 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-search-attribute-config-v1401-response-v1 +title: GetSearchAttributeConfigV1401ResponseV1 +pagination_label: GetSearchAttributeConfigV1401ResponseV1 +sidebar_label: GetSearchAttributeConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSearchAttributeConfigV1401ResponseV1', 'v1GetSearchAttributeConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/get-search-attribute-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSearchAttributeConfigV1401ResponseV1', 'v1GetSearchAttributeConfigV1401ResponseV1'] +--- + +# GetSearchAttributeConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1429Response.md b/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1429Response.md new file mode 100644 index 00000000..16d8545c --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/GetSearchAttributeConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-search-attribute-config-v1429-response-v1 +title: GetSearchAttributeConfigV1429ResponseV1 +pagination_label: GetSearchAttributeConfigV1429ResponseV1 +sidebar_label: GetSearchAttributeConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSearchAttributeConfigV1429ResponseV1', 'v1GetSearchAttributeConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/get-search-attribute-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSearchAttributeConfigV1429ResponseV1', 'v1GetSearchAttributeConfigV1429ResponseV1'] +--- + +# GetSearchAttributeConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/search_attribute_configuration/docs/Models/Index.md b/sdk-output/search_attribute_configuration/docs/Models/Index.md new file mode 100644 index 00000000..2593d51f --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: search_attribute_configuration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: search_attribute_configuration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'search_attribute_configuration', 'models'] +slug: /tools/sdk/typescript/search_attribute_configuration/models +tags: ['SDK', 'Software Development Kit', 'search_attribute_configuration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/search_attribute_configuration/docs/Models/Jsonpatchoperation.md b/sdk-output/search_attribute_configuration/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..7bc2228c --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/search_attribute_configuration/docs/Models/JsonpatchoperationValue.md b/sdk-output/search_attribute_configuration/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..696a0def --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/search_attribute_configuration/docs/Models/Localeorigin.md b/sdk-output/search_attribute_configuration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..f4476fe1 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/search_attribute_configuration/docs/Models/README.md b/sdk-output/search_attribute_configuration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/search_attribute_configuration/docs/Models/Searchattributeconfig.md b/sdk-output/search_attribute_configuration/docs/Models/Searchattributeconfig.md new file mode 100644 index 00000000..50bb7523 --- /dev/null +++ b/sdk-output/search_attribute_configuration/docs/Models/Searchattributeconfig.md @@ -0,0 +1,21 @@ +--- +id: v1-searchattributeconfig-v1 +title: SearchattributeconfigV1 +pagination_label: SearchattributeconfigV1 +sidebar_label: SearchattributeconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchattributeconfigV1', 'v1SearchattributeconfigV1'] +slug: /tools/sdk/typescript/search_attribute_configuration/models/searchattributeconfig-v1 +tags: ['SDK', 'Software Development Kit', 'SearchattributeconfigV1', 'v1SearchattributeconfigV1'] +--- + +# SearchattributeconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the new attribute | [default to undefined] +**displayName** | **(optional)** **string** | The display name of the new attribute | [default to undefined] +**applicationAttributes** | **(optional)** **object** | Map of application id and their associated attribute. | [default to undefined] + diff --git a/sdk-output/segments/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/segments/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bc63c90d --- /dev/null +++ b/sdk-output/segments/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,78 @@ +- path: /segments/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/segments/methods/segments#create-segment-v1 + source: | + import { SegmentsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SegmentsV1Api(configuration); + const segmentV1: SegmentV1 = ; // SegmentV1 | + const result = await apiInstance.createSegmentV1(segmentV1); + console.log(result); +- path: /segments/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/segments/methods/segments#delete-segment-v1 + source: | + import { SegmentsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SegmentsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The segment ID to delete. (default to undefined) + const result = await apiInstance.deleteSegmentV1(id); + console.log(result); +- path: /segments/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/segments/methods/segments#get-segment-v1 + source: | + import { SegmentsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SegmentsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The segment ID to retrieve. (default to undefined) + const result = await apiInstance.getSegmentV1(id); + console.log(result); +- path: /segments/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/segments/methods/segments#list-segments-v1 + source: | + import { SegmentsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SegmentsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listSegmentsV1(); + console.log(result); +- path: /segments/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/segments/methods/segments#patch-segment-v1 + source: | + import { SegmentsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SegmentsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The segment ID to modify. (default to undefined) + const requestBody: Array<object> = [{"op":"replace","path":"/visibilityCriteria","value":{"expression":{"operator":"AND","children":[{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Philadelphia"}},{"operator":"EQUALS","attribute":"department","value":{"type":"STRING","value":"HR"}}]}}}]; // Array | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + const result = await apiInstance.patchSegmentV1(id, requestBody); + console.log(result); diff --git a/sdk-output/segments/docs/Methods/Index.md b/sdk-output/segments/docs/Methods/Index.md new file mode 100644 index 00000000..038d3ac0 --- /dev/null +++ b/sdk-output/segments/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: segments-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: segments-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'segments', 'methods'] +slug: /tools/sdk/typescript/segments/methods +tags: ['SDK', 'Software Development Kit', 'segments', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/segments/docs/Methods/SegmentsV1Api.md b/sdk-output/segments/docs/Methods/SegmentsV1Api.md new file mode 100644 index 00000000..067fde43 --- /dev/null +++ b/sdk-output/segments/docs/Methods/SegmentsV1Api.md @@ -0,0 +1,240 @@ +--- +id: v1-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Segments', 'v1Segments'] +slug: /tools/sdk/typescript/segments/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'v1Segments'] +--- + +# SegmentsV1Api + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-segment-v1**](#create-segment-v1) | **POST** `/segments/v1` | Create segment +[**delete-segment-v1**](#delete-segment-v1) | **DELETE** `/segments/v1/{id}` | Delete segment by id +[**get-segment-v1**](#get-segment-v1) | **GET** `/segments/v1/{id}` | Get segment by id +[**list-segments-v1**](#list-segments-v1) | **GET** `/segments/v1` | List segments +[**patch-segment-v1**](#patch-segment-v1) | **PATCH** `/segments/v1/{id}` | Update segment + + +## create-segment-v1 +Create segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**segmentV1** | **SegmentV1** | | + +### Return type + +**SegmentV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SegmentsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SegmentsV1Api(configuration); +const segmentV1: SegmentV1 = ; // +const result = await apiInstance.createSegmentV1(segmentV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-segment-v1 +Delete segment by id +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The segment ID to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SegmentsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SegmentsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The segment ID to delete. +const result = await apiInstance.deleteSegmentV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-segment-v1 +Get segment by id +This API returns the segment specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The segment ID to retrieve. | [default to undefined] + +### Return type + +**SegmentV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SegmentsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SegmentsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The segment ID to retrieve. +const result = await apiInstance.getSegmentV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-segments-v1 +List segments +This API returns a list of all segments. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-segments-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SegmentsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SegmentsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listSegmentsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-segment-v1 +Update segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-segment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The segment ID to modify. | [default to undefined] +**requestBody** | **Array<object>** | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active | + +### Return type + +**SegmentV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SegmentsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SegmentsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The segment ID to modify. +const requestBody: Array<object> = [{"op":"replace","path":"/visibilityCriteria","value":{"expression":{"operator":"AND","children":[{"operator":"EQUALS","attribute":"location","value":{"type":"STRING","value":"Philadelphia"}},{"operator":"EQUALS","attribute":"department","value":{"type":"STRING","value":"HR"}}]}}}]; // A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active +const result = await apiInstance.patchSegmentV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/segments/docs/Models/Errormessagedto.md b/sdk-output/segments/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..9fd2955b --- /dev/null +++ b/sdk-output/segments/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/segments/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Errorresponsedto.md b/sdk-output/segments/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..f44b8cfd --- /dev/null +++ b/sdk-output/segments/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/segments/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Expression.md b/sdk-output/segments/docs/Models/Expression.md new file mode 100644 index 00000000..a7365cca --- /dev/null +++ b/sdk-output/segments/docs/Models/Expression.md @@ -0,0 +1,22 @@ +--- +id: v1-expression-v1 +title: ExpressionV1 +pagination_label: ExpressionV1 +sidebar_label: ExpressionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExpressionV1', 'v1ExpressionV1'] +slug: /tools/sdk/typescript/segments/models/expression-v1 +tags: ['SDK', 'Software Development Kit', 'ExpressionV1', 'v1ExpressionV1'] +--- + +# ExpressionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | Operator for the expression | [default to undefined] +**attribute** | **(optional)** **string** | Name for the attribute | [default to undefined] +**value** | **(optional)** **ValueV1** | | [default to undefined] +**children** | **(optional)** **Array<ExpressionChildrenInnerV1>** | List of expressions | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/ExpressionChildrenInner.md b/sdk-output/segments/docs/Models/ExpressionChildrenInner.md new file mode 100644 index 00000000..1754b4d9 --- /dev/null +++ b/sdk-output/segments/docs/Models/ExpressionChildrenInner.md @@ -0,0 +1,22 @@ +--- +id: v1-expression-children-inner-v1 +title: ExpressionChildrenInnerV1 +pagination_label: ExpressionChildrenInnerV1 +sidebar_label: ExpressionChildrenInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExpressionChildrenInnerV1', 'v1ExpressionChildrenInnerV1'] +slug: /tools/sdk/typescript/segments/models/expression-children-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInnerV1', 'v1ExpressionChildrenInnerV1'] +--- + +# ExpressionChildrenInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operator** | **(optional)** **string** | Operator for the expression | [default to undefined] +**attribute** | **(optional)** **string** | Name for the attribute | [default to undefined] +**value** | **(optional)** **ValueV1** | | [default to undefined] +**children** | **(optional)** **string** | There cannot be anymore nested children. This will always be null. | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Index.md b/sdk-output/segments/docs/Models/Index.md new file mode 100644 index 00000000..ff9b6843 --- /dev/null +++ b/sdk-output/segments/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: segments-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: segments-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'segments', 'models'] +slug: /tools/sdk/typescript/segments/models +tags: ['SDK', 'Software Development Kit', 'segments', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/segments/docs/Models/ListSegmentsV1401Response.md b/sdk-output/segments/docs/Models/ListSegmentsV1401Response.md new file mode 100644 index 00000000..d2862265 --- /dev/null +++ b/sdk-output/segments/docs/Models/ListSegmentsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-segments-v1401-response-v1 +title: ListSegmentsV1401ResponseV1 +pagination_label: ListSegmentsV1401ResponseV1 +sidebar_label: ListSegmentsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSegmentsV1401ResponseV1', 'v1ListSegmentsV1401ResponseV1'] +slug: /tools/sdk/typescript/segments/models/list-segments-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSegmentsV1401ResponseV1', 'v1ListSegmentsV1401ResponseV1'] +--- + +# ListSegmentsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/ListSegmentsV1429Response.md b/sdk-output/segments/docs/Models/ListSegmentsV1429Response.md new file mode 100644 index 00000000..98867c72 --- /dev/null +++ b/sdk-output/segments/docs/Models/ListSegmentsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-segments-v1429-response-v1 +title: ListSegmentsV1429ResponseV1 +pagination_label: ListSegmentsV1429ResponseV1 +sidebar_label: ListSegmentsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSegmentsV1429ResponseV1', 'v1ListSegmentsV1429ResponseV1'] +slug: /tools/sdk/typescript/segments/models/list-segments-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSegmentsV1429ResponseV1', 'v1ListSegmentsV1429ResponseV1'] +--- + +# ListSegmentsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Localeorigin.md b/sdk-output/segments/docs/Models/Localeorigin.md new file mode 100644 index 00000000..0b664fd7 --- /dev/null +++ b/sdk-output/segments/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/segments/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/segments/docs/Models/Ownerreferencesegments.md b/sdk-output/segments/docs/Models/Ownerreferencesegments.md new file mode 100644 index 00000000..83762b1c --- /dev/null +++ b/sdk-output/segments/docs/Models/Ownerreferencesegments.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerreferencesegments-v1 +title: OwnerreferencesegmentsV1 +pagination_label: OwnerreferencesegmentsV1 +sidebar_label: OwnerreferencesegmentsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerreferencesegmentsV1', 'v1OwnerreferencesegmentsV1'] +slug: /tools/sdk/typescript/segments/models/ownerreferencesegments-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerreferencesegmentsV1', 'v1OwnerreferencesegmentsV1'] +--- + +# OwnerreferencesegmentsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. This field must be either left null or set to \'IDENTITY\' on input, otherwise a 400 Bad Request error will result. | [default to undefined] +**id** | **(optional)** **string** | Identity id | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner\'s display name, otherwise a 400 Bad Request error will result. | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/README.md b/sdk-output/segments/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/segments/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/segments/docs/Models/Segment.md b/sdk-output/segments/docs/Models/Segment.md new file mode 100644 index 00000000..053a81d8 --- /dev/null +++ b/sdk-output/segments/docs/Models/Segment.md @@ -0,0 +1,26 @@ +--- +id: v1-segment-v1 +title: SegmentV1 +pagination_label: SegmentV1 +sidebar_label: SegmentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SegmentV1', 'v1SegmentV1'] +slug: /tools/sdk/typescript/segments/models/segment-v1 +tags: ['SDK', 'Software Development Kit', 'SegmentV1', 'v1SegmentV1'] +--- + +# SegmentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The segment\'s ID. | [default to undefined] +**name** | **(optional)** **string** | The segment\'s business name. | [default to undefined] +**created** | **(optional)** **string** | The time when the segment is created. | [default to undefined] +**modified** | **(optional)** **string** | The time when the segment is modified. | [default to undefined] +**description** | **(optional)** **string** | The segment\'s optional description. | [default to undefined] +**owner** | **(optional)** **OwnerreferencesegmentsV1** | | [default to undefined] +**visibilityCriteria** | **(optional)** **SegmentVisibilityCriteriaV1** | | [default to undefined] +**active** | **(optional)** **boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [default to false] + diff --git a/sdk-output/segments/docs/Models/SegmentVisibilityCriteria.md b/sdk-output/segments/docs/Models/SegmentVisibilityCriteria.md new file mode 100644 index 00000000..616d9d41 --- /dev/null +++ b/sdk-output/segments/docs/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-segment-visibility-criteria-v1 +title: SegmentVisibilityCriteriaV1 +pagination_label: SegmentVisibilityCriteriaV1 +sidebar_label: SegmentVisibilityCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SegmentVisibilityCriteriaV1', 'v1SegmentVisibilityCriteriaV1'] +slug: /tools/sdk/typescript/segments/models/segment-visibility-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteriaV1', 'v1SegmentVisibilityCriteriaV1'] +--- + +# SegmentVisibilityCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | **(optional)** **ExpressionV1** | | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Value.md b/sdk-output/segments/docs/Models/Value.md new file mode 100644 index 00000000..e4cf4540 --- /dev/null +++ b/sdk-output/segments/docs/Models/Value.md @@ -0,0 +1,20 @@ +--- +id: v1-value-v1 +title: ValueV1 +pagination_label: ValueV1 +sidebar_label: ValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ValueV1', 'v1ValueV1'] +slug: /tools/sdk/typescript/segments/models/value-v1 +tags: ['SDK', 'Software Development Kit', 'ValueV1', 'v1ValueV1'] +--- + +# ValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of attribute value | [default to undefined] +**value** | **(optional)** **string** | The attribute value | [default to undefined] + diff --git a/sdk-output/segments/docs/Models/Visibilitycriteria.md b/sdk-output/segments/docs/Models/Visibilitycriteria.md new file mode 100644 index 00000000..9ea52bc8 --- /dev/null +++ b/sdk-output/segments/docs/Models/Visibilitycriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-visibilitycriteria-v1 +title: VisibilitycriteriaV1 +pagination_label: VisibilitycriteriaV1 +sidebar_label: VisibilitycriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VisibilitycriteriaV1', 'v1VisibilitycriteriaV1'] +slug: /tools/sdk/typescript/segments/models/visibilitycriteria-v1 +tags: ['SDK', 'Software Development Kit', 'VisibilitycriteriaV1', 'v1VisibilitycriteriaV1'] +--- + +# VisibilitycriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expression** | **(optional)** **ExpressionV1** | | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/service_desk_integration/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..4034b602 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,154 @@ +- path: /service-desk-integrations/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#create-service-desk-integration-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 = ; // ServicedeskintegrationdtoV1 | The specifics of a new integration to create + const result = await apiInstance.createServiceDeskIntegrationV1(servicedeskintegrationdtoV1); + console.log(result); +- path: /service-desk-integrations/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#delete-service-desk-integration-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const id: string = 'anId'; // string | ID of Service Desk integration to delete (default to undefined) + const result = await apiInstance.deleteServiceDeskIntegrationV1(id); + console.log(result); +- path: /service-desk-integrations/v1/templates/{scriptName} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#get-service-desk-integration-template-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const scriptName: string = 'aScriptName'; // string | The scriptName value of the Service Desk integration template to get (default to undefined) + const result = await apiInstance.getServiceDeskIntegrationTemplateV1(scriptName); + console.log(result); +- path: /service-desk-integrations/v1/types + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#get-service-desk-integration-types-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const result = await apiInstance.getServiceDeskIntegrationTypesV1(); + console.log(result); +- path: /service-desk-integrations/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#get-service-desk-integration-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const id: string = 'anId'; // string | ID of the Service Desk integration to get (default to undefined) + const result = await apiInstance.getServiceDeskIntegrationV1(id); + console.log(result); +- path: /service-desk-integrations/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#get-service-desk-integrations-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) (default to undefined) + const filters: string = 'name eq "John Doe"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) (default to undefined) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getServiceDeskIntegrationsV1(); + console.log(result); +- path: /service-desk-integrations/v1/status-check-configuration + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#get-status-check-details-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const result = await apiInstance.getStatusCheckDetailsV1(); + console.log(result); +- path: /service-desk-integrations/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#patch-service-desk-integration-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const id: string = 'anId'; // string | ID of the Service Desk integration to update (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + const result = await apiInstance.patchServiceDeskIntegrationV1(id, jsonpatchoperationV1); + console.log(result); +- path: /service-desk-integrations/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#put-service-desk-integration-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const id: string = 'anId'; // string | ID of the Service Desk integration to update (default to undefined) + const servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 = ; // ServicedeskintegrationdtoV1 | The specifics of the integration to update + const result = await apiInstance.putServiceDeskIntegrationV1(id, servicedeskintegrationdtoV1); + console.log(result); +- path: /service-desk-integrations/v1/status-check-configuration + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/service_desk_integration/methods/service-desk-integration#update-status-check-details-v1 + source: | + import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new ServiceDeskIntegrationV1Api(configuration); + const queuedcheckconfigdetailsV1: QueuedcheckconfigdetailsV1 = ; // QueuedcheckconfigdetailsV1 | The modified time check configuration + const result = await apiInstance.updateStatusCheckDetailsV1(queuedcheckconfigdetailsV1); + console.log(result); diff --git a/sdk-output/service_desk_integration/docs/Methods/Index.md b/sdk-output/service_desk_integration/docs/Methods/Index.md new file mode 100644 index 00000000..c1e3ee6c --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: service_desk_integration-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: service_desk_integration-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'service_desk_integration', 'methods'] +slug: /tools/sdk/typescript/service_desk_integration/methods +tags: ['SDK', 'Software Development Kit', 'service_desk_integration', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/service_desk_integration/docs/Methods/ServiceDeskIntegrationV1Api.md b/sdk-output/service_desk_integration/docs/Methods/ServiceDeskIntegrationV1Api.md new file mode 100644 index 00000000..51659cc6 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Methods/ServiceDeskIntegrationV1Api.md @@ -0,0 +1,437 @@ +--- +id: v1-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServiceDeskIntegration', 'v1ServiceDeskIntegration'] +slug: /tools/sdk/typescript/service_desk_integration/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'v1ServiceDeskIntegration'] +--- + +# ServiceDeskIntegrationV1Api + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-service-desk-integration-v1**](#create-service-desk-integration-v1) | **POST** `/service-desk-integrations/v1` | Create new service desk integration +[**delete-service-desk-integration-v1**](#delete-service-desk-integration-v1) | **DELETE** `/service-desk-integrations/v1/{id}` | Delete a service desk integration +[**get-service-desk-integration-template-v1**](#get-service-desk-integration-template-v1) | **GET** `/service-desk-integrations/v1/templates/{scriptName}` | Service desk integration template by scriptname +[**get-service-desk-integration-types-v1**](#get-service-desk-integration-types-v1) | **GET** `/service-desk-integrations/v1/types` | List service desk integration types +[**get-service-desk-integration-v1**](#get-service-desk-integration-v1) | **GET** `/service-desk-integrations/v1/{id}` | Get a service desk integration +[**get-service-desk-integrations-v1**](#get-service-desk-integrations-v1) | **GET** `/service-desk-integrations/v1` | List existing service desk integrations +[**get-status-check-details-v1**](#get-status-check-details-v1) | **GET** `/service-desk-integrations/v1/status-check-configuration` | Get the time check configuration +[**patch-service-desk-integration-v1**](#patch-service-desk-integration-v1) | **PATCH** `/service-desk-integrations/v1/{id}` | Patch a service desk integration +[**put-service-desk-integration-v1**](#put-service-desk-integration-v1) | **PUT** `/service-desk-integrations/v1/{id}` | Update a service desk integration +[**update-status-check-details-v1**](#update-status-check-details-v1) | **PUT** `/service-desk-integrations/v1/status-check-configuration` | Update the time check configuration + + +## create-service-desk-integration-v1 +Create new service desk integration +Create a new Service Desk integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-service-desk-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**servicedeskintegrationdtoV1** | **ServicedeskintegrationdtoV1** | The specifics of a new integration to create | + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 = ; // The specifics of a new integration to create +const result = await apiInstance.createServiceDeskIntegrationV1(servicedeskintegrationdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-service-desk-integration-v1 +Delete a service desk integration +Delete an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-service-desk-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of Service Desk integration to delete | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const id: string = anId; // ID of Service Desk integration to delete +const result = await apiInstance.deleteServiceDeskIntegrationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-service-desk-integration-template-v1 +Service desk integration template by scriptname +This API endpoint returns an existing Service Desk integration template by scriptName. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-template-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**scriptName** | **string** | The scriptName value of the Service Desk integration template to get | [default to undefined] + +### Return type + +**ServicedeskintegrationtemplatedtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const scriptName: string = aScriptName; // The scriptName value of the Service Desk integration template to get +const result = await apiInstance.getServiceDeskIntegrationTemplateV1(scriptName); +console.log(result); +``` + +[[Back to top]](#) + +## get-service-desk-integration-types-v1 +List service desk integration types +This API endpoint returns the current list of supported Service Desk integration types. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-types-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const result = await apiInstance.getServiceDeskIntegrationTypesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-service-desk-integration-v1 +Get a service desk integration +Get an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Service Desk integration to get | [default to undefined] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const id: string = anId; // ID of the Service Desk integration to get +const result = await apiInstance.getServiceDeskIntegrationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-service-desk-integrations-v1 +List existing service desk integrations +Get a list of Service Desk integration objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-service-desk-integrations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* | [optional] [default to undefined] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +const filters: string = name eq "John Doe"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getServiceDeskIntegrationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-status-check-details-v1 +Get the time check configuration +Get the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-status-check-details-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**QueuedcheckconfigdetailsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const result = await apiInstance.getStatusCheckDetailsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-service-desk-integration-v1 +Patch a service desk integration +Update an existing Service Desk integration by ID with a PATCH request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-service-desk-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Service Desk integration to update | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. | + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const id: string = anId; // ID of the Service Desk integration to update +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. +const result = await apiInstance.patchServiceDeskIntegrationV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-service-desk-integration-v1 +Update a service desk integration +Update an existing Service Desk integration by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-service-desk-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Service Desk integration to update | [default to undefined] +**servicedeskintegrationdtoV1** | **ServicedeskintegrationdtoV1** | The specifics of the integration to update | + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const id: string = anId; // ID of the Service Desk integration to update +const servicedeskintegrationdtoV1: ServicedeskintegrationdtoV1 = ; // The specifics of the integration to update +const result = await apiInstance.putServiceDeskIntegrationV1(id, servicedeskintegrationdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-status-check-details-v1 +Update the time check configuration +Update the time check configuration of queued SDIM tickets. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-status-check-details-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**queuedcheckconfigdetailsV1** | **QueuedcheckconfigdetailsV1** | The modified time check configuration | + +### Return type + +**QueuedcheckconfigdetailsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { ServiceDeskIntegrationV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new ServiceDeskIntegrationV1Api(configuration); +const queuedcheckconfigdetailsV1: QueuedcheckconfigdetailsV1 = ; // The modified time check configuration +const result = await apiInstance.updateStatusCheckDetailsV1(queuedcheckconfigdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/service_desk_integration/docs/Models/ArrayInner.md b/sdk-output/service_desk_integration/docs/Models/ArrayInner.md new file mode 100644 index 00000000..97ec3693 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/service_desk_integration/docs/Models/Basecommondto.md b/sdk-output/service_desk_integration/docs/Models/Basecommondto.md new file mode 100644 index 00000000..6926b15a --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Beforeprovisioningruledto.md b/sdk-output/service_desk_integration/docs/Models/Beforeprovisioningruledto.md new file mode 100644 index 00000000..08b26f62 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Beforeprovisioningruledto.md @@ -0,0 +1,21 @@ +--- +id: v1-beforeprovisioningruledto-v1 +title: BeforeprovisioningruledtoV1 +pagination_label: BeforeprovisioningruledtoV1 +sidebar_label: BeforeprovisioningruledtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BeforeprovisioningruledtoV1', 'v1BeforeprovisioningruledtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/beforeprovisioningruledto-v1 +tags: ['SDK', 'Software Development Kit', 'BeforeprovisioningruledtoV1', 'v1BeforeprovisioningruledtoV1'] +--- + +# BeforeprovisioningruledtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Before Provisioning Rule DTO type. | [default to undefined] +**id** | **(optional)** **string** | Before Provisioning Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule display name. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Errormessagedto.md b/sdk-output/service_desk_integration/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..2180d8b6 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Errorresponsedto.md b/sdk-output/service_desk_integration/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..e6eb23f2 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1401Response.md b/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1401Response.md new file mode 100644 index 00000000..faf3a9e4 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-service-desk-integrations-v1401-response-v1 +title: GetServiceDeskIntegrationsV1401ResponseV1 +pagination_label: GetServiceDeskIntegrationsV1401ResponseV1 +sidebar_label: GetServiceDeskIntegrationsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetServiceDeskIntegrationsV1401ResponseV1', 'v1GetServiceDeskIntegrationsV1401ResponseV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/get-service-desk-integrations-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetServiceDeskIntegrationsV1401ResponseV1', 'v1GetServiceDeskIntegrationsV1401ResponseV1'] +--- + +# GetServiceDeskIntegrationsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1429Response.md b/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1429Response.md new file mode 100644 index 00000000..9af8c33a --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/GetServiceDeskIntegrationsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-service-desk-integrations-v1429-response-v1 +title: GetServiceDeskIntegrationsV1429ResponseV1 +pagination_label: GetServiceDeskIntegrationsV1429ResponseV1 +sidebar_label: GetServiceDeskIntegrationsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetServiceDeskIntegrationsV1429ResponseV1', 'v1GetServiceDeskIntegrationsV1429ResponseV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/get-service-desk-integrations-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetServiceDeskIntegrationsV1429ResponseV1', 'v1GetServiceDeskIntegrationsV1429ResponseV1'] +--- + +# GetServiceDeskIntegrationsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Index.md b/sdk-output/service_desk_integration/docs/Models/Index.md new file mode 100644 index 00000000..3c5f1bdf --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: service_desk_integration-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: service_desk_integration-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'service_desk_integration', 'models'] +slug: /tools/sdk/typescript/service_desk_integration/models +tags: ['SDK', 'Software Development Kit', 'service_desk_integration', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/service_desk_integration/docs/Models/Jsonpatchoperation.md b/sdk-output/service_desk_integration/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..bd53d825 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/JsonpatchoperationValue.md b/sdk-output/service_desk_integration/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..48074a3d --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/service_desk_integration/docs/Models/Localeorigin.md b/sdk-output/service_desk_integration/docs/Models/Localeorigin.md new file mode 100644 index 00000000..9cd85ee6 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/service_desk_integration/docs/Models/Ownerdto.md b/sdk-output/service_desk_integration/docs/Models/Ownerdto.md new file mode 100644 index 00000000..47104ace --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Ownerdto.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerdto-v1 +title: OwnerdtoV1 +pagination_label: OwnerdtoV1 +sidebar_label: OwnerdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerdtoV1', 'v1OwnerdtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/ownerdto-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerdtoV1', 'v1OwnerdtoV1'] +--- + +# OwnerdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Provisioningconfig.md b/sdk-output/service_desk_integration/docs/Models/Provisioningconfig.md new file mode 100644 index 00000000..bf8a7e10 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Provisioningconfig.md @@ -0,0 +1,23 @@ +--- +id: v1-provisioningconfig-v1 +title: ProvisioningconfigV1 +pagination_label: ProvisioningconfigV1 +sidebar_label: ProvisioningconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningconfigV1', 'v1ProvisioningconfigV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/provisioningconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningconfigV1', 'v1ProvisioningconfigV1'] +--- + +# ProvisioningconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universalManager** | **(optional)** **boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [readonly] [default to false] +**managedResourceRefs** | **(optional)** **Array<ServicedesksourceV1>** | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [default to undefined] +**planInitializerScript** | **(optional)** **ProvisioningconfigPlanInitializerScriptV1** | | [default to undefined] +**noProvisioningRequests** | **(optional)** **boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [default to false] +**provisioningRequestExpiration** | **(optional)** **number** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/ProvisioningconfigPlanInitializerScript.md b/sdk-output/service_desk_integration/docs/Models/ProvisioningconfigPlanInitializerScript.md new file mode 100644 index 00000000..d88487e4 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/ProvisioningconfigPlanInitializerScript.md @@ -0,0 +1,19 @@ +--- +id: v1-provisioningconfig-plan-initializer-script-v1 +title: ProvisioningconfigPlanInitializerScriptV1 +pagination_label: ProvisioningconfigPlanInitializerScriptV1 +sidebar_label: ProvisioningconfigPlanInitializerScriptV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningconfigPlanInitializerScriptV1', 'v1ProvisioningconfigPlanInitializerScriptV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/provisioningconfig-plan-initializer-script-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningconfigPlanInitializerScriptV1', 'v1ProvisioningconfigPlanInitializerScriptV1'] +--- + +# ProvisioningconfigPlanInitializerScriptV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **(optional)** **string** | This is a Rule that allows provisioning instruction changes. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Queuedcheckconfigdetails.md b/sdk-output/service_desk_integration/docs/Models/Queuedcheckconfigdetails.md new file mode 100644 index 00000000..0a2ebd67 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Queuedcheckconfigdetails.md @@ -0,0 +1,20 @@ +--- +id: v1-queuedcheckconfigdetails-v1 +title: QueuedcheckconfigdetailsV1 +pagination_label: QueuedcheckconfigdetailsV1 +sidebar_label: QueuedcheckconfigdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'QueuedcheckconfigdetailsV1', 'v1QueuedcheckconfigdetailsV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/queuedcheckconfigdetails-v1 +tags: ['SDK', 'Software Development Kit', 'QueuedcheckconfigdetailsV1', 'v1QueuedcheckconfigdetailsV1'] +--- + +# QueuedcheckconfigdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**provisioningStatusCheckIntervalMinutes** | **string** | Interval in minutes between status checks | [default to undefined] +**provisioningMaxStatusCheckDays** | **string** | Maximum number of days to check | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/README.md b/sdk-output/service_desk_integration/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationdto.md b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationdto.md new file mode 100644 index 00000000..d2e522cc --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationdto.md @@ -0,0 +1,31 @@ +--- +id: v1-servicedeskintegrationdto-v1 +title: ServicedeskintegrationdtoV1 +pagination_label: ServicedeskintegrationdtoV1 +sidebar_label: ServicedeskintegrationdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedeskintegrationdtoV1', 'v1ServicedeskintegrationdtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/servicedeskintegrationdto-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedeskintegrationdtoV1', 'v1ServicedeskintegrationdtoV1'] +--- + +# ServicedeskintegrationdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the Service Desk integration | [default to undefined] +**name** | **string** | Service Desk integration\'s name. The name must be unique. | [default to undefined] +**created** | **(optional)** **string** | The date and time the Service Desk integration was created | [default to undefined] +**modified** | **(optional)** **string** | The date and time the Service Desk integration was last modified | [default to undefined] +**description** | **string** | Service Desk integration\'s description. | [default to undefined] +**type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to 'ServiceNowSDIM'] +**ownerRef** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**clusterRef** | **(optional)** **SourceclusterdtoV1** | | [default to undefined] +**cluster** | **(optional)** **string** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [default to undefined] +**managedSources** | **(optional)** **Array<string>** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [default to undefined] +**provisioningConfig** | **(optional)** **ProvisioningconfigV1** | | [default to undefined] +**attributes** | | Service Desk integration\'s attributes. Validation constraints enforced by the implementation. | [default to undefined] +**beforeProvisioningRule** | **(optional)** **BeforeprovisioningruledtoV1** | | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatedto.md b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatedto.md new file mode 100644 index 00000000..ddcd54c5 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatedto.md @@ -0,0 +1,25 @@ +--- +id: v1-servicedeskintegrationtemplatedto-v1 +title: ServicedeskintegrationtemplatedtoV1 +pagination_label: ServicedeskintegrationtemplatedtoV1 +sidebar_label: ServicedeskintegrationtemplatedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedeskintegrationtemplatedtoV1', 'v1ServicedeskintegrationtemplatedtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/servicedeskintegrationtemplatedto-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedeskintegrationtemplatedtoV1', 'v1ServicedeskintegrationtemplatedtoV1'] +--- + +# ServicedeskintegrationtemplatedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**type** | **string** | The \'type\' property specifies the type of the Service Desk integration template. | [default to 'Web Service SDIM'] +**attributes** | | The \'attributes\' property value is a map of attributes available for integrations using this Service Desk integration template. | [default to undefined] +**provisioningConfig** | **ProvisioningconfigV1** | | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatetype.md b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatetype.md new file mode 100644 index 00000000..70d6db4b --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Servicedeskintegrationtemplatetype.md @@ -0,0 +1,21 @@ +--- +id: v1-servicedeskintegrationtemplatetype-v1 +title: ServicedeskintegrationtemplatetypeV1 +pagination_label: ServicedeskintegrationtemplatetypeV1 +sidebar_label: ServicedeskintegrationtemplatetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedeskintegrationtemplatetypeV1', 'v1ServicedeskintegrationtemplatetypeV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/servicedeskintegrationtemplatetype-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedeskintegrationtemplatetypeV1', 'v1ServicedeskintegrationtemplatetypeV1'] +--- + +# ServicedeskintegrationtemplatetypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | This is the name of the type. | [default to undefined] +**type** | **string** | This is the type value for the type. | [default to undefined] +**scriptName** | **string** | This is the scriptName attribute value for the type. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Servicedesksource.md b/sdk-output/service_desk_integration/docs/Models/Servicedesksource.md new file mode 100644 index 00000000..d993d2b3 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Servicedesksource.md @@ -0,0 +1,21 @@ +--- +id: v1-servicedesksource-v1 +title: ServicedesksourceV1 +pagination_label: ServicedesksourceV1 +sidebar_label: ServicedesksourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedesksourceV1', 'v1ServicedesksourceV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/servicedesksource-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedesksourceV1', 'v1ServicedesksourceV1'] +--- + +# ServicedesksourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of source for service desk integration template. | [default to undefined] +**id** | **(optional)** **string** | ID of source for service desk integration template. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of source for service desk integration template. | [default to undefined] + diff --git a/sdk-output/service_desk_integration/docs/Models/Sourceclusterdto.md b/sdk-output/service_desk_integration/docs/Models/Sourceclusterdto.md new file mode 100644 index 00000000..4cf01456 --- /dev/null +++ b/sdk-output/service_desk_integration/docs/Models/Sourceclusterdto.md @@ -0,0 +1,21 @@ +--- +id: v1-sourceclusterdto-v1 +title: SourceclusterdtoV1 +pagination_label: SourceclusterdtoV1 +sidebar_label: SourceclusterdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceclusterdtoV1', 'v1SourceclusterdtoV1'] +slug: /tools/sdk/typescript/service_desk_integration/models/sourceclusterdto-v1 +tags: ['SDK', 'Software Development Kit', 'SourceclusterdtoV1', 'v1SourceclusterdtoV1'] +--- + +# SourceclusterdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Source cluster DTO type. | [default to undefined] +**id** | **(optional)** **string** | Source cluster ID. | [default to undefined] +**name** | **(optional)** **string** | Source cluster display name. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/shared_signals_framework_ssf/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e5cb19aa --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,148 @@ +- path: /ssf/v1/streams + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#create-stream-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const createstreamrequestV1: CreatestreamrequestV1 = {"delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Production event stream for session revocation notifications"}; // CreatestreamrequestV1 | + const result = await apiInstance.createStreamV1(createstreamrequestV1); + console.log(result); +- path: /ssf/v1/streams + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#delete-stream-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const streamId: string = '550e8400-e29b-41d4-a716-446655440000'; // string | ID of the stream to delete. Required; omitted or empty returns 400. (default to undefined) + const result = await apiInstance.deleteStreamV1(streamId); + console.log(result); +- path: /ssf/v1/jwks + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#get-jwks-data-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const result = await apiInstance.getJWKSDataV1(); + console.log(result); +- path: /.well-known/v1/ssf-configuration + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#get-ssf-configuration-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const result = await apiInstance.getSSFConfigurationV1(); + console.log(result); +- path: /ssf/v1/streams/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#get-stream-status-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const streamId: string = '550e8400-e29b-41d4-a716-446655440000'; // string | ID of the stream whose status to retrieve. (default to undefined) + const result = await apiInstance.getStreamStatusV1(streamId); + console.log(result); +- path: /ssf/v1/streams + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#get-stream-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const streamId: string = '550e8400-e29b-41d4-a716-446655440000'; // string | If provided, returns that stream; otherwise returns list of all streams. (optional) (default to undefined) + const result = await apiInstance.getStreamV1(); + console.log(result); +- path: /ssf/v1/streams/verify + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#send-stream-verification-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const verificationrequestV1: VerificationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","state":"verification-challenge-state-123"}; // VerificationrequestV1 | + const result = await apiInstance.sendStreamVerificationV1(verificationrequestV1); + console.log(result); +- path: /ssf/v1/streams + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#set-stream-configuration-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const replacestreamconfigurationrequestV1: ReplacestreamconfigurationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Replaced stream configuration for production event delivery"}; // ReplacestreamconfigurationrequestV1 | + const result = await apiInstance.setStreamConfigurationV1(replacestreamconfigurationrequestV1); + console.log(result); +- path: /ssf/v1/streams + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#update-stream-configuration-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const updatestreamconfigurationrequestV1: UpdatestreamconfigurationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","description":"Updated production event stream configuration"}; // UpdatestreamconfigurationrequestV1 | + const result = await apiInstance.updateStreamConfigurationV1(updatestreamconfigurationrequestV1); + console.log(result); +- path: /ssf/v1/streams/status + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf#update-stream-status-v1 + source: | + import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); + const updatestreamstatusrequestV1: UpdatestreamstatusrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","status":"paused","reason":"manually paused"}; // UpdatestreamstatusrequestV1 | + const result = await apiInstance.updateStreamStatusV1(updatestreamstatusrequestV1); + console.log(result); diff --git a/sdk-output/shared_signals_framework_ssf/docs/Methods/Index.md b/sdk-output/shared_signals_framework_ssf/docs/Methods/Index.md new file mode 100644 index 00000000..0cdfb5c7 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: shared_signals_framework_ssf-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: shared_signals_framework_ssf-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'shared_signals_framework_ssf', 'methods'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/methods +tags: ['SDK', 'Software Development Kit', 'shared_signals_framework_ssf', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFV1Api.md b/sdk-output/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFV1Api.md new file mode 100644 index 00000000..0498493f --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFV1Api.md @@ -0,0 +1,428 @@ +--- +id: v1-shared-signals-framework-ssf +title: SharedSignalsFrameworkSSF +pagination_label: SharedSignalsFrameworkSSF +sidebar_label: SharedSignalsFrameworkSSF +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SharedSignalsFrameworkSSF', 'v1SharedSignalsFrameworkSSF'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/methods/shared-signals-framework-ssf +tags: ['SDK', 'Software Development Kit', 'SharedSignalsFrameworkSSF', 'v1SharedSignalsFrameworkSSF'] +--- + +# SharedSignalsFrameworkSSFV1Api + The SSF Transmitter Service is a security event notification system that monitors identity attribute changes +and automatically triggers session revocation events when specific lifecycle conditions are met. + +Use this API to implement transmitter functionality so administrators can discover the transmitter and manage streams. +Transmitters send identity data and events from Identity Security Cloud to external receivers over the Secure Sync Framework (SSF). +The SSF configuration and JWKS endpoints support discovery and verification; the stream management endpoints support creating, updating, and managing streams and verifying receivers. +In Identity Security Cloud, administrators can use the "Connections" > "Shared Signals" area to view and manage transmitters and their streams. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-stream-v1**](#create-stream-v1) | **POST** `/ssf/v1/streams` | Create stream +[**delete-stream-v1**](#delete-stream-v1) | **DELETE** `/ssf/v1/streams` | Delete stream +[**get-jwks-data-v1**](#get-jwks-data-v1) | **GET** `/ssf/v1/jwks` | Get JWKS +[**get-ssf-configuration-v1**](#get-ssf-configuration-v1) | **GET** `/.well-known/v1/ssf-configuration` | Get SSF configuration +[**get-stream-status-v1**](#get-stream-status-v1) | **GET** `/ssf/v1/streams/status` | Get stream status +[**get-stream-v1**](#get-stream-v1) | **GET** `/ssf/v1/streams` | Get stream(s) +[**send-stream-verification-v1**](#send-stream-verification-v1) | **POST** `/ssf/v1/streams/verify` | Verify stream +[**set-stream-configuration-v1**](#set-stream-configuration-v1) | **PUT** `/ssf/v1/streams` | Replace stream configuration +[**update-stream-configuration-v1**](#update-stream-configuration-v1) | **PATCH** `/ssf/v1/streams` | Update stream configuration +[**update-stream-status-v1**](#update-stream-status-v1) | **POST** `/ssf/v1/streams/status` | Update stream status + + +## create-stream-v1 +Create stream +An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. +One SSF stream is allowed for each client ID. + +You can create a maximum of 10 SSF stream configurations for one org. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-stream-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createstreamrequestV1** | **CreatestreamrequestV1** | | + +### Return type + +**StreamconfigresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const createstreamrequestV1: CreatestreamrequestV1 = {"delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Production event stream for session revocation notifications"}; // +const result = await apiInstance.createStreamV1(createstreamrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-stream-v1 +Delete stream +Deletes a stream by its ID. There is no request body; the stream is identified by the required +query parameter `stream_id`. On success the response has no body (204 No Content). + +The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-stream-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**streamId** | **string** | ID of the stream to delete. Required; omitted or empty returns 400. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const streamId: string = 550e8400-e29b-41d4-a716-446655440000; // ID of the stream to delete. Required; omitted or empty returns 400. +const result = await apiInstance.deleteStreamV1(streamId); +console.log(result); +``` + +[[Back to top]](#) + +## get-jwks-data-v1 +Get JWKS +Returns the transmitter's JSON Web Key Set (JWKS) for verifying signed delivery requests. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-jwks-data-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**JwksV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const result = await apiInstance.getJWKSDataV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-ssf-configuration-v1 +Get SSF configuration +Returns the SSF transmitter discovery metadata (well-known configuration). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-ssf-configuration-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**TransmittermetadataV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const result = await apiInstance.getSSFConfigurationV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-stream-status-v1 +Get stream status +Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token. The stream_id query parameter is required. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-stream-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**streamId** | **string** | ID of the stream whose status to retrieve. | [default to undefined] + +### Return type + +**StreamstatusresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const streamId: string = 550e8400-e29b-41d4-a716-446655440000; // ID of the stream whose status to retrieve. +const result = await apiInstance.getStreamStatusV1(streamId); +console.log(result); +``` + +[[Back to top]](#) + +## get-stream-v1 +Get stream(s) +Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. + +As stream configurations are tied to a client ID, you can only view the stream associated with the client ID +of the request OAuth 2.0 access token. + +Query parameter `aud` (co filter) can be used to filter by audience. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-stream-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**streamId** | **string** | If provided, returns that stream; otherwise returns list of all streams. | [optional] [default to undefined] + +### Return type + +**GetStreamV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const streamId: string = 550e8400-e29b-41d4-a716-446655440000; // If provided, returns that stream; otherwise returns list of all streams. (optional) +const result = await apiInstance.getStreamV1(); +console.log(result); +``` + +[[Back to top]](#) + +## send-stream-verification-v1 +Verify stream +Verifies an SSF stream by publishing a verification event requested by a security events provider. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/send-stream-verification-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**verificationrequestV1** | **VerificationrequestV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const verificationrequestV1: VerificationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","state":"verification-challenge-state-123"}; // +const result = await apiInstance.sendStreamVerificationV1(verificationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-stream-configuration-v1 +Replace stream configuration +Replaces a stream's configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. + +The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-stream-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**replacestreamconfigurationrequestV1** | **ReplacestreamconfigurationrequestV1** | | + +### Return type + +**UpdatestreamconfigresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const replacestreamconfigurationrequestV1: ReplacestreamconfigurationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","delivery":{"method":"urn:ietf:rfc:8935","endpoint_url":"https://receiver.example.com/ssf/events"},"events_requested":["https://schemas.openid.net/secevent/caep/event-type/session-revoked"],"description":"Replaced stream configuration for production event delivery"}; // +const result = await apiInstance.setStreamConfigurationV1(replacestreamconfigurationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-stream-configuration-v1 +Update stream configuration +Partially updates a stream's configuration (PATCH). Only provided fields are updated. + +The associated stream with the client ID (through the request OAuth 2.0 access token) is updated. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-stream-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**updatestreamconfigurationrequestV1** | **UpdatestreamconfigurationrequestV1** | | + +### Return type + +**UpdatestreamconfigresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const updatestreamconfigurationrequestV1: UpdatestreamconfigurationrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","description":"Updated production event stream configuration"}; // +const result = await apiInstance.updateStreamConfigurationV1(updatestreamconfigurationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-stream-status-v1 +Update stream status +Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request's OAuth 2.0 access token. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-stream-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**updatestreamstatusrequestV1** | **UpdatestreamstatusrequestV1** | | + +### Return type + +**StreamstatusresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SharedSignalsFrameworkSSFV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SharedSignalsFrameworkSSFV1Api(configuration); +const updatestreamstatusrequestV1: UpdatestreamstatusrequestV1 = {"stream_id":"550e8400-e29b-41d4-a716-446655440000","status":"paused","reason":"manually paused"}; // +const result = await apiInstance.updateStreamStatusV1(updatestreamstatusrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Authorizationscheme.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Authorizationscheme.md new file mode 100644 index 00000000..f7be0700 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Authorizationscheme.md @@ -0,0 +1,19 @@ +--- +id: v1-authorizationscheme-v1 +title: AuthorizationschemeV1 +pagination_label: AuthorizationschemeV1 +sidebar_label: AuthorizationschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuthorizationschemeV1', 'v1AuthorizationschemeV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/authorizationscheme-v1 +tags: ['SDK', 'Software Development Kit', 'AuthorizationschemeV1', 'v1AuthorizationschemeV1'] +--- + +# AuthorizationschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**spec_urn** | **(optional)** **string** | URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamdeliveryrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamdeliveryrequest.md new file mode 100644 index 00000000..e965890b --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamdeliveryrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-createstreamdeliveryrequest-v1 +title: CreatestreamdeliveryrequestV1 +pagination_label: CreatestreamdeliveryrequestV1 +sidebar_label: CreatestreamdeliveryrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreatestreamdeliveryrequestV1', 'v1CreatestreamdeliveryrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/createstreamdeliveryrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreatestreamdeliveryrequestV1', 'v1CreatestreamdeliveryrequestV1'] +--- + +# CreatestreamdeliveryrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**method** | **string** | Delivery method (only push is supported). | [default to undefined] +**endpoint_url** | **string** | Receiver endpoint URL for push delivery. | [default to undefined] +**authorization_header** | **(optional)** **string** | Authorization header value for delivery requests. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamrequest.md new file mode 100644 index 00000000..0e382cc9 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Createstreamrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-createstreamrequest-v1 +title: CreatestreamrequestV1 +pagination_label: CreatestreamrequestV1 +sidebar_label: CreatestreamrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreatestreamrequestV1', 'v1CreatestreamrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/createstreamrequest-v1 +tags: ['SDK', 'Software Development Kit', 'CreatestreamrequestV1', 'v1CreatestreamrequestV1'] +--- + +# CreatestreamrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delivery** | **CreatestreamdeliveryrequestV1** | | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). | [default to undefined] +**description** | **(optional)** **string** | Optional human-readable description of the stream. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryrequest.md new file mode 100644 index 00000000..f7951dce --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-deliveryrequest-v1 +title: DeliveryrequestV1 +pagination_label: DeliveryrequestV1 +sidebar_label: DeliveryrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeliveryrequestV1', 'v1DeliveryrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/deliveryrequest-v1 +tags: ['SDK', 'Software Development Kit', 'DeliveryrequestV1', 'v1DeliveryrequestV1'] +--- + +# DeliveryrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**method** | **(optional)** **string** | Delivery method (optional for PATCH). | [default to undefined] +**endpoint_url** | **(optional)** **string** | Receiver endpoint URL (optional for PATCH). | [default to undefined] +**authorization_header** | **(optional)** **string** | Optional authorization header value. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryresponse.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryresponse.md new file mode 100644 index 00000000..8f44b55f --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Deliveryresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-deliveryresponse-v1 +title: DeliveryresponseV1 +pagination_label: DeliveryresponseV1 +sidebar_label: DeliveryresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeliveryresponseV1', 'v1DeliveryresponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/deliveryresponse-v1 +tags: ['SDK', 'Software Development Kit', 'DeliveryresponseV1', 'v1DeliveryresponseV1'] +--- + +# DeliveryresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**method** | **(optional)** **string** | Delivery method. | [default to undefined] +**endpoint_url** | **(optional)** **string** | Receiver endpoint URL. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Errormessagedto.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..284ee3b9 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Errorresponsedto.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fb7431d2 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1401Response.md b/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1401Response.md new file mode 100644 index 00000000..5b9a539c --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-ssf-configuration-v1401-response-v1 +title: GetSSFConfigurationV1401ResponseV1 +pagination_label: GetSSFConfigurationV1401ResponseV1 +sidebar_label: GetSSFConfigurationV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSSFConfigurationV1401ResponseV1', 'v1GetSSFConfigurationV1401ResponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/get-ssf-configuration-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSSFConfigurationV1401ResponseV1', 'v1GetSSFConfigurationV1401ResponseV1'] +--- + +# GetSSFConfigurationV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1429Response.md b/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1429Response.md new file mode 100644 index 00000000..29654675 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/GetSSFConfigurationV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-ssf-configuration-v1429-response-v1 +title: GetSSFConfigurationV1429ResponseV1 +pagination_label: GetSSFConfigurationV1429ResponseV1 +sidebar_label: GetSSFConfigurationV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSSFConfigurationV1429ResponseV1', 'v1GetSSFConfigurationV1429ResponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/get-ssf-configuration-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSSFConfigurationV1429ResponseV1', 'v1GetSSFConfigurationV1429ResponseV1'] +--- + +# GetSSFConfigurationV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/GetStreamV1200Response.md b/sdk-output/shared_signals_framework_ssf/docs/Models/GetStreamV1200Response.md new file mode 100644 index 00000000..ca6a48bc --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/GetStreamV1200Response.md @@ -0,0 +1,28 @@ +--- +id: v1-get-stream-v1200-response-v1 +title: GetStreamV1200ResponseV1 +pagination_label: GetStreamV1200ResponseV1 +sidebar_label: GetStreamV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetStreamV1200ResponseV1', 'v1GetStreamV1200ResponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/get-stream-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetStreamV1200ResponseV1', 'v1GetStreamV1200ResponseV1'] +--- + +# GetStreamV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **(optional)** **string** | Unique stream identifier. | [default to undefined] +**iss** | **(optional)** **string** | Issuer (transmitter) URL. | [default to undefined] +**aud** | **(optional)** **string** | Audience for the stream. | [default to undefined] +**delivery** | **(optional)** **DeliveryresponseV1** | | [default to undefined] +**events_supported** | **(optional)** **Array<string>** | Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). | [default to undefined] +**events_delivered** | **(optional)** **Array<string>** | Event types currently being delivered (intersection of supported and requested). | [default to undefined] +**description** | **(optional)** **string** | Optional stream description. | [default to undefined] +**inactivity_timeout** | **(optional)** **number** | Inactivity timeout in seconds (optional). | [default to undefined] +**min_verification_interval** | **(optional)** **number** | Minimum verification interval in seconds (optional). | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Index.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Index.md new file mode 100644 index 00000000..8805af6a --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: shared_signals_framework_ssf-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: shared_signals_framework_ssf-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'shared_signals_framework_ssf', 'models'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models +tags: ['SDK', 'Software Development Kit', 'shared_signals_framework_ssf', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Jwk.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Jwk.md new file mode 100644 index 00000000..1d0ec43d --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Jwk.md @@ -0,0 +1,24 @@ +--- +id: v1-jwk-v1 +title: JwkV1 +pagination_label: JwkV1 +sidebar_label: JwkV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JwkV1', 'v1JwkV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/jwk-v1 +tags: ['SDK', 'Software Development Kit', 'JwkV1', 'v1JwkV1'] +--- + +# JwkV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alg** | **(optional)** **string** | Algorithm intended for use with the key (e.g. RS256). | [default to undefined] +**e** | **(optional)** **string** | RSA public exponent (Base64url encoded). | [default to undefined] +**kid** | **(optional)** **string** | Key ID - unique identifier for the key. | [default to undefined] +**kty** | **(optional)** **string** | Key type (e.g. RSA). | [default to undefined] +**n** | **(optional)** **string** | RSA modulus (Base64url encoded). | [default to undefined] +**use** | **(optional)** **string** | Intended use of the key (e.g. sig for signature verification). | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Jwks.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Jwks.md new file mode 100644 index 00000000..4e08ad0a --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Jwks.md @@ -0,0 +1,19 @@ +--- +id: v1-jwks-v1 +title: JwksV1 +pagination_label: JwksV1 +sidebar_label: JwksV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JwksV1', 'v1JwksV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/jwks-v1 +tags: ['SDK', 'Software Development Kit', 'JwksV1', 'v1JwksV1'] +--- + +# JwksV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keys** | **Array<JwkV1>** | Array of JSON Web Keys. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Localeorigin.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Localeorigin.md new file mode 100644 index 00000000..7ee89cd5 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/README.md b/sdk-output/shared_signals_framework_ssf/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Replacestreamconfigurationrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Replacestreamconfigurationrequest.md new file mode 100644 index 00000000..45e2f951 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Replacestreamconfigurationrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-replacestreamconfigurationrequest-v1 +title: ReplacestreamconfigurationrequestV1 +pagination_label: ReplacestreamconfigurationrequestV1 +sidebar_label: ReplacestreamconfigurationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReplacestreamconfigurationrequestV1', 'v1ReplacestreamconfigurationrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/replacestreamconfigurationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ReplacestreamconfigurationrequestV1', 'v1ReplacestreamconfigurationrequestV1'] +--- + +# ReplacestreamconfigurationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **string** | ID of the stream to replace. | [default to undefined] +**delivery** | **ReplacestreamconfigurationrequestDeliveryV1** | | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Event types the receiver wants. Use CAEP event-type URIs. | [default to undefined] +**description** | **(optional)** **string** | Optional human-readable description of the stream. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/ReplacestreamconfigurationrequestDelivery.md b/sdk-output/shared_signals_framework_ssf/docs/Models/ReplacestreamconfigurationrequestDelivery.md new file mode 100644 index 00000000..64e76111 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/ReplacestreamconfigurationrequestDelivery.md @@ -0,0 +1,21 @@ +--- +id: v1-replacestreamconfigurationrequest-delivery-v1 +title: ReplacestreamconfigurationrequestDeliveryV1 +pagination_label: ReplacestreamconfigurationrequestDeliveryV1 +sidebar_label: ReplacestreamconfigurationrequestDeliveryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReplacestreamconfigurationrequestDeliveryV1', 'v1ReplacestreamconfigurationrequestDeliveryV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/replacestreamconfigurationrequest-delivery-v1 +tags: ['SDK', 'Software Development Kit', 'ReplacestreamconfigurationrequestDeliveryV1', 'v1ReplacestreamconfigurationrequestDeliveryV1'] +--- + +# ReplacestreamconfigurationrequestDeliveryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**method** | **string** | Delivery method (only push is supported). | [default to undefined] +**endpoint_url** | **string** | Receiver endpoint URL for push delivery. | [default to undefined] +**authorization_header** | **(optional)** **string** | Authorization header value for delivery requests. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Streamconfigresponse.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Streamconfigresponse.md new file mode 100644 index 00000000..9f8b3e5d --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Streamconfigresponse.md @@ -0,0 +1,28 @@ +--- +id: v1-streamconfigresponse-v1 +title: StreamconfigresponseV1 +pagination_label: StreamconfigresponseV1 +sidebar_label: StreamconfigresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StreamconfigresponseV1', 'v1StreamconfigresponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/streamconfigresponse-v1 +tags: ['SDK', 'Software Development Kit', 'StreamconfigresponseV1', 'v1StreamconfigresponseV1'] +--- + +# StreamconfigresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **(optional)** **string** | Unique stream identifier. | [default to undefined] +**iss** | **(optional)** **string** | Issuer (transmitter) URL. | [default to undefined] +**aud** | **(optional)** **string** | Audience for the stream. | [default to undefined] +**delivery** | **(optional)** **DeliveryresponseV1** | | [default to undefined] +**events_supported** | **(optional)** **Array<string>** | Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). | [default to undefined] +**events_delivered** | **(optional)** **Array<string>** | Event types currently being delivered (intersection of supported and requested). | [default to undefined] +**description** | **(optional)** **string** | Optional stream description. | [default to undefined] +**inactivity_timeout** | **(optional)** **number** | Inactivity timeout in seconds (optional). | [default to undefined] +**min_verification_interval** | **(optional)** **number** | Minimum verification interval in seconds (optional). | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Streamstatusresponse.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Streamstatusresponse.md new file mode 100644 index 00000000..637e3814 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Streamstatusresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-streamstatusresponse-v1 +title: StreamstatusresponseV1 +pagination_label: StreamstatusresponseV1 +sidebar_label: StreamstatusresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StreamstatusresponseV1', 'v1StreamstatusresponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/streamstatusresponse-v1 +tags: ['SDK', 'Software Development Kit', 'StreamstatusresponseV1', 'v1StreamstatusresponseV1'] +--- + +# StreamstatusresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **(optional)** **string** | Stream identifier. | [default to undefined] +**status** | **(optional)** **string** | Operational status of the stream (enabled, paused, or disabled). | [default to undefined] +**reason** | **(optional)** **string** | Optional reason for the current status (e.g. set when status is updated). | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Transmittermetadata.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Transmittermetadata.md new file mode 100644 index 00000000..d41b82a1 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Transmittermetadata.md @@ -0,0 +1,26 @@ +--- +id: v1-transmittermetadata-v1 +title: TransmittermetadataV1 +pagination_label: TransmittermetadataV1 +sidebar_label: TransmittermetadataV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransmittermetadataV1', 'v1TransmittermetadataV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/transmittermetadata-v1 +tags: ['SDK', 'Software Development Kit', 'TransmittermetadataV1', 'v1TransmittermetadataV1'] +--- + +# TransmittermetadataV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**spec_version** | **(optional)** **string** | Version of the SSF specification supported. | [default to undefined] +**issuer** | **(optional)** **string** | Base URL of the transmitter (issuer). | [default to undefined] +**jwks_uri** | **(optional)** **string** | URL of the transmitter\'s JSON Web Key Set. | [default to undefined] +**delivery_methods_supported** | **(optional)** **Array<string>** | Supported delivery methods (e.g. push URN). | [default to undefined] +**configuration_endpoint** | **(optional)** **string** | Endpoint for stream configuration (create, read, update, replace, delete). | [default to undefined] +**status_endpoint** | **(optional)** **string** | Endpoint for reading and updating stream status. | [default to undefined] +**verification_endpoint** | **(optional)** **string** | Endpoint for receiver verification. | [default to undefined] +**authorization_schemes** | **(optional)** **Array<AuthorizationschemeV1>** | Supported authorization schemes (e.g. OAuth2, Bearer). | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigresponse.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigresponse.md new file mode 100644 index 00000000..9e287464 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigresponse.md @@ -0,0 +1,29 @@ +--- +id: v1-updatestreamconfigresponse-v1 +title: UpdatestreamconfigresponseV1 +pagination_label: UpdatestreamconfigresponseV1 +sidebar_label: UpdatestreamconfigresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdatestreamconfigresponseV1', 'v1UpdatestreamconfigresponseV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/updatestreamconfigresponse-v1 +tags: ['SDK', 'Software Development Kit', 'UpdatestreamconfigresponseV1', 'v1UpdatestreamconfigresponseV1'] +--- + +# UpdatestreamconfigresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **(optional)** **string** | Unique stream identifier. | [default to undefined] +**iss** | **(optional)** **string** | Issuer (transmitter) URL. | [default to undefined] +**aud** | **(optional)** **string** | Audience for the stream. | [default to undefined] +**delivery** | **(optional)** **DeliveryresponseV1** | | [default to undefined] +**events_supported** | **(optional)** **Array<string>** | Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked). | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke). | [default to undefined] +**events_delivered** | **(optional)** **Array<string>** | Event types currently being delivered (intersection of supported and requested). | [default to undefined] +**description** | **(optional)** **string** | Optional stream description. | [default to undefined] +**inactivity_timeout** | **(optional)** **number** | Inactivity timeout in seconds (optional). | [default to undefined] +**min_verification_interval** | **(optional)** **number** | Minimum verification interval in seconds (optional). | [default to undefined] +**updatedAt** | **(optional)** **string** | Timestamp of the last configuration update. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigurationrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigurationrequest.md new file mode 100644 index 00000000..20e855f7 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamconfigurationrequest.md @@ -0,0 +1,22 @@ +--- +id: v1-updatestreamconfigurationrequest-v1 +title: UpdatestreamconfigurationrequestV1 +pagination_label: UpdatestreamconfigurationrequestV1 +sidebar_label: UpdatestreamconfigurationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdatestreamconfigurationrequestV1', 'v1UpdatestreamconfigurationrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/updatestreamconfigurationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'UpdatestreamconfigurationrequestV1', 'v1UpdatestreamconfigurationrequestV1'] +--- + +# UpdatestreamconfigurationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **string** | ID of the stream to update. | [default to undefined] +**delivery** | **(optional)** **DeliveryrequestV1** | | [default to undefined] +**events_requested** | **(optional)** **Array<string>** | Event types the receiver wants. Use CAEP event-type URIs. | [default to undefined] +**description** | **(optional)** **string** | Optional human-readable description of the stream. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamstatusrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamstatusrequest.md new file mode 100644 index 00000000..65cd149b --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Updatestreamstatusrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-updatestreamstatusrequest-v1 +title: UpdatestreamstatusrequestV1 +pagination_label: UpdatestreamstatusrequestV1 +sidebar_label: UpdatestreamstatusrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UpdatestreamstatusrequestV1', 'v1UpdatestreamstatusrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/updatestreamstatusrequest-v1 +tags: ['SDK', 'Software Development Kit', 'UpdatestreamstatusrequestV1', 'v1UpdatestreamstatusrequestV1'] +--- + +# UpdatestreamstatusrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **string** | ID of the stream whose status to update. | [default to undefined] +**status** | **string** | Desired stream status. | [default to undefined] +**reason** | **(optional)** **string** | Optional reason for the status change. | [default to undefined] + diff --git a/sdk-output/shared_signals_framework_ssf/docs/Models/Verificationrequest.md b/sdk-output/shared_signals_framework_ssf/docs/Models/Verificationrequest.md new file mode 100644 index 00000000..285709b8 --- /dev/null +++ b/sdk-output/shared_signals_framework_ssf/docs/Models/Verificationrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-verificationrequest-v1 +title: VerificationrequestV1 +pagination_label: VerificationrequestV1 +sidebar_label: VerificationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VerificationrequestV1', 'v1VerificationrequestV1'] +slug: /tools/sdk/typescript/shared_signals_framework_ssf/models/verificationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'VerificationrequestV1', 'v1VerificationrequestV1'] +--- + +# VerificationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**stream_id** | **string** | Stream ID for verification. | [default to undefined] +**state** | **(optional)** **string** | Optional state value for verification challenge. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/sim_integrations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..4bbb77d9 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,114 @@ +- path: /sim-integrations/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#create-sim-integration-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const simintegrationdetailsV1: SimintegrationdetailsV1 = ; // SimintegrationdetailsV1 | DTO containing the details of the SIM integration + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createSIMIntegrationV1(simintegrationdetailsV1); + console.log(result); +- path: /sim-integrations/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#delete-sim-integration-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const id: string = '12345'; // string | The id of the integration to delete. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteSIMIntegrationV1(id); + console.log(result); +- path: /sim-integrations/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#get-sim-integration-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const id: string = '12345'; // string | The id of the integration. (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSIMIntegrationV1(id); + console.log(result); +- path: /sim-integrations/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#get-sim-integrations-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSIMIntegrationsV1(); + console.log(result); +- path: /sim-integrations/v1/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#patch-before-provisioning-rule-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const id: string = '12345'; // string | SIM integration id (default to undefined) + const jsonpatchV1: JsonpatchV1 = ; // JsonpatchV1 | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchBeforeProvisioningRuleV1(id, jsonpatchV1); + console.log(result); +- path: /sim-integrations/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#patch-sim-attributes-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const id: string = '12345'; // string | SIM integration id (default to undefined) + const jsonpatchV1: JsonpatchV1 = ; // JsonpatchV1 | The JsonPatch object that describes the changes of SIM + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.patchSIMAttributesV1(id, jsonpatchV1); + console.log(result); +- path: /sim-integrations/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sim_integrations/methods/sim-integrations#put-sim-integration-v1 + source: | + import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SIMIntegrationsV1Api(configuration); + const id: string = '12345'; // string | The id of the integration. (default to undefined) + const simintegrationdetailsV1: SimintegrationdetailsV1 = ; // SimintegrationdetailsV1 | The full DTO of the integration containing the updated model + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.putSIMIntegrationV1(id, simintegrationdetailsV1); + console.log(result); diff --git a/sdk-output/sim_integrations/docs/Methods/Index.md b/sdk-output/sim_integrations/docs/Methods/Index.md new file mode 100644 index 00000000..1e1469e1 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: sim_integrations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: sim_integrations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'sim_integrations', 'methods'] +slug: /tools/sdk/typescript/sim_integrations/methods +tags: ['SDK', 'Software Development Kit', 'sim_integrations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/sim_integrations/docs/Methods/SIMIntegrationsV1Api.md b/sdk-output/sim_integrations/docs/Methods/SIMIntegrationsV1Api.md new file mode 100644 index 00000000..f5374e5d --- /dev/null +++ b/sdk-output/sim_integrations/docs/Methods/SIMIntegrationsV1Api.md @@ -0,0 +1,338 @@ +--- +id: v1-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SIMIntegrations', 'v1SIMIntegrations'] +slug: /tools/sdk/typescript/sim_integrations/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'v1SIMIntegrations'] +--- + +# SIMIntegrationsV1Api + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint's [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sim-integration-v1**](#create-sim-integration-v1) | **POST** `/sim-integrations/v1` | Create new sim integration +[**delete-sim-integration-v1**](#delete-sim-integration-v1) | **DELETE** `/sim-integrations/v1/{id}` | Delete a sim integration +[**get-sim-integration-v1**](#get-sim-integration-v1) | **GET** `/sim-integrations/v1/{id}` | Get a sim integration details. +[**get-sim-integrations-v1**](#get-sim-integrations-v1) | **GET** `/sim-integrations/v1` | List the existing sim integrations. +[**patch-before-provisioning-rule-v1**](#patch-before-provisioning-rule-v1) | **PATCH** `/sim-integrations/v1/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**patch-sim-attributes-v1**](#patch-sim-attributes-v1) | **PATCH** `/sim-integrations/v1/{id}` | Patch a sim attribute. +[**put-sim-integration-v1**](#put-sim-integration-v1) | **PUT** `/sim-integrations/v1/{id}` | Update an existing sim integration + + +## create-sim-integration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create new sim integration +Create a new SIM Integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-sim-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**simintegrationdetailsV1** | **SimintegrationdetailsV1** | DTO containing the details of the SIM integration | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const simintegrationdetailsV1: SimintegrationdetailsV1 = ; // DTO containing the details of the SIM integration +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createSIMIntegrationV1(simintegrationdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-sim-integration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete a sim integration +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-sim-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the integration to delete. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const id: string = 12345; // The id of the integration to delete. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteSIMIntegrationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sim-integration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get a sim integration details. +Get the details of a SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sim-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the integration. | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const id: string = 12345; // The id of the integration. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSIMIntegrationV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sim-integrations-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List the existing sim integrations. +List the existing SIM integrations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sim-integrations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSIMIntegrationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-before-provisioning-rule-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch a sim beforeprovisioningrule attribute. +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-before-provisioning-rule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | SIM integration id | [default to undefined] +**jsonpatchV1** | **JsonpatchV1** | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const id: string = 12345; // SIM integration id +const jsonpatchV1: JsonpatchV1 = ; // The JsonPatch object that describes the changes of SIM beforeProvisioningRule. +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchBeforeProvisioningRuleV1(id, jsonpatchV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-sim-attributes-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Patch a sim attribute. +Patch a SIM attribute given a JsonPatch object. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-sim-attributes-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | SIM integration id | [default to undefined] +**jsonpatchV1** | **JsonpatchV1** | The JsonPatch object that describes the changes of SIM | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const id: string = 12345; // SIM integration id +const jsonpatchV1: JsonpatchV1 = ; // The JsonPatch object that describes the changes of SIM +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.patchSIMAttributesV1(id, jsonpatchV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-sim-integration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update an existing sim integration +Update an existing SIM integration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-sim-integration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The id of the integration. | [default to undefined] +**simintegrationdetailsV1** | **SimintegrationdetailsV1** | The full DTO of the integration containing the updated model | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ServicedeskintegrationdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SIMIntegrationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SIMIntegrationsV1Api(configuration); +const id: string = 12345; // The id of the integration. +const simintegrationdetailsV1: SimintegrationdetailsV1 = ; // The full DTO of the integration containing the updated model +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.putSIMIntegrationV1(id, simintegrationdetailsV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/sim_integrations/docs/Models/ArrayInner.md b/sdk-output/sim_integrations/docs/Models/ArrayInner.md new file mode 100644 index 00000000..7554fd75 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/sim_integrations/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sim_integrations/docs/Models/Basecommondto.md b/sdk-output/sim_integrations/docs/Models/Basecommondto.md new file mode 100644 index 00000000..ba8706ca --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Basecommondto.md @@ -0,0 +1,22 @@ +--- +id: v1-basecommondto-v1 +title: BasecommondtoV1 +pagination_label: BasecommondtoV1 +sidebar_label: BasecommondtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasecommondtoV1', 'v1BasecommondtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/basecommondto-v1 +tags: ['SDK', 'Software Development Kit', 'BasecommondtoV1', 'v1BasecommondtoV1'] +--- + +# BasecommondtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Beforeprovisioningruledto.md b/sdk-output/sim_integrations/docs/Models/Beforeprovisioningruledto.md new file mode 100644 index 00000000..c2db3eca --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Beforeprovisioningruledto.md @@ -0,0 +1,21 @@ +--- +id: v1-beforeprovisioningruledto-v1 +title: BeforeprovisioningruledtoV1 +pagination_label: BeforeprovisioningruledtoV1 +sidebar_label: BeforeprovisioningruledtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BeforeprovisioningruledtoV1', 'v1BeforeprovisioningruledtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/beforeprovisioningruledto-v1 +tags: ['SDK', 'Software Development Kit', 'BeforeprovisioningruledtoV1', 'v1BeforeprovisioningruledtoV1'] +--- + +# BeforeprovisioningruledtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Before Provisioning Rule DTO type. | [default to undefined] +**id** | **(optional)** **string** | Before Provisioning Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule display name. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Dtotype.md b/sdk-output/sim_integrations/docs/Models/Dtotype.md new file mode 100644 index 00000000..d5e0dd91 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/sim_integrations/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/sim_integrations/docs/Models/Errormessagedto.md b/sdk-output/sim_integrations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..d0e2edbe --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Errorresponsedto.md b/sdk-output/sim_integrations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..d70a876e --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1401Response.md b/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1401Response.md new file mode 100644 index 00000000..3b716dd3 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-sim-integration-v1401-response-v1 +title: GetSIMIntegrationV1401ResponseV1 +pagination_label: GetSIMIntegrationV1401ResponseV1 +sidebar_label: GetSIMIntegrationV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSIMIntegrationV1401ResponseV1', 'v1GetSIMIntegrationV1401ResponseV1'] +slug: /tools/sdk/typescript/sim_integrations/models/get-sim-integration-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSIMIntegrationV1401ResponseV1', 'v1GetSIMIntegrationV1401ResponseV1'] +--- + +# GetSIMIntegrationV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1429Response.md b/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1429Response.md new file mode 100644 index 00000000..681fd65d --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/GetSIMIntegrationV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-sim-integration-v1429-response-v1 +title: GetSIMIntegrationV1429ResponseV1 +pagination_label: GetSIMIntegrationV1429ResponseV1 +sidebar_label: GetSIMIntegrationV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetSIMIntegrationV1429ResponseV1', 'v1GetSIMIntegrationV1429ResponseV1'] +slug: /tools/sdk/typescript/sim_integrations/models/get-sim-integration-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetSIMIntegrationV1429ResponseV1', 'v1GetSIMIntegrationV1429ResponseV1'] +--- + +# GetSIMIntegrationV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Index.md b/sdk-output/sim_integrations/docs/Models/Index.md new file mode 100644 index 00000000..6e2caa12 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: sim_integrations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: sim_integrations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'sim_integrations', 'models'] +slug: /tools/sdk/typescript/sim_integrations/models +tags: ['SDK', 'Software Development Kit', 'sim_integrations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/sim_integrations/docs/Models/Jsonpatch.md b/sdk-output/sim_integrations/docs/Models/Jsonpatch.md new file mode 100644 index 00000000..0e444926 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Jsonpatch.md @@ -0,0 +1,19 @@ +--- +id: v1-jsonpatch-v1 +title: JsonpatchV1 +pagination_label: JsonpatchV1 +sidebar_label: JsonpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchV1', 'v1JsonpatchV1'] +slug: /tools/sdk/typescript/sim_integrations/models/jsonpatch-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchV1', 'v1JsonpatchV1'] +--- + +# JsonpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | **(optional)** **Array<JsonpatchoperationV1>** | Operations to be applied | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Jsonpatchoperation.md b/sdk-output/sim_integrations/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..ad7c3175 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/sim_integrations/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/JsonpatchoperationValue.md b/sdk-output/sim_integrations/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..99393aec --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/sim_integrations/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sim_integrations/docs/Models/Localeorigin.md b/sdk-output/sim_integrations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d145be56 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/sim_integrations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/sim_integrations/docs/Models/Ownerdto.md b/sdk-output/sim_integrations/docs/Models/Ownerdto.md new file mode 100644 index 00000000..f988963a --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Ownerdto.md @@ -0,0 +1,21 @@ +--- +id: v1-ownerdto-v1 +title: OwnerdtoV1 +pagination_label: OwnerdtoV1 +sidebar_label: OwnerdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'OwnerdtoV1', 'v1OwnerdtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/ownerdto-v1 +tags: ['SDK', 'Software Development Kit', 'OwnerdtoV1', 'v1OwnerdtoV1'] +--- + +# OwnerdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Provisioningconfig.md b/sdk-output/sim_integrations/docs/Models/Provisioningconfig.md new file mode 100644 index 00000000..3c27fd52 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Provisioningconfig.md @@ -0,0 +1,23 @@ +--- +id: v1-provisioningconfig-v1 +title: ProvisioningconfigV1 +pagination_label: ProvisioningconfigV1 +sidebar_label: ProvisioningconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningconfigV1', 'v1ProvisioningconfigV1'] +slug: /tools/sdk/typescript/sim_integrations/models/provisioningconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningconfigV1', 'v1ProvisioningconfigV1'] +--- + +# ProvisioningconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**universalManager** | **(optional)** **boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [readonly] [default to false] +**managedResourceRefs** | **(optional)** **Array<ServicedesksourceV1>** | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [default to undefined] +**planInitializerScript** | **(optional)** **ProvisioningconfigPlanInitializerScriptV1** | | [default to undefined] +**noProvisioningRequests** | **(optional)** **boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [default to false] +**provisioningRequestExpiration** | **(optional)** **number** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/ProvisioningconfigPlanInitializerScript.md b/sdk-output/sim_integrations/docs/Models/ProvisioningconfigPlanInitializerScript.md new file mode 100644 index 00000000..562302bd --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/ProvisioningconfigPlanInitializerScript.md @@ -0,0 +1,19 @@ +--- +id: v1-provisioningconfig-plan-initializer-script-v1 +title: ProvisioningconfigPlanInitializerScriptV1 +pagination_label: ProvisioningconfigPlanInitializerScriptV1 +sidebar_label: ProvisioningconfigPlanInitializerScriptV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningconfigPlanInitializerScriptV1', 'v1ProvisioningconfigPlanInitializerScriptV1'] +slug: /tools/sdk/typescript/sim_integrations/models/provisioningconfig-plan-initializer-script-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningconfigPlanInitializerScriptV1', 'v1ProvisioningconfigPlanInitializerScriptV1'] +--- + +# ProvisioningconfigPlanInitializerScriptV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **(optional)** **string** | This is a Rule that allows provisioning instruction changes. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/README.md b/sdk-output/sim_integrations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sim_integrations/docs/Models/Servicedeskintegrationdto.md b/sdk-output/sim_integrations/docs/Models/Servicedeskintegrationdto.md new file mode 100644 index 00000000..28f1736d --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Servicedeskintegrationdto.md @@ -0,0 +1,31 @@ +--- +id: v1-servicedeskintegrationdto-v1 +title: ServicedeskintegrationdtoV1 +pagination_label: ServicedeskintegrationdtoV1 +sidebar_label: ServicedeskintegrationdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedeskintegrationdtoV1', 'v1ServicedeskintegrationdtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/servicedeskintegrationdto-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedeskintegrationdtoV1', 'v1ServicedeskintegrationdtoV1'] +--- + +# ServicedeskintegrationdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Unique identifier for the Service Desk integration | [default to undefined] +**name** | **string** | Service Desk integration\'s name. The name must be unique. | [default to undefined] +**created** | **(optional)** **string** | The date and time the Service Desk integration was created | [default to undefined] +**modified** | **(optional)** **string** | The date and time the Service Desk integration was last modified | [default to undefined] +**description** | **string** | Service Desk integration\'s description. | [default to undefined] +**type** | **string** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [default to 'ServiceNowSDIM'] +**ownerRef** | **(optional)** **OwnerdtoV1** | | [default to undefined] +**clusterRef** | **(optional)** **SourceclusterdtoV1** | | [default to undefined] +**cluster** | **(optional)** **string** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [default to undefined] +**managedSources** | **(optional)** **Array<string>** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [default to undefined] +**provisioningConfig** | **(optional)** **ProvisioningconfigV1** | | [default to undefined] +**attributes** | | Service Desk integration\'s attributes. Validation constraints enforced by the implementation. | [default to undefined] +**beforeProvisioningRule** | **(optional)** **BeforeprovisioningruledtoV1** | | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Servicedesksource.md b/sdk-output/sim_integrations/docs/Models/Servicedesksource.md new file mode 100644 index 00000000..e595d22f --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Servicedesksource.md @@ -0,0 +1,21 @@ +--- +id: v1-servicedesksource-v1 +title: ServicedesksourceV1 +pagination_label: ServicedesksourceV1 +sidebar_label: ServicedesksourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ServicedesksourceV1', 'v1ServicedesksourceV1'] +slug: /tools/sdk/typescript/sim_integrations/models/servicedesksource-v1 +tags: ['SDK', 'Software Development Kit', 'ServicedesksourceV1', 'v1ServicedesksourceV1'] +--- + +# ServicedesksourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of source for service desk integration template. | [default to undefined] +**id** | **(optional)** **string** | ID of source for service desk integration template. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of source for service desk integration template. | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Simintegrationdetails.md b/sdk-output/sim_integrations/docs/Models/Simintegrationdetails.md new file mode 100644 index 00000000..810e5347 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Simintegrationdetails.md @@ -0,0 +1,30 @@ +--- +id: v1-simintegrationdetails-v1 +title: SimintegrationdetailsV1 +pagination_label: SimintegrationdetailsV1 +sidebar_label: SimintegrationdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SimintegrationdetailsV1', 'v1SimintegrationdetailsV1'] +slug: /tools/sdk/typescript/sim_integrations/models/simintegrationdetails-v1 +tags: ['SDK', 'Software Development Kit', 'SimintegrationdetailsV1', 'v1SimintegrationdetailsV1'] +--- + +# SimintegrationdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the Object | [readonly] [default to undefined] +**name** | **string** | Name of the Object | [default to undefined] +**created** | **(optional)** **string** | Creation date of the Object | [readonly] [default to undefined] +**modified** | **(optional)** **string** | Last modification date of the Object | [readonly] [default to undefined] +**description** | **(optional)** **string** | The description of the integration | [default to undefined] +**type** | **(optional)** **string** | The integration type | [default to undefined] +**attributes** | **(optional)** **object** | The attributes map containing the credentials used to configure the integration. | [default to undefined] +**sources** | **(optional)** **Array<string>** | The list of sources (managed resources) | [default to undefined] +**cluster** | **(optional)** **string** | The cluster/proxy | [default to undefined] +**statusMap** | **(optional)** **object** | Custom mapping between the integration result and the provisioning result | [default to undefined] +**request** | **(optional)** **object** | Request data to customize desc and body of the created ticket | [default to undefined] +**beforeProvisioningRule** | **(optional)** **SimintegrationdetailsAllOfBeforeProvisioningRuleV1** | | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/SimintegrationdetailsAllOfBeforeProvisioningRule.md b/sdk-output/sim_integrations/docs/Models/SimintegrationdetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 00000000..7ec2a2e8 --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/SimintegrationdetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,21 @@ +--- +id: v1-simintegrationdetails-all-of-before-provisioning-rule-v1 +title: SimintegrationdetailsAllOfBeforeProvisioningRuleV1 +pagination_label: SimintegrationdetailsAllOfBeforeProvisioningRuleV1 +sidebar_label: SimintegrationdetailsAllOfBeforeProvisioningRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SimintegrationdetailsAllOfBeforeProvisioningRuleV1', 'v1SimintegrationdetailsAllOfBeforeProvisioningRuleV1'] +slug: /tools/sdk/typescript/sim_integrations/models/simintegrationdetails-all-of-before-provisioning-rule-v1 +tags: ['SDK', 'Software Development Kit', 'SimintegrationdetailsAllOfBeforeProvisioningRuleV1', 'v1SimintegrationdetailsAllOfBeforeProvisioningRuleV1'] +--- + +# SimintegrationdetailsAllOfBeforeProvisioningRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the rule | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the rule | [default to undefined] + diff --git a/sdk-output/sim_integrations/docs/Models/Sourceclusterdto.md b/sdk-output/sim_integrations/docs/Models/Sourceclusterdto.md new file mode 100644 index 00000000..e59b10fd --- /dev/null +++ b/sdk-output/sim_integrations/docs/Models/Sourceclusterdto.md @@ -0,0 +1,21 @@ +--- +id: v1-sourceclusterdto-v1 +title: SourceclusterdtoV1 +pagination_label: SourceclusterdtoV1 +sidebar_label: SourceclusterdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceclusterdtoV1', 'v1SourceclusterdtoV1'] +slug: /tools/sdk/typescript/sim_integrations/models/sourceclusterdto-v1 +tags: ['SDK', 'Software Development Kit', 'SourceclusterdtoV1', 'v1SourceclusterdtoV1'] +--- + +# SourceclusterdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Source cluster DTO type. | [default to undefined] +**id** | **(optional)** **string** | Source cluster ID. | [default to undefined] +**name** | **(optional)** **string** | Source cluster display name. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/sod_policies/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5e0e5c3f --- /dev/null +++ b/sdk-output/sod_policies/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,263 @@ +- path: /sod-policies/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#create-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const sodpolicyV1: SodpolicyV1 = {"name":"Conflicting-Policy-Name","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","compensatingControls":"Have a manager review the transaction decisions for their \"out of compliance\" employee","correctionAdvice":"Based on the role of the employee, managers should remove access that is not required for their job function.","state":"ENFORCED","tags":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}; // SodpolicyV1 | + const result = await apiInstance.createSodPolicyV1(sodpolicyV1); + console.log(result); +- path: /sod-policies/v1/{id}/schedule + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#delete-sod-policy-schedule-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD policy the schedule must be deleted for. (default to undefined) + const result = await apiInstance.deleteSodPolicyScheduleV1(id); + console.log(result); +- path: /sod-policies/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#delete-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD Policy to delete. (default to undefined) + const logical: boolean = true; // boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to true) + const result = await apiInstance.deleteSodPolicyV1(id); + console.log(result); +- path: /sod-violation-report/v1/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-custom-violation-report-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const reportResultId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the report reference to download. (default to undefined) + const fileName: string = 'custom-name'; // string | Custom Name for the file. (default to undefined) + const result = await apiInstance.getCustomViolationReportV1(reportResultId, fileName); + console.log(result); +- path: /sod-violation-report/v1/{reportResultId}/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-default-violation-report-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const reportResultId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the report reference to download. (default to undefined) + const result = await apiInstance.getDefaultViolationReportV1(reportResultId); + console.log(result); +- path: /sod-violation-report/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-sod-all-report-run-status-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const result = await apiInstance.getSodAllReportRunStatusV1(); + console.log(result); +- path: /sod-policies/v1/{id}/schedule + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-sod-policy-schedule-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD policy schedule to retrieve. (default to undefined) + const result = await apiInstance.getSodPolicyScheduleV1(id); + console.log(result); +- path: /sod-policies/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD Policy to retrieve. (default to undefined) + const result = await apiInstance.getSodPolicyV1(id); + console.log(result); +- path: /sod-policies/v1/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-sod-violation-report-run-status-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const reportResultId: string = '2e8d8180-24bc-4d21-91c6-7affdb473b0d'; // string | The ID of the report reference to retrieve. (default to undefined) + const result = await apiInstance.getSodViolationReportRunStatusV1(reportResultId); + console.log(result); +- path: /sod-policies/v1/{id}/violation-report + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#get-sod-violation-report-status-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the violation report to retrieve status for. (default to undefined) + const result = await apiInstance.getSodViolationReportStatusV1(id); + console.log(result); +- path: /sod-policies/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#list-sod-policies-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "bc693f07e7b645539626c25954c58554"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) (default to undefined) + const sorters: string = 'id,name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) (default to undefined) + const result = await apiInstance.listSodPoliciesV1(); + console.log(result); +- path: /sod-policies/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#patch-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = '2c918083-5d19-1a86-015d-28455b4a2329'; // string | The ID of the SOD policy being modified. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Modified description"},{"op":"replace","path":"/conflictingAccessCriteria/leftCriteria/name","value":"money-in-modified"},{"op":"replace","path":"/conflictingAccessCriteria/rightCriteria","value":{"name":"money-out-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}}]; // Array | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + const result = await apiInstance.patchSodPolicyV1(id, jsonpatchoperationV1); + console.log(result); +- path: /sod-policies/v1/{id}/schedule + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#put-policy-schedule-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD policy to update its schedule. (default to undefined) + const sodpolicyscheduleV1: SodpolicyscheduleV1 = ; // SodpolicyscheduleV1 | + const result = await apiInstance.putPolicyScheduleV1(id, sodpolicyscheduleV1); + console.log(result); +- path: /sod-policies/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#put-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The ID of the SOD policy to update. (default to undefined) + const sodpolicyV1: SodpolicyV1 = {"name":"Conflicting-Policy-Name","description":"Modified Description","externalPolicyReference":"XYZ policy","compensatingControls":"Have a manager review the transaction decisions for their \"out of compliance\" employee","correctionAdvice":"Based on the role of the employee, managers should remove access that is not required for their job function.","state":"ENFORCED","tags":["string"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}; // SodpolicyV1 | + const result = await apiInstance.putSodPolicyV1(id, sodpolicyV1); + console.log(result); +- path: /sod-policies/v1/{id}/evaluate + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#start-evaluate-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The SOD policy ID to run. (default to undefined) + const result = await apiInstance.startEvaluateSodPolicyV1(id); + console.log(result); +- path: /sod-violation-report/v1/run + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#start-sod-all-policies-for-org-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const multipolicyrequestV1: MultipolicyrequestV1 = {"filteredPolicyList":["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]}; // MultipolicyrequestV1 | (optional) + const result = await apiInstance.startSodAllPoliciesForOrgV1(); + console.log(result); +- path: /sod-policies/v1/{id}/violation-report/run + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_policies/methods/sod-policies#start-sod-policy-v1 + source: | + import { SODPoliciesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODPoliciesV1Api(configuration); + const id: string = 'ef38f943-47e9-4562-b5bb-8424a56397d8'; // string | The SOD policy ID to run. (default to undefined) + const result = await apiInstance.startSodPolicyV1(id); + console.log(result); diff --git a/sdk-output/sod_policies/docs/Methods/Index.md b/sdk-output/sod_policies/docs/Methods/Index.md new file mode 100644 index 00000000..0ee8c942 --- /dev/null +++ b/sdk-output/sod_policies/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: sod_policies-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: sod_policies-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'sod_policies', 'methods'] +slug: /tools/sdk/typescript/sod_policies/methods +tags: ['SDK', 'Software Development Kit', 'sod_policies', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/sod_policies/docs/Methods/SODPoliciesV1Api.md b/sdk-output/sod_policies/docs/Methods/SODPoliciesV1Api.md new file mode 100644 index 00000000..f3100dfe --- /dev/null +++ b/sdk-output/sod_policies/docs/Methods/SODPoliciesV1Api.md @@ -0,0 +1,729 @@ +--- +id: v1-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SODPolicies', 'v1SODPolicies'] +slug: /tools/sdk/typescript/sod_policies/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'v1SODPolicies'] +--- + +# SODPoliciesV1Api + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-sod-policy-v1**](#create-sod-policy-v1) | **POST** `/sod-policies/v1` | Create sod policy +[**delete-sod-policy-schedule-v1**](#delete-sod-policy-schedule-v1) | **DELETE** `/sod-policies/v1/{id}/schedule` | Delete sod policy schedule +[**delete-sod-policy-v1**](#delete-sod-policy-v1) | **DELETE** `/sod-policies/v1/{id}` | Delete sod policy by id +[**get-custom-violation-report-v1**](#get-custom-violation-report-v1) | **GET** `/sod-violation-report/v1/{reportResultId}/download/{fileName}` | Download custom violation report +[**get-default-violation-report-v1**](#get-default-violation-report-v1) | **GET** `/sod-violation-report/v1/{reportResultId}/download` | Download violation report +[**get-sod-all-report-run-status-v1**](#get-sod-all-report-run-status-v1) | **GET** `/sod-violation-report/v1` | Get multi-report run task status +[**get-sod-policy-schedule-v1**](#get-sod-policy-schedule-v1) | **GET** `/sod-policies/v1/{id}/schedule` | Get sod policy schedule +[**get-sod-policy-v1**](#get-sod-policy-v1) | **GET** `/sod-policies/v1/{id}` | Get sod policy by id +[**get-sod-violation-report-run-status-v1**](#get-sod-violation-report-run-status-v1) | **GET** `/sod-policies/v1/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**get-sod-violation-report-status-v1**](#get-sod-violation-report-status-v1) | **GET** `/sod-policies/v1/{id}/violation-report` | Get sod violation report status +[**list-sod-policies-v1**](#list-sod-policies-v1) | **GET** `/sod-policies/v1` | List sod policies +[**patch-sod-policy-v1**](#patch-sod-policy-v1) | **PATCH** `/sod-policies/v1/{id}` | Patch sod policy by id +[**put-policy-schedule-v1**](#put-policy-schedule-v1) | **PUT** `/sod-policies/v1/{id}/schedule` | Update sod policy schedule +[**put-sod-policy-v1**](#put-sod-policy-v1) | **PUT** `/sod-policies/v1/{id}` | Update sod policy by id +[**start-evaluate-sod-policy-v1**](#start-evaluate-sod-policy-v1) | **POST** `/sod-policies/v1/{id}/evaluate` | Evaluate one policy by id +[**start-sod-all-policies-for-org-v1**](#start-sod-all-policies-for-org-v1) | **POST** `/sod-violation-report/v1/run` | Runs all policies for org +[**start-sod-policy-v1**](#start-sod-policy-v1) | **POST** `/sod-policies/v1/{id}/violation-report/run` | Runs sod policy violation report + + +## create-sod-policy-v1 +Create sod policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sodpolicyV1** | **SodpolicyV1** | | + +### Return type + +**SodpolicyV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const sodpolicyV1: SodpolicyV1 = {"name":"Conflicting-Policy-Name","description":"This policy ensures compliance of xyz","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Owner Name"},"externalPolicyReference":"XYZ policy","compensatingControls":"Have a manager review the transaction decisions for their \"out of compliance\" employee","correctionAdvice":"Based on the role of the employee, managers should remove access that is not required for their job function.","state":"ENFORCED","tags":["string"],"creatorId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","modifierId":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}; // +const result = await apiInstance.createSodPolicyV1(sodpolicyV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-sod-policy-schedule-v1 +Delete sod policy schedule +This deletes schedule for a specified SOD policy by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-sod-policy-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD policy the schedule must be deleted for. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD policy the schedule must be deleted for. +const result = await apiInstance.deleteSodPolicyScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-sod-policy-v1 +Delete sod policy by id +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD Policy to delete. | [default to undefined] +**logical** | **boolean** | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. | [optional] [default to true] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD Policy to delete. +const logical: boolean = true; // Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) +const result = await apiInstance.deleteSodPolicyV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-custom-violation-report-v1 +Download custom violation report +This allows to download a specified named violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-custom-violation-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reportResultId** | **string** | The ID of the report reference to download. | [default to undefined] +**fileName** | **string** | Custom Name for the file. | [default to undefined] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const reportResultId: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the report reference to download. +const fileName: string = custom-name; // Custom Name for the file. +const result = await apiInstance.getCustomViolationReportV1(reportResultId, fileName); +console.log(result); +``` + +[[Back to top]](#) + +## get-default-violation-report-v1 +Download violation report +This allows to download a violation report for a given report reference. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-default-violation-report-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reportResultId** | **string** | The ID of the report reference to download. | [default to undefined] + +### Return type + +**File** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const reportResultId: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the report reference to download. +const result = await apiInstance.getDefaultViolationReportV1(reportResultId); +console.log(result); +``` + +[[Back to top]](#) + +## get-sod-all-report-run-status-v1 +Get multi-report run task status +This endpoint gets the status for a violation report for all policy run. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sod-all-report-run-status-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const result = await apiInstance.getSodAllReportRunStatusV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-sod-policy-schedule-v1 +Get sod policy schedule +This endpoint gets a specified SOD policy's schedule. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sod-policy-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD policy schedule to retrieve. | [default to undefined] + +### Return type + +**SodpolicyscheduleV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD policy schedule to retrieve. +const result = await apiInstance.getSodPolicyScheduleV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sod-policy-v1 +Get sod policy by id +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD Policy to retrieve. | [default to undefined] + +### Return type + +**SodpolicyV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD Policy to retrieve. +const result = await apiInstance.getSodPolicyV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sod-violation-report-run-status-v1 +Get violation report run status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sod-violation-report-run-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**reportResultId** | **string** | The ID of the report reference to retrieve. | [default to undefined] + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const reportResultId: string = 2e8d8180-24bc-4d21-91c6-7affdb473b0d; // The ID of the report reference to retrieve. +const result = await apiInstance.getSodViolationReportRunStatusV1(reportResultId); +console.log(result); +``` + +[[Back to top]](#) + +## get-sod-violation-report-status-v1 +Get sod violation report status +This gets the status for a violation report run task that has already been invoked. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sod-violation-report-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the violation report to retrieve status for. | [default to undefined] + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the violation report to retrieve status for. +const result = await apiInstance.getSodViolationReportStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-sod-policies-v1 +List sod policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-sod-policies-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "bc693f07e7b645539626c25954c58554"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) +const sorters: string = id,name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) +const result = await apiInstance.listSodPoliciesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-sod-policy-v1 +Patch sod policy by id +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD policy being modified. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria | + +### Return type + +**SodpolicyV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = 2c918083-5d19-1a86-015d-28455b4a2329; // The ID of the SOD policy being modified. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"Modified description"},{"op":"replace","path":"/conflictingAccessCriteria/leftCriteria/name","value":"money-in-modified"},{"op":"replace","path":"/conflictingAccessCriteria/rightCriteria","value":{"name":"money-out-modified","criteriaList":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}}]; // A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria +const result = await apiInstance.patchSodPolicyV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-policy-schedule-v1 +Update sod policy schedule +This updates schedule for a specified SOD policy. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-policy-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD policy to update its schedule. | [default to undefined] +**sodpolicyscheduleV1** | **SodpolicyscheduleV1** | | + +### Return type + +**SodpolicyscheduleV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD policy to update its schedule. +const sodpolicyscheduleV1: SodpolicyscheduleV1 = ; // +const result = await apiInstance.putPolicyScheduleV1(id, sodpolicyscheduleV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-sod-policy-v1 +Update sod policy by id +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the SOD policy to update. | [default to undefined] +**sodpolicyV1** | **SodpolicyV1** | | + +### Return type + +**SodpolicyV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The ID of the SOD policy to update. +const sodpolicyV1: SodpolicyV1 = {"name":"Conflicting-Policy-Name","description":"Modified Description","externalPolicyReference":"XYZ policy","compensatingControls":"Have a manager review the transaction decisions for their \"out of compliance\" employee","correctionAdvice":"Based on the role of the employee, managers should remove access that is not required for their job function.","state":"ENFORCED","tags":["string"],"violationOwnerAssignmentConfig":{"assignmentRule":"MANAGER","ownerRef":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"Violation Owner Name"}},"scheduled":true,"type":"CONFLICTING_ACCESS_BASED","conflictingAccessCriteria":{"leftCriteria":{"name":"money-in","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a66"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a67"}]},"rightCriteria":{"name":"money-out","criteriaList":[{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a68"},{"type":"ENTITLEMENT","id":"2c9180866166b5b0016167c32ef31a69"}]}}}; // +const result = await apiInstance.putSodPolicyV1(id, sodpolicyV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-evaluate-sod-policy-v1 +Evaluate one policy by id +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-evaluate-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The SOD policy ID to run. | [default to undefined] + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The SOD policy ID to run. +const result = await apiInstance.startEvaluateSodPolicyV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## start-sod-all-policies-for-org-v1 +Runs all policies for org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-sod-all-policies-for-org-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**multipolicyrequestV1** | **MultipolicyrequestV1** | | [optional] + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const multipolicyrequestV1: MultipolicyrequestV1 = {"filteredPolicyList":["b868cd40-ffa4-4337-9c07-1a51846cfa94","63a07a7b-39a4-48aa-956d-50c827deba2a"]}; // (optional) +const result = await apiInstance.startSodAllPoliciesForOrgV1(); +console.log(result); +``` + +[[Back to top]](#) + +## start-sod-policy-v1 +Runs sod policy violation report +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-sod-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The SOD policy ID to run. | [default to undefined] + +### Return type + +**ReportresultreferenceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SODPoliciesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODPoliciesV1Api(configuration); +const id: string = ef38f943-47e9-4562-b5bb-8424a56397d8; // The SOD policy ID to run. +const result = await apiInstance.startSodPolicyV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/sod_policies/docs/Models/Accesscriteria.md b/sdk-output/sod_policies/docs/Models/Accesscriteria.md new file mode 100644 index 00000000..7378eb9e --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Accesscriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-accesscriteria-v1 +title: AccesscriteriaV1 +pagination_label: AccesscriteriaV1 +sidebar_label: AccesscriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesscriteriaV1', 'v1AccesscriteriaV1'] +slug: /tools/sdk/typescript/sod_policies/models/accesscriteria-v1 +tags: ['SDK', 'Software Development Kit', 'AccesscriteriaV1', 'v1AccesscriteriaV1'] +--- + +# AccesscriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Business name for the access construct list | [default to undefined] +**criteriaList** | **(optional)** **Array<AccesscriteriaCriteriaListInnerV1>** | List of criteria. There is a min of 1 and max of 50 items in the list. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/AccesscriteriaCriteriaListInner.md b/sdk-output/sod_policies/docs/Models/AccesscriteriaCriteriaListInner.md new file mode 100644 index 00000000..7775528f --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/AccesscriteriaCriteriaListInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accesscriteria-criteria-list-inner-v1 +title: AccesscriteriaCriteriaListInnerV1 +pagination_label: AccesscriteriaCriteriaListInnerV1 +sidebar_label: AccesscriteriaCriteriaListInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccesscriteriaCriteriaListInnerV1', 'v1AccesscriteriaCriteriaListInnerV1'] +slug: /tools/sdk/typescript/sod_policies/models/accesscriteria-criteria-list-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccesscriteriaCriteriaListInnerV1', 'v1AccesscriteriaCriteriaListInnerV1'] +--- + +# AccesscriteriaCriteriaListInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the propery to which this reference applies to | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies to | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies to | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ArrayInner.md b/sdk-output/sod_policies/docs/Models/ArrayInner.md new file mode 100644 index 00000000..1f027d9b --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/sod_policies/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sod_policies/docs/Models/Conflictingaccesscriteria.md b/sdk-output/sod_policies/docs/Models/Conflictingaccesscriteria.md new file mode 100644 index 00000000..bc46a06f --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Conflictingaccesscriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-conflictingaccesscriteria-v1 +title: ConflictingaccesscriteriaV1 +pagination_label: ConflictingaccesscriteriaV1 +sidebar_label: ConflictingaccesscriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConflictingaccesscriteriaV1', 'v1ConflictingaccesscriteriaV1'] +slug: /tools/sdk/typescript/sod_policies/models/conflictingaccesscriteria-v1 +tags: ['SDK', 'Software Development Kit', 'ConflictingaccesscriteriaV1', 'v1ConflictingaccesscriteriaV1'] +--- + +# ConflictingaccesscriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leftCriteria** | **(optional)** **AccesscriteriaV1** | | [default to undefined] +**rightCriteria** | **(optional)** **AccesscriteriaV1** | | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Errormessagedto.md b/sdk-output/sod_policies/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..0eee0912 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/sod_policies/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Errorresponsedto.md b/sdk-output/sod_policies/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..38be63fe --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/sod_policies/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Index.md b/sdk-output/sod_policies/docs/Models/Index.md new file mode 100644 index 00000000..2a36c246 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: sod_policies-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: sod_policies-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'sod_policies', 'models'] +slug: /tools/sdk/typescript/sod_policies/models +tags: ['SDK', 'Software Development Kit', 'sod_policies', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/sod_policies/docs/Models/Jsonpatchoperation.md b/sdk-output/sod_policies/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..182d5c88 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/sod_policies/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/JsonpatchoperationValue.md b/sdk-output/sod_policies/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..a34033b8 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/sod_policies/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1401Response.md b/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1401Response.md new file mode 100644 index 00000000..bf1b2f2f --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-sod-policies-v1401-response-v1 +title: ListSodPoliciesV1401ResponseV1 +pagination_label: ListSodPoliciesV1401ResponseV1 +sidebar_label: ListSodPoliciesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSodPoliciesV1401ResponseV1', 'v1ListSodPoliciesV1401ResponseV1'] +slug: /tools/sdk/typescript/sod_policies/models/list-sod-policies-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSodPoliciesV1401ResponseV1', 'v1ListSodPoliciesV1401ResponseV1'] +--- + +# ListSodPoliciesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1429Response.md b/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1429Response.md new file mode 100644 index 00000000..7412815f --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ListSodPoliciesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-sod-policies-v1429-response-v1 +title: ListSodPoliciesV1429ResponseV1 +pagination_label: ListSodPoliciesV1429ResponseV1 +sidebar_label: ListSodPoliciesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSodPoliciesV1429ResponseV1', 'v1ListSodPoliciesV1429ResponseV1'] +slug: /tools/sdk/typescript/sod_policies/models/list-sod-policies-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSodPoliciesV1429ResponseV1', 'v1ListSodPoliciesV1429ResponseV1'] +--- + +# ListSodPoliciesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Localeorigin.md b/sdk-output/sod_policies/docs/Models/Localeorigin.md new file mode 100644 index 00000000..d5d60e2b --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/sod_policies/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/sod_policies/docs/Models/Multipolicyrequest.md b/sdk-output/sod_policies/docs/Models/Multipolicyrequest.md new file mode 100644 index 00000000..460c32b2 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Multipolicyrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-multipolicyrequest-v1 +title: MultipolicyrequestV1 +pagination_label: MultipolicyrequestV1 +sidebar_label: MultipolicyrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MultipolicyrequestV1', 'v1MultipolicyrequestV1'] +slug: /tools/sdk/typescript/sod_policies/models/multipolicyrequest-v1 +tags: ['SDK', 'Software Development Kit', 'MultipolicyrequestV1', 'v1MultipolicyrequestV1'] +--- + +# MultipolicyrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filteredPolicyList** | **(optional)** **Array<string>** | Multi-policy report will be run for this list of ids | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/README.md b/sdk-output/sod_policies/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sod_policies/docs/Models/Reportresultreference.md b/sdk-output/sod_policies/docs/Models/Reportresultreference.md new file mode 100644 index 00000000..bd5c571c --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Reportresultreference.md @@ -0,0 +1,22 @@ +--- +id: v1-reportresultreference-v1 +title: ReportresultreferenceV1 +pagination_label: ReportresultreferenceV1 +sidebar_label: ReportresultreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReportresultreferenceV1', 'v1ReportresultreferenceV1'] +slug: /tools/sdk/typescript/sod_policies/models/reportresultreference-v1 +tags: ['SDK', 'Software Development Kit', 'ReportresultreferenceV1', 'v1ReportresultreferenceV1'] +--- + +# ReportresultreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy violation report result DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy violation report result ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of the SOD policy violation report result. | [default to undefined] +**status** | **(optional)** **string** | Status of a SOD policy violation report. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Schedule.md b/sdk-output/sod_policies/docs/Models/Schedule.md new file mode 100644 index 00000000..038a8067 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Schedule.md @@ -0,0 +1,24 @@ +--- +id: v1-schedule-v1 +title: ScheduleV1 +pagination_label: ScheduleV1 +sidebar_label: ScheduleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleV1', 'v1ScheduleV1'] +slug: /tools/sdk/typescript/sod_policies/models/schedule-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleV1', 'v1ScheduleV1'] +--- + +# ScheduleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **ScheduletypeV1** | | [default to undefined] +**months** | **(optional)** **ScheduleMonthsV1** | | [default to undefined] +**days** | **(optional)** **ScheduleDaysV1** | | [default to undefined] +**hours** | **ScheduleHoursV1** | | [default to undefined] +**expiration** | **(optional)** **string** | A date-time in ISO-8601 format | [default to undefined] +**timeZoneId** | **(optional)** **string** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org\'s default timezone is used. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ScheduleDays.md b/sdk-output/sod_policies/docs/Models/ScheduleDays.md new file mode 100644 index 00000000..f4abd0cd --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ScheduleDays.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-days-v1 +title: ScheduleDaysV1 +pagination_label: ScheduleDaysV1 +sidebar_label: ScheduleDaysV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleDaysV1', 'v1ScheduleDaysV1'] +slug: /tools/sdk/typescript/sod_policies/models/schedule-days-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleDaysV1', 'v1ScheduleDaysV1'] +--- + +# ScheduleDaysV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ScheduleHours.md b/sdk-output/sod_policies/docs/Models/ScheduleHours.md new file mode 100644 index 00000000..27ec1032 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ScheduleHours.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-hours-v1 +title: ScheduleHoursV1 +pagination_label: ScheduleHoursV1 +sidebar_label: ScheduleHoursV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleHoursV1', 'v1ScheduleHoursV1'] +slug: /tools/sdk/typescript/sod_policies/models/schedule-hours-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleHoursV1', 'v1ScheduleHoursV1'] +--- + +# ScheduleHoursV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ScheduleMonths.md b/sdk-output/sod_policies/docs/Models/ScheduleMonths.md new file mode 100644 index 00000000..d1a8b430 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ScheduleMonths.md @@ -0,0 +1,21 @@ +--- +id: v1-schedule-months-v1 +title: ScheduleMonthsV1 +pagination_label: ScheduleMonthsV1 +sidebar_label: ScheduleMonthsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduleMonthsV1', 'v1ScheduleMonthsV1'] +slug: /tools/sdk/typescript/sod_policies/models/schedule-months-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduleMonthsV1', 'v1ScheduleMonthsV1'] +--- + +# ScheduleMonthsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Scheduletype.md b/sdk-output/sod_policies/docs/Models/Scheduletype.md new file mode 100644 index 00000000..21750d51 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Scheduletype.md @@ -0,0 +1,27 @@ +--- +id: v1-scheduletype-v1 +title: ScheduletypeV1 +pagination_label: ScheduletypeV1 +sidebar_label: ScheduletypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ScheduletypeV1', 'v1ScheduletypeV1'] +slug: /tools/sdk/typescript/sod_policies/models/scheduletype-v1 +tags: ['SDK', 'Software Development Kit', 'ScheduletypeV1', 'v1ScheduletypeV1'] +--- + +# ScheduletypeV1 + +## Enum + + +* `Daily` (value: `'DAILY'`) + +* `Weekly` (value: `'WEEKLY'`) + +* `Monthly` (value: `'MONTHLY'`) + +* `Calendar` (value: `'CALENDAR'`) + +* `Annually` (value: `'ANNUALLY'`) + + diff --git a/sdk-output/sod_policies/docs/Models/Selector.md b/sdk-output/sod_policies/docs/Models/Selector.md new file mode 100644 index 00000000..4d8a6475 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Selector.md @@ -0,0 +1,21 @@ +--- +id: v1-selector-v1 +title: SelectorV1 +pagination_label: SelectorV1 +sidebar_label: SelectorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SelectorV1', 'v1SelectorV1'] +slug: /tools/sdk/typescript/sod_policies/models/selector-v1 +tags: ['SDK', 'Software Development Kit', 'SelectorV1', 'v1SelectorV1'] +--- + +# SelectorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **SelectortypeV1** | | [default to undefined] +**values** | **Array<string>** | The selected values. | [default to undefined] +**interval** | **(optional)** **number** | The selected interval for RANGE selectors. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Selectortype.md b/sdk-output/sod_policies/docs/Models/Selectortype.md new file mode 100644 index 00000000..d5f27d64 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Selectortype.md @@ -0,0 +1,21 @@ +--- +id: v1-selectortype-v1 +title: SelectortypeV1 +pagination_label: SelectortypeV1 +sidebar_label: SelectortypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SelectortypeV1', 'v1SelectortypeV1'] +slug: /tools/sdk/typescript/sod_policies/models/selectortype-v1 +tags: ['SDK', 'Software Development Kit', 'SelectortypeV1', 'v1SelectortypeV1'] +--- + +# SelectortypeV1 + +## Enum + + +* `List` (value: `'LIST'`) + +* `Range` (value: `'RANGE'`) + + diff --git a/sdk-output/sod_policies/docs/Models/Sodpolicy.md b/sdk-output/sod_policies/docs/Models/Sodpolicy.md new file mode 100644 index 00000000..b154a861 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Sodpolicy.md @@ -0,0 +1,36 @@ +--- +id: v1-sodpolicy-v1 +title: SodpolicyV1 +pagination_label: SodpolicyV1 +sidebar_label: SodpolicyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicyV1', 'v1SodpolicyV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodpolicy-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicyV1', 'v1SodpolicyV1'] +--- + +# SodpolicyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Policy id | [readonly] [default to undefined] +**name** | **(optional)** **string** | Policy Business Name | [default to undefined] +**created** | **(optional)** **string** | The time when this SOD policy is created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | The time when this SOD policy is modified. | [readonly] [default to undefined] +**description** | **(optional)** **string** | Optional description of the SOD policy | [default to undefined] +**ownerRef** | **(optional)** **SodpolicyOwnerRefV1** | | [default to undefined] +**externalPolicyReference** | **(optional)** **string** | Optional External Policy Reference | [default to undefined] +**policyQuery** | **(optional)** **string** | Search query of the SOD policy | [default to undefined] +**compensatingControls** | **(optional)** **string** | Optional compensating controls(Mitigating Controls) | [default to undefined] +**correctionAdvice** | **(optional)** **string** | Optional correction advice | [default to undefined] +**state** | **(optional)** **string** | whether the policy is enforced or not | [default to undefined] +**tags** | **(optional)** **Array<string>** | tags for this policy object | [default to undefined] +**creatorId** | **(optional)** **string** | Policy\'s creator ID | [readonly] [default to undefined] +**modifierId** | **(optional)** **string** | Policy\'s modifier ID | [readonly] [default to undefined] +**violationOwnerAssignmentConfig** | **(optional)** **ViolationownerassignmentconfigV1** | | [default to undefined] +**scheduled** | **(optional)** **boolean** | defines whether a policy has been scheduled or not | [default to false] +**type** | **(optional)** **string** | whether a policy is query based or conflicting access based | [default to TypeV1_General] +**conflictingAccessCriteria** | **(optional)** **SodpolicyConflictingAccessCriteriaV1** | | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/SodpolicyConflictingAccessCriteria.md b/sdk-output/sod_policies/docs/Models/SodpolicyConflictingAccessCriteria.md new file mode 100644 index 00000000..9bb2a098 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/SodpolicyConflictingAccessCriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-sodpolicy-conflicting-access-criteria-v1 +title: SodpolicyConflictingAccessCriteriaV1 +pagination_label: SodpolicyConflictingAccessCriteriaV1 +sidebar_label: SodpolicyConflictingAccessCriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicyConflictingAccessCriteriaV1', 'v1SodpolicyConflictingAccessCriteriaV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodpolicy-conflicting-access-criteria-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicyConflictingAccessCriteriaV1', 'v1SodpolicyConflictingAccessCriteriaV1'] +--- + +# SodpolicyConflictingAccessCriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leftCriteria** | **(optional)** **AccesscriteriaV1** | | [default to undefined] +**rightCriteria** | **(optional)** **AccesscriteriaV1** | | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/SodpolicyOwnerRef.md b/sdk-output/sod_policies/docs/Models/SodpolicyOwnerRef.md new file mode 100644 index 00000000..317f4bfc --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/SodpolicyOwnerRef.md @@ -0,0 +1,21 @@ +--- +id: v1-sodpolicy-owner-ref-v1 +title: SodpolicyOwnerRefV1 +pagination_label: SodpolicyOwnerRefV1 +sidebar_label: SodpolicyOwnerRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicyOwnerRefV1', 'v1SodpolicyOwnerRefV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodpolicy-owner-ref-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicyOwnerRefV1', 'v1SodpolicyOwnerRefV1'] +--- + +# SodpolicyOwnerRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Sodpolicyschedule.md b/sdk-output/sod_policies/docs/Models/Sodpolicyschedule.md new file mode 100644 index 00000000..72f2c829 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Sodpolicyschedule.md @@ -0,0 +1,27 @@ +--- +id: v1-sodpolicyschedule-v1 +title: SodpolicyscheduleV1 +pagination_label: SodpolicyscheduleV1 +sidebar_label: SodpolicyscheduleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodpolicyscheduleV1', 'v1SodpolicyscheduleV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodpolicyschedule-v1 +tags: ['SDK', 'Software Development Kit', 'SodpolicyscheduleV1', 'v1SodpolicyscheduleV1'] +--- + +# SodpolicyscheduleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | SOD Policy schedule name | [default to undefined] +**created** | **(optional)** **string** | The time when this SOD policy schedule is created. | [readonly] [default to undefined] +**modified** | **(optional)** **string** | The time when this SOD policy schedule is modified. | [readonly] [default to undefined] +**description** | **(optional)** **string** | SOD Policy schedule description | [default to undefined] +**schedule** | **(optional)** **ScheduleV1** | | [default to undefined] +**recipients** | **(optional)** **Array<SodrecipientV1>** | | [default to undefined] +**emailEmptyResults** | **(optional)** **boolean** | Indicates if empty results need to be emailed | [default to false] +**creatorId** | **(optional)** **string** | Policy\'s creator ID | [readonly] [default to undefined] +**modifierId** | **(optional)** **string** | Policy\'s modifier ID | [readonly] [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Sodrecipient.md b/sdk-output/sod_policies/docs/Models/Sodrecipient.md new file mode 100644 index 00000000..1d6f1d3c --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Sodrecipient.md @@ -0,0 +1,21 @@ +--- +id: v1-sodrecipient-v1 +title: SodrecipientV1 +pagination_label: SodrecipientV1 +sidebar_label: SodrecipientV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodrecipientV1', 'v1SodrecipientV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodrecipient-v1 +tags: ['SDK', 'Software Development Kit', 'SodrecipientV1', 'v1SodrecipientV1'] +--- + +# SodrecipientV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy recipient DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy recipient\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | SOD policy recipient\'s display name. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Sodreportresultdto.md b/sdk-output/sod_policies/docs/Models/Sodreportresultdto.md new file mode 100644 index 00000000..03d1b955 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Sodreportresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-sodreportresultdto-v1 +title: SodreportresultdtoV1 +pagination_label: SodreportresultdtoV1 +sidebar_label: SodreportresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodreportresultdtoV1', 'v1SodreportresultdtoV1'] +slug: /tools/sdk/typescript/sod_policies/models/sodreportresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'SodreportresultdtoV1', 'v1SodreportresultdtoV1'] +--- + +# SodreportresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy violation report result DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy violation report result ID. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of the SOD policy violation report result. | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/Violationownerassignmentconfig.md b/sdk-output/sod_policies/docs/Models/Violationownerassignmentconfig.md new file mode 100644 index 00000000..b06a827b --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/Violationownerassignmentconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-violationownerassignmentconfig-v1 +title: ViolationownerassignmentconfigV1 +pagination_label: ViolationownerassignmentconfigV1 +sidebar_label: ViolationownerassignmentconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ViolationownerassignmentconfigV1', 'v1ViolationownerassignmentconfigV1'] +slug: /tools/sdk/typescript/sod_policies/models/violationownerassignmentconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ViolationownerassignmentconfigV1', 'v1ViolationownerassignmentconfigV1'] +--- + +# ViolationownerassignmentconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignmentRule** | **(optional)** **string** | Details about the violations owner. MANAGER - identity\'s manager STATIC - Governance Group or Identity | [default to undefined] +**ownerRef** | **(optional)** **ViolationownerassignmentconfigOwnerRefV1** | | [default to undefined] + diff --git a/sdk-output/sod_policies/docs/Models/ViolationownerassignmentconfigOwnerRef.md b/sdk-output/sod_policies/docs/Models/ViolationownerassignmentconfigOwnerRef.md new file mode 100644 index 00000000..4914edc5 --- /dev/null +++ b/sdk-output/sod_policies/docs/Models/ViolationownerassignmentconfigOwnerRef.md @@ -0,0 +1,21 @@ +--- +id: v1-violationownerassignmentconfig-owner-ref-v1 +title: ViolationownerassignmentconfigOwnerRefV1 +pagination_label: ViolationownerassignmentconfigOwnerRefV1 +sidebar_label: ViolationownerassignmentconfigOwnerRefV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ViolationownerassignmentconfigOwnerRefV1', 'v1ViolationownerassignmentconfigOwnerRefV1'] +slug: /tools/sdk/typescript/sod_policies/models/violationownerassignmentconfig-owner-ref-v1 +tags: ['SDK', 'Software Development Kit', 'ViolationownerassignmentconfigOwnerRefV1', 'v1ViolationownerassignmentconfigOwnerRefV1'] +--- + +# ViolationownerassignmentconfigOwnerRefV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Owner type. | [default to undefined] +**id** | **(optional)** **string** | Owner\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Owner\'s name. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/sod_violations/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..d20d09bc --- /dev/null +++ b/sdk-output/sod_violations/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,30 @@ +- path: /sod-violations/v1/predict + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_violations/methods/sod-violations#start-predict-sod-violations-v1 + source: | + import { SODViolationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODViolationsV1Api(configuration); + const identitywithnewaccessV1: IdentitywithnewaccessV1 = {"identityId":"2c91808568c529c60168cca6f90c1313","accessRefs":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c050861ab1"},{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}; // IdentitywithnewaccessV1 | + const result = await apiInstance.startPredictSodViolationsV1(identitywithnewaccessV1); + console.log(result); +- path: /sod-violations/v1/check + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sod_violations/methods/sod-violations#start-violation-check-v1 + source: | + import { SODViolationsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SODViolationsV1Api(configuration); + const identitywithnewaccessV1: IdentitywithnewaccessV1 = {"identityId":"2c91808568c529c60168cca6f90c1313","accessRefs":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c050861ab1"},{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}],"clientMetadata":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}; // IdentitywithnewaccessV1 | + const result = await apiInstance.startViolationCheckV1(identitywithnewaccessV1); + console.log(result); diff --git a/sdk-output/sod_violations/docs/Methods/Index.md b/sdk-output/sod_violations/docs/Methods/Index.md new file mode 100644 index 00000000..84049fe1 --- /dev/null +++ b/sdk-output/sod_violations/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: sod_violations-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: sod_violations-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'sod_violations', 'methods'] +slug: /tools/sdk/typescript/sod_violations/methods +tags: ['SDK', 'Software Development Kit', 'sod_violations', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/sod_violations/docs/Methods/SODViolationsV1Api.md b/sdk-output/sod_violations/docs/Methods/SODViolationsV1Api.md new file mode 100644 index 00000000..c5167c02 --- /dev/null +++ b/sdk-output/sod_violations/docs/Methods/SODViolationsV1Api.md @@ -0,0 +1,115 @@ +--- +id: v1-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SODViolations', 'v1SODViolations'] +slug: /tools/sdk/typescript/sod_violations/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'v1SODViolations'] +--- + +# SODViolationsV1Api + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**start-predict-sod-violations-v1**](#start-predict-sod-violations-v1) | **POST** `/sod-violations/v1/predict` | Predict sod violations for identity. +[**start-violation-check-v1**](#start-violation-check-v1) | **POST** `/sod-violations/v1/check` | Check sod violations + + +## start-predict-sod-violations-v1 +Predict sod violations for identity. +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-predict-sod-violations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identitywithnewaccessV1** | **IdentitywithnewaccessV1** | | + +### Return type + +**ViolationpredictionV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODViolationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODViolationsV1Api(configuration); +const identitywithnewaccessV1: IdentitywithnewaccessV1 = {"identityId":"2c91808568c529c60168cca6f90c1313","accessRefs":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c050861ab1"},{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}]}; // +const result = await apiInstance.startPredictSodViolationsV1(identitywithnewaccessV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-violation-check-v1 +Check sod violations +This API initiates a SOD policy verification asynchronously. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-violation-check-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identitywithnewaccessV1** | **IdentitywithnewaccessV1** | | + +### Return type + +**SodviolationcheckV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SODViolationsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SODViolationsV1Api(configuration); +const identitywithnewaccessV1: IdentitywithnewaccessV1 = {"identityId":"2c91808568c529c60168cca6f90c1313","accessRefs":[{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c050861ab1"},{"type":"ENTITLEMENT","id":"2c918087682f9a86016839c0509c1ab2"}],"clientMetadata":{"additionalProp1":"string","additionalProp2":"string","additionalProp3":"string"}}; // +const result = await apiInstance.startViolationCheckV1(identitywithnewaccessV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/sod_violations/docs/Models/Dtotype.md b/sdk-output/sod_violations/docs/Models/Dtotype.md new file mode 100644 index 00000000..24624498 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/sod_violations/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/sod_violations/docs/Models/Errormessagedto.md b/sdk-output/sod_violations/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..46b4bb3f --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/sod_violations/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Errorresponsedto.md b/sdk-output/sod_violations/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..5b274a5a --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/sod_violations/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Exceptionaccesscriteria.md b/sdk-output/sod_violations/docs/Models/Exceptionaccesscriteria.md new file mode 100644 index 00000000..dbea9d2d --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Exceptionaccesscriteria.md @@ -0,0 +1,20 @@ +--- +id: v1-exceptionaccesscriteria-v1 +title: ExceptionaccesscriteriaV1 +pagination_label: ExceptionaccesscriteriaV1 +sidebar_label: ExceptionaccesscriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExceptionaccesscriteriaV1', 'v1ExceptionaccesscriteriaV1'] +slug: /tools/sdk/typescript/sod_violations/models/exceptionaccesscriteria-v1 +tags: ['SDK', 'Software Development Kit', 'ExceptionaccesscriteriaV1', 'v1ExceptionaccesscriteriaV1'] +--- + +# ExceptionaccesscriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**leftCriteria** | **(optional)** **ExceptioncriteriaV1** | | [default to undefined] +**rightCriteria** | **(optional)** **ExceptioncriteriaV1** | | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Exceptioncriteria.md b/sdk-output/sod_violations/docs/Models/Exceptioncriteria.md new file mode 100644 index 00000000..baa3b08f --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Exceptioncriteria.md @@ -0,0 +1,19 @@ +--- +id: v1-exceptioncriteria-v1 +title: ExceptioncriteriaV1 +pagination_label: ExceptioncriteriaV1 +sidebar_label: ExceptioncriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExceptioncriteriaV1', 'v1ExceptioncriteriaV1'] +slug: /tools/sdk/typescript/sod_violations/models/exceptioncriteria-v1 +tags: ['SDK', 'Software Development Kit', 'ExceptioncriteriaV1', 'v1ExceptioncriteriaV1'] +--- + +# ExceptioncriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**criteriaList** | **(optional)** **Array<ExceptioncriteriaCriteriaListInnerV1>** | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/ExceptioncriteriaCriteriaListInner.md b/sdk-output/sod_violations/docs/Models/ExceptioncriteriaCriteriaListInner.md new file mode 100644 index 00000000..7cbb0c4b --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/ExceptioncriteriaCriteriaListInner.md @@ -0,0 +1,22 @@ +--- +id: v1-exceptioncriteria-criteria-list-inner-v1 +title: ExceptioncriteriaCriteriaListInnerV1 +pagination_label: ExceptioncriteriaCriteriaListInnerV1 +sidebar_label: ExceptioncriteriaCriteriaListInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExceptioncriteriaCriteriaListInnerV1', 'v1ExceptioncriteriaCriteriaListInnerV1'] +slug: /tools/sdk/typescript/sod_violations/models/exceptioncriteria-criteria-list-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ExceptioncriteriaCriteriaListInnerV1', 'v1ExceptioncriteriaCriteriaListInnerV1'] +--- + +# ExceptioncriteriaCriteriaListInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object that is referenced | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] +**existing** | **(optional)** **boolean** | Whether the subject identity already had that access or not | [default to false] + diff --git a/sdk-output/sod_violations/docs/Models/Exceptioncriteriaaccess.md b/sdk-output/sod_violations/docs/Models/Exceptioncriteriaaccess.md new file mode 100644 index 00000000..b907b185 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Exceptioncriteriaaccess.md @@ -0,0 +1,22 @@ +--- +id: v1-exceptioncriteriaaccess-v1 +title: ExceptioncriteriaaccessV1 +pagination_label: ExceptioncriteriaaccessV1 +sidebar_label: ExceptioncriteriaaccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExceptioncriteriaaccessV1', 'v1ExceptioncriteriaaccessV1'] +slug: /tools/sdk/typescript/sod_violations/models/exceptioncriteriaaccess-v1 +tags: ['SDK', 'Software Development Kit', 'ExceptioncriteriaaccessV1', 'v1ExceptioncriteriaaccessV1'] +--- + +# ExceptioncriteriaaccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] +**existing** | **(optional)** **boolean** | Whether the subject identity already had that access or not | [default to false] + diff --git a/sdk-output/sod_violations/docs/Models/Identitywithnewaccess.md b/sdk-output/sod_violations/docs/Models/Identitywithnewaccess.md new file mode 100644 index 00000000..999e6585 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Identitywithnewaccess.md @@ -0,0 +1,20 @@ +--- +id: v1-identitywithnewaccess-v1 +title: IdentitywithnewaccessV1 +pagination_label: IdentitywithnewaccessV1 +sidebar_label: IdentitywithnewaccessV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitywithnewaccessV1', 'v1IdentitywithnewaccessV1'] +slug: /tools/sdk/typescript/sod_violations/models/identitywithnewaccess-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitywithnewaccessV1', 'v1IdentitywithnewaccessV1'] +--- + +# IdentitywithnewaccessV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityId** | **string** | Identity id to be checked. | [default to undefined] +**accessRefs** | **Array<IdentitywithnewaccessAccessRefsInnerV1>** | The list of entitlements to consider for possible violations in a preventive check. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/IdentitywithnewaccessAccessRefsInner.md b/sdk-output/sod_violations/docs/Models/IdentitywithnewaccessAccessRefsInner.md new file mode 100644 index 00000000..281bb292 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/IdentitywithnewaccessAccessRefsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-identitywithnewaccess-access-refs-inner-v1 +title: IdentitywithnewaccessAccessRefsInnerV1 +pagination_label: IdentitywithnewaccessAccessRefsInnerV1 +sidebar_label: IdentitywithnewaccessAccessRefsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitywithnewaccessAccessRefsInnerV1', 'v1IdentitywithnewaccessAccessRefsInnerV1'] +slug: /tools/sdk/typescript/sod_violations/models/identitywithnewaccess-access-refs-inner-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitywithnewaccessAccessRefsInnerV1', 'v1IdentitywithnewaccessAccessRefsInnerV1'] +--- + +# IdentitywithnewaccessAccessRefsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Entitlement\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Entitlement\'s ID. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Index.md b/sdk-output/sod_violations/docs/Models/Index.md new file mode 100644 index 00000000..0835eb4e --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: sod_violations-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: sod_violations-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'sod_violations', 'models'] +slug: /tools/sdk/typescript/sod_violations/models +tags: ['SDK', 'Software Development Kit', 'sod_violations', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/sod_violations/docs/Models/Localeorigin.md b/sdk-output/sod_violations/docs/Models/Localeorigin.md new file mode 100644 index 00000000..8150741c --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/sod_violations/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/sod_violations/docs/Models/README.md b/sdk-output/sod_violations/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sod_violations/docs/Models/Sodpolicydto2.md b/sdk-output/sod_violations/docs/Models/Sodpolicydto2.md new file mode 100644 index 00000000..160eaf61 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Sodpolicydto2.md @@ -0,0 +1,21 @@ +--- +id: v1-sodpolicydto2-v1 +title: Sodpolicydto2V1 +pagination_label: Sodpolicydto2V1 +sidebar_label: Sodpolicydto2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Sodpolicydto2V1', 'v1Sodpolicydto2V1'] +slug: /tools/sdk/typescript/sod_violations/models/sodpolicydto2-v1 +tags: ['SDK', 'Software Development Kit', 'Sodpolicydto2V1', 'v1Sodpolicydto2V1'] +--- + +# Sodpolicydto2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | SOD policy DTO type. | [default to undefined] +**id** | **(optional)** **string** | SOD policy ID. | [default to undefined] +**name** | **(optional)** **string** | SOD policy display name. | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Sodviolationcheck.md b/sdk-output/sod_violations/docs/Models/Sodviolationcheck.md new file mode 100644 index 00000000..c8eb7f55 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Sodviolationcheck.md @@ -0,0 +1,20 @@ +--- +id: v1-sodviolationcheck-v1 +title: SodviolationcheckV1 +pagination_label: SodviolationcheckV1 +sidebar_label: SodviolationcheckV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SodviolationcheckV1', 'v1SodviolationcheckV1'] +slug: /tools/sdk/typescript/sod_violations/models/sodviolationcheck-v1 +tags: ['SDK', 'Software Development Kit', 'SodviolationcheckV1', 'v1SodviolationcheckV1'] +--- + +# SodviolationcheckV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requestId** | **string** | The id of the original request | [default to undefined] +**created** | **(optional)** **string** | The date-time when this request was created. | [readonly] [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1401Response.md b/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1401Response.md new file mode 100644 index 00000000..ad476b16 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-predict-sod-violations-v1401-response-v1 +title: StartPredictSodViolationsV1401ResponseV1 +pagination_label: StartPredictSodViolationsV1401ResponseV1 +sidebar_label: StartPredictSodViolationsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartPredictSodViolationsV1401ResponseV1', 'v1StartPredictSodViolationsV1401ResponseV1'] +slug: /tools/sdk/typescript/sod_violations/models/start-predict-sod-violations-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartPredictSodViolationsV1401ResponseV1', 'v1StartPredictSodViolationsV1401ResponseV1'] +--- + +# StartPredictSodViolationsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1429Response.md b/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1429Response.md new file mode 100644 index 00000000..403f2f30 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/StartPredictSodViolationsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-start-predict-sod-violations-v1429-response-v1 +title: StartPredictSodViolationsV1429ResponseV1 +pagination_label: StartPredictSodViolationsV1429ResponseV1 +sidebar_label: StartPredictSodViolationsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartPredictSodViolationsV1429ResponseV1', 'v1StartPredictSodViolationsV1429ResponseV1'] +slug: /tools/sdk/typescript/sod_violations/models/start-predict-sod-violations-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'StartPredictSodViolationsV1429ResponseV1', 'v1StartPredictSodViolationsV1429ResponseV1'] +--- + +# StartPredictSodViolationsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Violationcontext.md b/sdk-output/sod_violations/docs/Models/Violationcontext.md new file mode 100644 index 00000000..df2f4d4e --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Violationcontext.md @@ -0,0 +1,20 @@ +--- +id: v1-violationcontext-v1 +title: ViolationcontextV1 +pagination_label: ViolationcontextV1 +sidebar_label: ViolationcontextV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ViolationcontextV1', 'v1ViolationcontextV1'] +slug: /tools/sdk/typescript/sod_violations/models/violationcontext-v1 +tags: ['SDK', 'Software Development Kit', 'ViolationcontextV1', 'v1ViolationcontextV1'] +--- + +# ViolationcontextV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policy** | **(optional)** **ViolationcontextPolicyV1** | | [default to undefined] +**conflictingAccessCriteria** | **(optional)** **ExceptionaccesscriteriaV1** | | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/ViolationcontextPolicy.md b/sdk-output/sod_violations/docs/Models/ViolationcontextPolicy.md new file mode 100644 index 00000000..d67fee68 --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/ViolationcontextPolicy.md @@ -0,0 +1,21 @@ +--- +id: v1-violationcontext-policy-v1 +title: ViolationcontextPolicyV1 +pagination_label: ViolationcontextPolicyV1 +sidebar_label: ViolationcontextPolicyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ViolationcontextPolicyV1', 'v1ViolationcontextPolicyV1'] +slug: /tools/sdk/typescript/sod_violations/models/violationcontext-policy-v1 +tags: ['SDK', 'Software Development Kit', 'ViolationcontextPolicyV1', 'v1ViolationcontextPolicyV1'] +--- + +# ViolationcontextPolicyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object that is referenced | [default to undefined] +**id** | **(optional)** **string** | SOD policy ID. | [default to undefined] +**name** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/sod_violations/docs/Models/Violationprediction.md b/sdk-output/sod_violations/docs/Models/Violationprediction.md new file mode 100644 index 00000000..b264c11d --- /dev/null +++ b/sdk-output/sod_violations/docs/Models/Violationprediction.md @@ -0,0 +1,19 @@ +--- +id: v1-violationprediction-v1 +title: ViolationpredictionV1 +pagination_label: ViolationpredictionV1 +sidebar_label: ViolationpredictionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ViolationpredictionV1', 'v1ViolationpredictionV1'] +slug: /tools/sdk/typescript/sod_violations/models/violationprediction-v1 +tags: ['SDK', 'Software Development Kit', 'ViolationpredictionV1', 'v1ViolationpredictionV1'] +--- + +# ViolationpredictionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**violationContexts** | **(optional)** **Array<ViolationcontextV1>** | List of Violation Contexts | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/source_usages/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..360e879e --- /dev/null +++ b/sdk-output/source_usages/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,34 @@ +- path: /source-usages/v1/{sourceId}/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/source_usages/methods/source-usages#get-status-by-source-id-v1 + source: | + import { SourceUsagesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourceUsagesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of IDN source (default to undefined) + const result = await apiInstance.getStatusBySourceIdV1(sourceId); + console.log(result); +- path: /source-usages/v1/{sourceId}/summaries + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/source_usages/methods/source-usages#get-usages-by-source-id-v1 + source: | + import { SourceUsagesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourceUsagesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of IDN source (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const sorters: string = '-date'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) (default to undefined) + const result = await apiInstance.getUsagesBySourceIdV1(sourceId); + console.log(result); diff --git a/sdk-output/source_usages/docs/Methods/Index.md b/sdk-output/source_usages/docs/Methods/Index.md new file mode 100644 index 00000000..1182ac25 --- /dev/null +++ b/sdk-output/source_usages/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: source_usages-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: source_usages-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'source_usages', 'methods'] +slug: /tools/sdk/typescript/source_usages/methods +tags: ['SDK', 'Software Development Kit', 'source_usages', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/source_usages/docs/Methods/SourceUsagesV1Api.md b/sdk-output/source_usages/docs/Methods/SourceUsagesV1Api.md new file mode 100644 index 00000000..f71124be --- /dev/null +++ b/sdk-output/source_usages/docs/Methods/SourceUsagesV1Api.md @@ -0,0 +1,108 @@ +--- +id: v1-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceUsages', 'v1SourceUsages'] +slug: /tools/sdk/typescript/source_usages/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'v1SourceUsages'] +--- + +# SourceUsagesV1Api + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-status-by-source-id-v1**](#get-status-by-source-id-v1) | **GET** `/source-usages/v1/{sourceId}/status` | Finds status of source usage +[**get-usages-by-source-id-v1**](#get-usages-by-source-id-v1) | **GET** `/source-usages/v1/{sourceId}/summaries` | Returns source usage insights + + +## get-status-by-source-id-v1 +Finds status of source usage +This API returns the status of the source usage insights setup by IDN source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-status-by-source-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | ID of IDN source | [default to undefined] + +### Return type + +**SourceusagestatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourceUsagesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourceUsagesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // ID of IDN source +const result = await apiInstance.getStatusBySourceIdV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-usages-by-source-id-v1 +Returns source usage insights +This API returns a summary of source usage insights for past 12 months. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-usages-by-source-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | ID of IDN source | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourceUsagesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourceUsagesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // ID of IDN source +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const sorters: string = -date; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) +const result = await apiInstance.getUsagesBySourceIdV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/source_usages/docs/Models/Errormessagedto.md b/sdk-output/source_usages/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8606bd23 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/source_usages/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Models/Errorresponsedto.md b/sdk-output/source_usages/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..01ec21d5 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/source_usages/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1401Response.md b/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1401Response.md new file mode 100644 index 00000000..fac50f7b --- /dev/null +++ b/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-status-by-source-id-v1401-response-v1 +title: GetStatusBySourceIdV1401ResponseV1 +pagination_label: GetStatusBySourceIdV1401ResponseV1 +sidebar_label: GetStatusBySourceIdV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetStatusBySourceIdV1401ResponseV1', 'v1GetStatusBySourceIdV1401ResponseV1'] +slug: /tools/sdk/typescript/source_usages/models/get-status-by-source-id-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetStatusBySourceIdV1401ResponseV1', 'v1GetStatusBySourceIdV1401ResponseV1'] +--- + +# GetStatusBySourceIdV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1429Response.md b/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1429Response.md new file mode 100644 index 00000000..68a68f63 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/GetStatusBySourceIdV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-status-by-source-id-v1429-response-v1 +title: GetStatusBySourceIdV1429ResponseV1 +pagination_label: GetStatusBySourceIdV1429ResponseV1 +sidebar_label: GetStatusBySourceIdV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetStatusBySourceIdV1429ResponseV1', 'v1GetStatusBySourceIdV1429ResponseV1'] +slug: /tools/sdk/typescript/source_usages/models/get-status-by-source-id-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetStatusBySourceIdV1429ResponseV1', 'v1GetStatusBySourceIdV1429ResponseV1'] +--- + +# GetStatusBySourceIdV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Models/Index.md b/sdk-output/source_usages/docs/Models/Index.md new file mode 100644 index 00000000..22c6d02f --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: source_usages-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: source_usages-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'source_usages', 'models'] +slug: /tools/sdk/typescript/source_usages/models +tags: ['SDK', 'Software Development Kit', 'source_usages', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/source_usages/docs/Models/Localeorigin.md b/sdk-output/source_usages/docs/Models/Localeorigin.md new file mode 100644 index 00000000..3e5d1683 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/source_usages/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/source_usages/docs/Models/README.md b/sdk-output/source_usages/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/source_usages/docs/Models/Sourceusage.md b/sdk-output/source_usages/docs/Models/Sourceusage.md new file mode 100644 index 00000000..6f3500a7 --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Sourceusage.md @@ -0,0 +1,20 @@ +--- +id: v1-sourceusage-v1 +title: SourceusageV1 +pagination_label: SourceusageV1 +sidebar_label: SourceusageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceusageV1', 'v1SourceusageV1'] +slug: /tools/sdk/typescript/source_usages/models/sourceusage-v1 +tags: ['SDK', 'Software Development Kit', 'SourceusageV1', 'v1SourceusageV1'] +--- + +# SourceusageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date** | **(optional)** **string** | The first day of the month for which activity is aggregated. | [default to undefined] +**count** | **(optional)** **number** | The average number of days that accounts were active within this source, for the month. | [default to undefined] + diff --git a/sdk-output/source_usages/docs/Models/Sourceusagestatus.md b/sdk-output/source_usages/docs/Models/Sourceusagestatus.md new file mode 100644 index 00000000..6158c61e --- /dev/null +++ b/sdk-output/source_usages/docs/Models/Sourceusagestatus.md @@ -0,0 +1,19 @@ +--- +id: v1-sourceusagestatus-v1 +title: SourceusagestatusV1 +pagination_label: SourceusagestatusV1 +sidebar_label: SourceusagestatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceusagestatusV1', 'v1SourceusagestatusV1'] +slug: /tools/sdk/typescript/source_usages/models/sourceusagestatus-v1 +tags: ['SDK', 'Software Development Kit', 'SourceusagestatusV1', 'v1SourceusagestatusV1'] +--- + +# SourceusagestatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **(optional)** **string** | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [default to undefined] + diff --git a/sdk-output/sources/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/sources/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..25809871 --- /dev/null +++ b/sdk-output/sources/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,899 @@ +- path: /sources/v1/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#create-provisioning-policy-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id (default to undefined) + const provisioningpolicydtoV1: ProvisioningpolicydtoV1 = {"name":"Account","description":"Account Provisioning Policy","usageType":"CREATE","fields":[{"name":"displayName","transform":{"type":"identityAttribute","attributes":{"name":"displayName"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false},{"name":"distinguishedName","transform":{"type":"usernameGenerator","attributes":{"sourceCheck":true,"patterns":["CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"],"fn":{"type":"identityAttribute","attributes":{"name":"firstname"}},"ln":{"type":"identityAttribute","attributes":{"name":"lastname"}},"fi":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":1}},"fti":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":2}}}},"attributes":{"cloudMaxUniqueChecks":"5","cloudMaxSize":"100","cloudRequired":"true"},"isRequired":false,"type":"","isMultiValued":false},{"name":"description","transform":{"type":"static","attributes":{"value":""}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}]}; // ProvisioningpolicydtoV1 | + const result = await apiInstance.createProvisioningPolicyV1(sourceId, provisioningpolicydtoV1); + console.log(result); +- path: /sources/v1/{sourceId}/schedules + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#create-source-schedule-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const schedule3V1: Schedule3V1 = ; // Schedule3V1 | + const result = await apiInstance.createSourceScheduleV1(sourceId, schedule3V1); + console.log(result); +- path: /sources/v1/{sourceId}/schemas + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#create-source-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const schemaV1: SchemaV1 = ; // SchemaV1 | + const result = await apiInstance.createSourceSchemaV1(sourceId, schemaV1); + console.log(result); +- path: /sources/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#create-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceV1: SourceV1 = ; // SourceV1 | + const provisionAsCsv: boolean = false; // boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. (optional) (default to undefined) + const result = await apiInstance.createSourceV1(sourceV1); + console.log(result); +- path: /sources/v1/{id}/remove-accounts + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-accounts-async-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = 'ebbf35756e1140699ce52b233121384a'; // string | The source id (default to undefined) + const result = await apiInstance.deleteAccountsAsyncV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-native-change-detection-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const result = await apiInstance.deleteNativeChangeDetectionConfigV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-provisioning-policy-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined) + const usageType: UsagetypeV1 = CREATE; // UsagetypeV1 | 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 four usage types for all your provisioning policy needs. (default to undefined) + const result = await apiInstance.deleteProvisioningPolicyV1(sourceId, usageType); + console.log(result); +- path: /sources/v1/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-source-schedule-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const scheduleType: string = 'ACCOUNT_AGGREGATION'; // 'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION' | The Schedule type. (default to undefined) + const result = await apiInstance.deleteSourceScheduleV1(sourceId, scheduleType); + console.log(result); +- path: /sources/v1/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-source-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const schemaId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Schema id. (default to undefined) + const result = await apiInstance.deleteSourceSchemaV1(sourceId, schemaId); + console.log(result); +- path: /sources/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#delete-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const result = await apiInstance.deleteSourceV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/approval-config/account-delete + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-account-delete-approval-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'ha38f94347e94562b5bb8424a56498d8'; // string | The Source id (default to undefined) + const result = await apiInstance.getAccountDeleteApprovalConfigV1(sourceId); + console.log(result); +- path: /sources/v1/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-accounts-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const result = await apiInstance.getAccountsSchemaV1(id); + console.log(result); +- path: /sources/v1/{id}/correlation-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-correlation-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const result = await apiInstance.getCorrelationConfigV1(id); + console.log(result); +- path: /sources/v1/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-entitlements-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const schemaName: string = '?schemaName=group'; // string | Name of entitlement schema (optional) (default to undefined) + const result = await apiInstance.getEntitlementsSchemaV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/approval-config/machine-account-delete + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-machine-account-deletion-approval-config-by-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'gt38f94347e94562b5bb8424a56498d8'; // string | source id. (default to undefined) + const result = await apiInstance.getMachineAccountDeletionApprovalConfigBySourceV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-native-change-detection-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const result = await apiInstance.getNativeChangeDetectionConfigV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-provisioning-policy-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined) + const usageType: UsagetypeV1 = CREATE; // UsagetypeV1 | 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 four usage types for all your provisioning policy needs. (default to undefined) + const result = await apiInstance.getProvisioningPolicyV1(sourceId, usageType); + console.log(result); +- path: /sources/v1/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-attr-sync-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSourceAttrSyncConfigV1(id); + console.log(result); +- path: /sources/v1/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = 'cef3ee201db947c5912551015ba0c679'; // string | The Source id (default to undefined) + const locale: string = 'en'; // 'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl' | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) (default to undefined) + const result = await apiInstance.getSourceConfigV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/connections + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-connections-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const result = await apiInstance.getSourceConnectionsV1(sourceId); + console.log(result); +- path: /sources/v1/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-entitlement-request-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getSourceEntitlementRequestConfigV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/source-health + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-health-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const result = await apiInstance.getSourceHealthV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-schedule-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const scheduleType: string = 'ACCOUNT_AGGREGATION'; // 'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION' | The Schedule type. (default to undefined) + const result = await apiInstance.getSourceScheduleV1(sourceId, scheduleType); + console.log(result); +- path: /sources/v1/{sourceId}/schedules + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-schedules-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const result = await apiInstance.getSourceSchedulesV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const schemaId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Schema id. (default to undefined) + const result = await apiInstance.getSourceSchemaV1(sourceId, schemaId); + console.log(result); +- path: /sources/v1/{sourceId}/schemas + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-schemas-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const includeTypes: string = 'group'; // 'group' | 'user' | If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) (default to undefined) + const includeNames: string = 'account'; // string | A comma-separated list of schema names to filter result. (optional) (default to undefined) + const result = await apiInstance.getSourceSchemasV1(sourceId); + console.log(result); +- path: /sources/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#get-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const result = await apiInstance.getSourceV1(id); + console.log(result); +- path: /sources/v1/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-accounts-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const file: File = BINARY_DATA_HERE; // File | (optional) (default to undefined) + const result = await apiInstance.importAccountsSchemaV1(id); + console.log(result); +- path: /sources/v1/{id}/load-accounts + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-accounts-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source Id (default to undefined) + const file: File = BINARY_DATA_HERE; // File | The CSV file containing the source accounts to aggregate. (optional) (default to undefined) + const disableOptimization: string = 'disableOptimization_example'; // string | Use this flag to reprocess every account whether or not the data has changed. (optional) (default to undefined) + const result = await apiInstance.importAccountsV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-connector-file-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const file: File = BINARY_DATA_HERE; // File | (optional) (default to undefined) + const result = await apiInstance.importConnectorFileV1(sourceId); + console.log(result); +- path: /sources/v1/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-entitlements-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const schemaName: string = '?schemaName=group'; // string | Name of entitlement schema (optional) (default to undefined) + const file: File = BINARY_DATA_HERE; // File | (optional) (default to undefined) + const result = await apiInstance.importEntitlementsSchemaV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/load-entitlements + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-entitlements-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | Source Id (default to undefined) + const file: File = BINARY_DATA_HERE; // File | The CSV file containing the source entitlements to aggregate. (optional) (default to undefined) + const result = await apiInstance.importEntitlementsV1(sourceId); + console.log(result); +- path: /sources/v1/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#import-uncorrelated-accounts-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '75dbec1ebe154d5785da27b95e1dd5d7'; // string | Source Id (default to undefined) + const file: File = BINARY_DATA_HERE; // File | (optional) (default to undefined) + const result = await apiInstance.importUncorrelatedAccountsV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/password-policies + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#list-password-policy-holders-on-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.listPasswordPolicyHoldersOnSourceV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#list-provisioning-policies-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id (default to undefined) + const offset: number = 0; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const result = await apiInstance.listProvisioningPoliciesV1(sourceId); + console.log(result); +- path: /sources/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#list-sources-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'name eq "Employees"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) (default to undefined) + const forSubadmin: string = 'name'; // string | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) (default to undefined) + const includeIDNSource: boolean = true; // boolean | Include the IdentityNow source in the response. (optional) (default to false) + const result = await apiInstance.listSourcesV1(); + console.log(result); +- path: /sources/v1/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#ping-cluster-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'cef3ee201db947c5912551015ba0c679'; // string | The ID of the Source (default to undefined) + const result = await apiInstance.pingClusterV1(sourceId); + console.log(result); +- path: /sources/v1/{id}/correlation-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-correlation-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const correlationconfigV1: CorrelationconfigV1 = ; // CorrelationconfigV1 | + const result = await apiInstance.putCorrelationConfigV1(id, correlationconfigV1); + console.log(result); +- path: /sources/v1/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-native-change-detection-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const nativechangedetectionconfigV1: NativechangedetectionconfigV1 = ; // NativechangedetectionconfigV1 | + const result = await apiInstance.putNativeChangeDetectionConfigV1(sourceId, nativechangedetectionconfigV1); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-provisioning-policy-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined) + const usageType: UsagetypeV1 = CREATE; // UsagetypeV1 | 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 four usage types for all your provisioning policy needs. (default to undefined) + const provisioningpolicydtoV1: ProvisioningpolicydtoV1 = ; // ProvisioningpolicydtoV1 | + const result = await apiInstance.putProvisioningPolicyV1(sourceId, usageType, provisioningpolicydtoV1); + console.log(result); +- path: /sources/v1/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-source-attr-sync-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | The source id (default to undefined) + const attrsyncsourceconfigV1: AttrsyncsourceconfigV1 = ; // AttrsyncsourceconfigV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.putSourceAttrSyncConfigV1(id, attrsyncsourceconfigV1); + console.log(result); +- path: /sources/v1/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-source-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const schemaId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Schema id. (default to undefined) + const schemaV1: SchemaV1 = ; // SchemaV1 | + const result = await apiInstance.putSourceSchemaV1(sourceId, schemaId, schemaV1); + console.log(result); +- path: /sources/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#put-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const sourceV1: SourceV1 = ; // SourceV1 | + const result = await apiInstance.putSourceV1(id, sourceV1); + console.log(result); +- path: /sources/v1/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#search-resource-objects-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'cef3ee201db947c5912551015ba0c679'; // string | The ID of the Source (default to undefined) + const resourceobjectsrequestV1: ResourceobjectsrequestV1 = ; // ResourceobjectsrequestV1 | + const result = await apiInstance.searchResourceObjectsV1(sourceId, resourceobjectsrequestV1); + console.log(result); +- path: /sources/v1/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#sync-attributes-for-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = 'id_example'; // string | The Source id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.syncAttributesForSourceV1(id); + console.log(result); +- path: /sources/v1/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#test-source-configuration-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'cef3ee201db947c5912551015ba0c679'; // string | The ID of the Source (default to undefined) + const result = await apiInstance.testSourceConfigurationV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#test-source-connection-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = 'cef3ee201db947c5912551015ba0c679'; // string | The ID of the Source. (default to undefined) + const result = await apiInstance.testSourceConnectionV1(sourceId); + console.log(result); +- path: /sources/v1/{sourceId}/approval-config/account-delete + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-account-deletion-approval-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '00eebcf881994e419d72e757fd30dc0e'; // string | Human account source ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | The JSONPatch payload used to update the object. + const result = await apiInstance.updateAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1); + console.log(result); +- path: /sources/v1/{sourceId}/approval-config/machine-account-delete + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-machine-account-deletion-approval-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '00eebcf881994e419d72e757fd30dc0e'; // string | machine account source ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | The JSONPatch payload used to update the object. + const result = await apiInstance.updateMachineAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1); + console.log(result); +- path: /sources/v1/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-password-policy-holders-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const passwordpolicyholdersdtoInnerV1: Array<PasswordpolicyholdersdtoInnerV1> = ; // Array | + const result = await apiInstance.updatePasswordPolicyHoldersV1(sourceId, passwordpolicyholdersdtoInnerV1); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-provisioning-policies-in-bulk-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const provisioningpolicydtoV1: Array<ProvisioningpolicydtoV1> = ; // Array | + const result = await apiInstance.updateProvisioningPoliciesInBulkV1(sourceId, provisioningpolicydtoV1); + console.log(result); +- path: /sources/v1/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-provisioning-policy-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const usageType: UsagetypeV1 = CREATE; // UsagetypeV1 | 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 four usage types for all your provisioning policy needs. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/fields/0","value":{"name":"email","transform":{"type":"identityAttribute","attributes":{"name":"email"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}}]; // Array | The JSONPatch payload used to update the schema. + const result = await apiInstance.updateProvisioningPolicyV1(sourceId, usageType, jsonpatchoperationV1); + console.log(result); +- path: /sources/v1/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-source-entitlement-request-config-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '8c190e6787aa4ed9a90bd9d5344523fb'; // string | The Source id (default to undefined) + const sourceentitlementrequestconfigV1: SourceentitlementrequestconfigV1 = {"accessRequestConfig":{"approvalSchemes":[]}}; // SourceentitlementrequestconfigV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.updateSourceEntitlementRequestConfigV1(id, sourceentitlementrequestconfigV1); + console.log(result); +- path: /sources/v1/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-source-schedule-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const scheduleType: string = 'ACCOUNT_AGGREGATION'; // 'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION' | The Schedule type. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/cronExpression","value":"0 0 6 * * ?"}]; // Array | The JSONPatch payload used to update the schedule. + const result = await apiInstance.updateSourceScheduleV1(sourceId, scheduleType, jsonpatchoperationV1); + console.log(result); +- path: /sources/v1/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-source-schema-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined) + const schemaId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Schema id. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/attributes/-","value":{"name":"location","type":"STRING","schema":null,"description":"Employee location","isMulti":false,"isEntitlement":false,"isGroup":false}}]; // Array | The JSONPatch payload used to update the schema. + const result = await apiInstance.updateSourceSchemaV1(sourceId, schemaId, jsonpatchoperationV1); + console.log(result); +- path: /sources/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sources/methods/sources#update-source-v1 + source: | + import { SourcesV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SourcesV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | Source ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"new description"}]; // Array | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + const result = await apiInstance.updateSourceV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/sources/docs/Methods/Index.md b/sdk-output/sources/docs/Methods/Index.md new file mode 100644 index 00000000..ca1242b7 --- /dev/null +++ b/sdk-output/sources/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: sources-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: sources-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'sources', 'methods'] +slug: /tools/sdk/typescript/sources/methods +tags: ['SDK', 'Software Development Kit', 'sources', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/sources/docs/Methods/SourcesV1Api.md b/sdk-output/sources/docs/Methods/SourcesV1Api.md new file mode 100644 index 00000000..afcbc091 --- /dev/null +++ b/sdk-output/sources/docs/Methods/SourcesV1Api.md @@ -0,0 +1,2528 @@ +--- +id: v1-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Sources', 'v1Sources'] +slug: /tools/sdk/typescript/sources/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'v1Sources'] +--- + +# SourcesV1Api + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/index.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/index.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/index.html) for more information about all the different things admins can do with sources once they are connected. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-provisioning-policy-v1**](#create-provisioning-policy-v1) | **POST** `/sources/v1/{sourceId}/provisioning-policies` | Create provisioning policy +[**create-source-schedule-v1**](#create-source-schedule-v1) | **POST** `/sources/v1/{sourceId}/schedules` | Create schedule on source +[**create-source-schema-v1**](#create-source-schema-v1) | **POST** `/sources/v1/{sourceId}/schemas` | Create schema on source +[**create-source-v1**](#create-source-v1) | **POST** `/sources/v1` | Creates a source in identitynow. +[**delete-accounts-async-v1**](#delete-accounts-async-v1) | **POST** `/sources/v1/{id}/remove-accounts` | Remove all accounts in source +[**delete-native-change-detection-config-v1**](#delete-native-change-detection-config-v1) | **DELETE** `/sources/v1/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**delete-provisioning-policy-v1**](#delete-provisioning-policy-v1) | **DELETE** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**delete-source-schedule-v1**](#delete-source-schedule-v1) | **DELETE** `/sources/v1/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type. +[**delete-source-schema-v1**](#delete-source-schema-v1) | **DELETE** `/sources/v1/{sourceId}/schemas/{schemaId}` | Delete source schema by id +[**delete-source-v1**](#delete-source-v1) | **DELETE** `/sources/v1/{id}` | Delete source by id +[**get-account-delete-approval-config-v1**](#get-account-delete-approval-config-v1) | **GET** `/sources/v1/{sourceId}/approval-config/account-delete` | Human Account Deletion Approval Config +[**get-accounts-schema-v1**](#get-accounts-schema-v1) | **GET** `/sources/v1/{id}/schemas/accounts` | Downloads source accounts schema template +[**get-correlation-config-v1**](#get-correlation-config-v1) | **GET** `/sources/v1/{id}/correlation-config` | Get source correlation configuration +[**get-entitlements-schema-v1**](#get-entitlements-schema-v1) | **GET** `/sources/v1/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**get-machine-account-deletion-approval-config-by-source-v1**](#get-machine-account-deletion-approval-config-by-source-v1) | **GET** `/sources/v1/{sourceId}/approval-config/machine-account-delete` | Machine Account Deletion Approval Config +[**get-native-change-detection-config-v1**](#get-native-change-detection-config-v1) | **GET** `/sources/v1/{sourceId}/native-change-detection-config` | Native change detection configuration +[**get-provisioning-policy-v1**](#get-provisioning-policy-v1) | **GET** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**get-source-attr-sync-config-v1**](#get-source-attr-sync-config-v1) | **GET** `/sources/v1/{id}/attribute-sync-config` | Attribute sync config +[**get-source-config-v1**](#get-source-config-v1) | **GET** `/sources/v1/{id}/connectors/source-config` | Gets source config with language-translations +[**get-source-connections-v1**](#get-source-connections-v1) | **GET** `/sources/v1/{sourceId}/connections` | Get source connections by id +[**get-source-entitlement-request-config-v1**](#get-source-entitlement-request-config-v1) | **GET** `/sources/v1/{id}/entitlement-request-config` | Get source entitlement request configuration +[**get-source-health-v1**](#get-source-health-v1) | **GET** `/sources/v1/{sourceId}/source-health` | Fetches source health by id +[**get-source-schedule-v1**](#get-source-schedule-v1) | **GET** `/sources/v1/{sourceId}/schedules/{scheduleType}` | Get source schedule by type +[**get-source-schedules-v1**](#get-source-schedules-v1) | **GET** `/sources/v1/{sourceId}/schedules` | List schedules on source +[**get-source-schema-v1**](#get-source-schema-v1) | **GET** `/sources/v1/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**get-source-schemas-v1**](#get-source-schemas-v1) | **GET** `/sources/v1/{sourceId}/schemas` | List schemas on source +[**get-source-v1**](#get-source-v1) | **GET** `/sources/v1/{id}` | Get source by id +[**import-accounts-schema-v1**](#import-accounts-schema-v1) | **POST** `/sources/v1/{id}/schemas/accounts` | Uploads source accounts schema template +[**import-accounts-v1**](#import-accounts-v1) | **POST** `/sources/v1/{id}/load-accounts` | Account aggregation +[**import-connector-file-v1**](#import-connector-file-v1) | **POST** `/sources/v1/{sourceId}/upload-connector-file` | Upload connector file to source +[**import-entitlements-schema-v1**](#import-entitlements-schema-v1) | **POST** `/sources/v1/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**import-entitlements-v1**](#import-entitlements-v1) | **POST** `/sources/v1/{sourceId}/load-entitlements` | Entitlement aggregation +[**import-uncorrelated-accounts-v1**](#import-uncorrelated-accounts-v1) | **POST** `/sources/v1/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**list-password-policy-holders-on-source-v1**](#list-password-policy-holders-on-source-v1) | **GET** `/sources/v1/{sourceId}/password-policies` | Get Password Policy for source +[**list-provisioning-policies-v1**](#list-provisioning-policies-v1) | **GET** `/sources/v1/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**list-sources-v1**](#list-sources-v1) | **GET** `/sources/v1` | Lists all sources in identitynow. +[**ping-cluster-v1**](#ping-cluster-v1) | **POST** `/sources/v1/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**put-correlation-config-v1**](#put-correlation-config-v1) | **PUT** `/sources/v1/{id}/correlation-config` | Update source correlation configuration +[**put-native-change-detection-config-v1**](#put-native-change-detection-config-v1) | **PUT** `/sources/v1/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**put-provisioning-policy-v1**](#put-provisioning-policy-v1) | **PUT** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**put-source-attr-sync-config-v1**](#put-source-attr-sync-config-v1) | **PUT** `/sources/v1/{id}/attribute-sync-config` | Update attribute sync config +[**put-source-schema-v1**](#put-source-schema-v1) | **PUT** `/sources/v1/{sourceId}/schemas/{schemaId}` | Update source schema (full) +[**put-source-v1**](#put-source-v1) | **PUT** `/sources/v1/{id}` | Update source (full) +[**search-resource-objects-v1**](#search-resource-objects-v1) | **POST** `/sources/v1/{sourceId}/connector/peek-resource-objects` | Peek source connector\'s resource objects +[**sync-attributes-for-source-v1**](#sync-attributes-for-source-v1) | **POST** `/sources/v1/{id}/synchronize-attributes` | Synchronize single source attributes. +[**test-source-configuration-v1**](#test-source-configuration-v1) | **POST** `/sources/v1/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**test-source-connection-v1**](#test-source-connection-v1) | **POST** `/sources/v1/{sourceId}/connector/check-connection` | Check connection for source connector. +[**update-account-deletion-approval-config-v1**](#update-account-deletion-approval-config-v1) | **PATCH** `/sources/v1/{sourceId}/approval-config/account-delete` | Human Account Deletion Approval Config +[**update-machine-account-deletion-approval-config-v1**](#update-machine-account-deletion-approval-config-v1) | **PATCH** `/sources/v1/{sourceId}/approval-config/machine-account-delete` | Machine Account Deletion Approval Config +[**update-password-policy-holders-v1**](#update-password-policy-holders-v1) | **PATCH** `/sources/v1/{sourceId}/password-policies` | Update password policy +[**update-provisioning-policies-in-bulk-v1**](#update-provisioning-policies-in-bulk-v1) | **POST** `/sources/v1/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**update-provisioning-policy-v1**](#update-provisioning-policy-v1) | **PATCH** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**update-source-entitlement-request-config-v1**](#update-source-entitlement-request-config-v1) | **PUT** `/sources/v1/{id}/entitlement-request-config` | Update source entitlement request configuration +[**update-source-schedule-v1**](#update-source-schedule-v1) | **PATCH** `/sources/v1/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial) +[**update-source-schema-v1**](#update-source-schema-v1) | **PATCH** `/sources/v1/{sourceId}/schemas/{schemaId}` | Update source schema (partial) +[**update-source-v1**](#update-source-v1) | **PATCH** `/sources/v1/{id}` | Update source (partial) + + +## create-provisioning-policy-v1 +Create provisioning policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-provisioning-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] +**provisioningpolicydtoV1** | **ProvisioningpolicydtoV1** | | + +### Return type + +**ProvisioningpolicydtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id +const provisioningpolicydtoV1: ProvisioningpolicydtoV1 = {"name":"Account","description":"Account Provisioning Policy","usageType":"CREATE","fields":[{"name":"displayName","transform":{"type":"identityAttribute","attributes":{"name":"displayName"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false},{"name":"distinguishedName","transform":{"type":"usernameGenerator","attributes":{"sourceCheck":true,"patterns":["CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn$ln${uniqueCounter},OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"],"fn":{"type":"identityAttribute","attributes":{"name":"firstname"}},"ln":{"type":"identityAttribute","attributes":{"name":"lastname"}},"fi":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":1}},"fti":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":2}}}},"attributes":{"cloudMaxUniqueChecks":"5","cloudMaxSize":"100","cloudRequired":"true"},"isRequired":false,"type":"","isMultiValued":false},{"name":"description","transform":{"type":"static","attributes":{"value":""}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}]}; // +const result = await apiInstance.createProvisioningPolicyV1(sourceId, provisioningpolicydtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-source-schedule-v1 +Create schedule on source +Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-source-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**schedule3V1** | **Schedule3V1** | | + +### Return type + +**Schedule3V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const schedule3V1: Schedule3V1 = ; // +const result = await apiInstance.createSourceScheduleV1(sourceId, schedule3V1); +console.log(result); +``` + +[[Back to top]](#) + +## create-source-schema-v1 +Create schema on source +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-source-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**schemaV1** | **SchemaV1** | | + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const schemaV1: SchemaV1 = ; // +const result = await apiInstance.createSourceSchemaV1(sourceId, schemaV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-source-v1 +Creates a source in identitynow. +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceV1** | **SourceV1** | | +**provisionAsCsv** | **boolean** | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. | [optional] [default to undefined] + +### Return type + +**SourceV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceV1: SourceV1 = ; // +const provisionAsCsv: boolean = false; // If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don\'t set this query parameter and you attempt to set the `type` attribute directly, the request won\'t correctly generate the source. (optional) +const result = await apiInstance.createSourceV1(sourceV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-accounts-async-v1 +Remove all accounts in source +Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-accounts-async-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The source id | [default to undefined] + +### Return type + +**TaskresultdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = ebbf35756e1140699ce52b233121384a; // The source id +const result = await apiInstance.deleteAccountsAsyncV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-native-change-detection-config-v1 +Delete native change detection configuration +Deletes the native change detection configuration for the source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-native-change-detection-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The source id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The source id +const result = await apiInstance.deleteNativeChangeDetectionConfigV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-provisioning-policy-v1 +Delete provisioning policy by usagetype +Deletes the provisioning policy with the specified usage on an application. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-provisioning-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source ID. | [default to undefined] +**usageType** | **UsagetypeV1** | 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 four usage types for all your provisioning policy needs. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID. +const usageType: UsagetypeV1 = CREATE; // 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 four usage types for all your provisioning policy needs. +const result = await apiInstance.deleteProvisioningPolicyV1(sourceId, usageType); +console.log(result); +``` + +[[Back to top]](#) + +## delete-source-schedule-v1 +Delete source schedule by type. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-source-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**scheduleType** | **'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'** | The Schedule type. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const scheduleType: string = ACCOUNT_AGGREGATION; // The Schedule type. +const result = await apiInstance.deleteSourceScheduleV1(sourceId, scheduleType); +console.log(result); +``` + +[[Back to top]](#) + +## delete-source-schema-v1 +Delete source schema by id + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-source-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**schemaId** | **string** | The Schema id. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const schemaId: string = 2c9180835d191a86015d28455b4a2329; // The Schema id. +const result = await apiInstance.deleteSourceSchemaV1(sourceId, schemaId); +console.log(result); +``` + +[[Back to top]](#) + +## delete-source-v1 +Delete source by id +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source ID. | [default to undefined] + +### Return type + +**DeleteSourceV1202ResponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const result = await apiInstance.deleteSourceV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-account-delete-approval-config-v1 +Human Account Deletion Approval Config +The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-account-delete-approval-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] + +### Return type + +**AccountdeleteconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = ha38f94347e94562b5bb8424a56498d8; // The Source id +const result = await apiInstance.getAccountDeleteApprovalConfigV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-accounts-schema-v1 +Downloads source accounts schema template +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-accounts-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const result = await apiInstance.getAccountsSchemaV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-correlation-config-v1 +Get source correlation configuration +This API returns the existing correlation configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-correlation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The source id | [default to undefined] + +### Return type + +**CorrelationconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // The source id +const result = await apiInstance.getCorrelationConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-entitlements-schema-v1 +Downloads source entitlements schema template +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-entitlements-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**schemaName** | **string** | Name of entitlement schema | [optional] [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const schemaName: string = ?schemaName=group; // Name of entitlement schema (optional) +const result = await apiInstance.getEntitlementsSchemaV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-machine-account-deletion-approval-config-by-source-v1 +Machine Account Deletion Approval Config +Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-machine-account-deletion-approval-config-by-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | source id. | [default to undefined] + +### Return type + +**AccountdeleteconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = gt38f94347e94562b5bb8424a56498d8; // source id. +const result = await apiInstance.getMachineAccountDeletionApprovalConfigBySourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-native-change-detection-config-v1 +Native change detection configuration +This API returns the existing native change detection configuration for a source specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-native-change-detection-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The source id | [default to undefined] + +### Return type + +**NativechangedetectionconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The source id +const result = await apiInstance.getNativeChangeDetectionConfigV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-provisioning-policy-v1 +Get provisioning policy by usagetype +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-provisioning-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source ID. | [default to undefined] +**usageType** | **UsagetypeV1** | 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 four usage types for all your provisioning policy needs. | [default to undefined] + +### Return type + +**ProvisioningpolicydtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID. +const usageType: UsagetypeV1 = CREATE; // 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 four usage types for all your provisioning policy needs. +const result = await apiInstance.getProvisioningPolicyV1(sourceId, usageType); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-attr-sync-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Attribute sync config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-attr-sync-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The source id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AttrsyncsourceconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // The source id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSourceAttrSyncConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-config-v1 +Gets source config with language-translations +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**locale** | **'de' | 'false' | 'fi' | 'sv' | 'ru' | 'pt' | 'ko' | 'zh-TW' | 'en' | 'it' | 'fr' | 'zh-CN' | 'hu' | 'es' | 'cs' | 'ja' | 'pl' | 'da' | 'nl'** | The locale to apply to the config. If no viable locale is given, it will default to \"en\" | [optional] [default to undefined] + +### Return type + +**ConnectordetailV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = cef3ee201db947c5912551015ba0c679; // The Source id +const locale: string = en; // The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) +const result = await apiInstance.getSourceConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-connections-v1 +Get source connections by id +Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-connections-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +**SourceconnectionsdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const result = await apiInstance.getSourceConnectionsV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-entitlement-request-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get source entitlement request configuration +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-entitlement-request-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourceentitlementrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getSourceEntitlementRequestConfigV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-health-v1 +Fetches source health by id +This endpoint fetches source health by source's id + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-health-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] + +### Return type + +**SourcehealthdtoV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const result = await apiInstance.getSourceHealthV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-schedule-v1 +Get source schedule by type +Get the source schedule by type in Identity Security Cloud (ISC). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**scheduleType** | **'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'** | The Schedule type. | [default to undefined] + +### Return type + +**Schedule3V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const scheduleType: string = ACCOUNT_AGGREGATION; // The Schedule type. +const result = await apiInstance.getSourceScheduleV1(sourceId, scheduleType); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-schedules-v1 +List schedules on source +Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). +:::info +This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**. + +For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**. + +**Days of the week are represented as 1-7 (Sunday-Saturday).** +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-schedules-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const result = await apiInstance.getSourceSchedulesV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-schema-v1 +Get source schema by id +Get the Source Schema by ID in IdentityNow. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**schemaId** | **string** | The Schema id. | [default to undefined] + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const schemaId: string = 2c9180835d191a86015d28455b4a2329; // The Schema id. +const result = await apiInstance.getSourceSchemaV1(sourceId, schemaId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-schemas-v1 +List schemas on source +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-schemas-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source ID. | [default to undefined] +**includeTypes** | **'group' | 'user'** | If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. | [optional] [default to undefined] +**includeNames** | **string** | A comma-separated list of schema names to filter result. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const includeTypes: string = group; // If set to \'group\', then the account schema is filtered and only group schemas are returned. Only a value of \'group\' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) +const includeNames: string = account; // A comma-separated list of schema names to filter result. (optional) +const result = await apiInstance.getSourceSchemasV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## get-source-v1 +Get source by id +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source ID. | [default to undefined] + +### Return type + +**SourceV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const result = await apiInstance.getSourceV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-accounts-schema-v1 +Uploads source accounts schema template +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-accounts-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**file** | **File** | | [optional] [default to undefined] + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const file: File = BINARY_DATA_HERE; // (optional) +const result = await apiInstance.importAccountsSchemaV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-accounts-v1 +Account aggregation +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-accounts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id | [default to undefined] +**file** | **File** | The CSV file containing the source accounts to aggregate. | [optional] [default to undefined] +**disableOptimization** | **string** | Use this flag to reprocess every account whether or not the data has changed. | [optional] [default to undefined] + +### Return type + +**LoadaccountstaskV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // Source Id +const file: File = BINARY_DATA_HERE; // The CSV file containing the source accounts to aggregate. (optional) +const disableOptimization: string = disableOptimization_example; // Use this flag to reprocess every account whether or not the data has changed. (optional) +const result = await apiInstance.importAccountsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-connector-file-v1 +Upload connector file to source +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-connector-file-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**file** | **File** | | [optional] [default to undefined] + +### Return type + +**SourceV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const file: File = BINARY_DATA_HERE; // (optional) +const result = await apiInstance.importConnectorFileV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## import-entitlements-schema-v1 +Uploads source entitlements schema template +This API uploads a source schema template file to configure a source's entitlement attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-entitlements-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**schemaName** | **string** | Name of entitlement schema | [optional] [default to undefined] +**file** | **File** | | [optional] [default to undefined] + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const schemaName: string = ?schemaName=group; // Name of entitlement schema (optional) +const file: File = BINARY_DATA_HERE; // (optional) +const result = await apiInstance.importEntitlementsSchemaV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-entitlements-v1 +Entitlement aggregation +Starts an entitlement aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-entitlements-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Source Id | [default to undefined] +**file** | **File** | The CSV file containing the source entitlements to aggregate. | [optional] [default to undefined] + +### Return type + +**LoadentitlementtaskV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = ef38f94347e94562b5bb8424a56397d8; // Source Id +const file: File = BINARY_DATA_HERE; // The CSV file containing the source entitlements to aggregate. (optional) +const result = await apiInstance.importEntitlementsV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## import-uncorrelated-accounts-v1 +Process uncorrelated accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-uncorrelated-accounts-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source Id | [default to undefined] +**file** | **File** | | [optional] [default to undefined] + +### Return type + +**LoaduncorrelatedaccountstaskV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 75dbec1ebe154d5785da27b95e1dd5d7; // Source Id +const file: File = BINARY_DATA_HERE; // (optional) +const result = await apiInstance.importUncorrelatedAccountsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-password-policy-holders-on-source-v1 +Get Password Policy for source +This API can be used to get Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-password-policy-holders-on-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listPasswordPolicyHoldersOnSourceV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## list-provisioning-policies-v1 +Lists provisioningpolicies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-provisioning-policies-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id +const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const result = await apiInstance.listProvisioningPoliciesV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## list-sources-v1 +Lists all sources in identitynow. +This end-point lists all the sources in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-sources-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** | [optional] [default to undefined] +**forSubadmin** | **string** | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. | [optional] [default to undefined] +**includeIDNSource** | **boolean** | Include the IdentityNow source in the response. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = name eq "Employees"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) +const forSubadmin: string = name; // Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) +const includeIDNSource: boolean = true; // Include the IdentityNow source in the response. (optional) +const result = await apiInstance.listSourcesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## ping-cluster-v1 +Ping cluster for source connector +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/ping-cluster-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the Source | [default to undefined] + +### Return type + +**StatusresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = cef3ee201db947c5912551015ba0c679; // The ID of the Source +const result = await apiInstance.pingClusterV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## put-correlation-config-v1 +Update source correlation configuration +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-correlation-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The source id | [default to undefined] +**correlationconfigV1** | **CorrelationconfigV1** | | + +### Return type + +**CorrelationconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // The source id +const correlationconfigV1: CorrelationconfigV1 = ; // +const result = await apiInstance.putCorrelationConfigV1(id, correlationconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-native-change-detection-config-v1 +Update native change detection configuration +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-native-change-detection-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The source id | [default to undefined] +**nativechangedetectionconfigV1** | **NativechangedetectionconfigV1** | | + +### Return type + +**NativechangedetectionconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The source id +const nativechangedetectionconfigV1: NativechangedetectionconfigV1 = ; // +const result = await apiInstance.putNativeChangeDetectionConfigV1(sourceId, nativechangedetectionconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-provisioning-policy-v1 +Update provisioning policy by usagetype +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-provisioning-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source ID. | [default to undefined] +**usageType** | **UsagetypeV1** | 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 four usage types for all your provisioning policy needs. | [default to undefined] +**provisioningpolicydtoV1** | **ProvisioningpolicydtoV1** | | + +### Return type + +**ProvisioningpolicydtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID. +const usageType: UsagetypeV1 = CREATE; // 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 four usage types for all your provisioning policy needs. +const provisioningpolicydtoV1: ProvisioningpolicydtoV1 = ; // +const result = await apiInstance.putProvisioningPolicyV1(sourceId, usageType, provisioningpolicydtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-source-attr-sync-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update attribute sync config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-source-attr-sync-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The source id | [default to undefined] +**attrsyncsourceconfigV1** | **AttrsyncsourceconfigV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**AttrsyncsourceconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // The source id +const attrsyncsourceconfigV1: AttrsyncsourceconfigV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.putSourceAttrSyncConfigV1(id, attrsyncsourceconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-source-schema-v1 +Update source schema (full) +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-source-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**schemaId** | **string** | The Schema id. | [default to undefined] +**schemaV1** | **SchemaV1** | | + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const schemaId: string = 2c9180835d191a86015d28455b4a2329; // The Schema id. +const schemaV1: SchemaV1 = ; // +const result = await apiInstance.putSourceSchemaV1(sourceId, schemaId, schemaV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-source-v1 +Update source (full) +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source ID. | [default to undefined] +**sourceV1** | **SourceV1** | | + +### Return type + +**SourceV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const sourceV1: SourceV1 = ; // +const result = await apiInstance.putSourceV1(id, sourceV1); +console.log(result); +``` + +[[Back to top]](#) + +## search-resource-objects-v1 +Peek source connector\'s resource objects +Retrieves a sample of data returned from account and group aggregation requests. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/search-resource-objects-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the Source | [default to undefined] +**resourceobjectsrequestV1** | **ResourceobjectsrequestV1** | | + +### Return type + +**ResourceobjectsresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = cef3ee201db947c5912551015ba0c679; // The ID of the Source +const resourceobjectsrequestV1: ResourceobjectsrequestV1 = ; // +const result = await apiInstance.searchResourceObjectsV1(sourceId, resourceobjectsrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## sync-attributes-for-source-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Synchronize single source attributes. +This end-point performs attribute synchronization for a selected source. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/sync-attributes-for-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourcesyncjobV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = id_example; // The Source id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.syncAttributesForSourceV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## test-source-configuration-v1 +Test configuration for source connector +This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-source-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the Source | [default to undefined] + +### Return type + +**StatusresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = cef3ee201db947c5912551015ba0c679; // The ID of the Source +const result = await apiInstance.testSourceConfigurationV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## test-source-connection-v1 +Check connection for source connector. +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-source-connection-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The ID of the Source. | [default to undefined] + +### Return type + +**StatusresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = cef3ee201db947c5912551015ba0c679; // The ID of the Source. +const result = await apiInstance.testSourceConnectionV1(sourceId); +console.log(result); +``` + +[[Back to top]](#) + +## update-account-deletion-approval-config-v1 +Human Account Deletion Approval Config +Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-account-deletion-approval-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | Human account source ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the object. | + +### Return type + +**AccountdeleteconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 00eebcf881994e419d72e757fd30dc0e; // Human account source ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // The JSONPatch payload used to update the object. +const result = await apiInstance.updateAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-machine-account-deletion-approval-config-v1 +Machine Account Deletion Approval Config +Use this endpoint to update the machine account deletion approval configuration for a specific source. +The update is performed using a JSON Patch payload, which allows partial modifications to the approval config. +This operation is typically used to change approval requirements, approvers, or comments settings for machine account deletion. +The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-machine-account-deletion-approval-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | machine account source ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the object. | + +### Return type + +**AccountdeleteconfigdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 00eebcf881994e419d72e757fd30dc0e; // machine account source ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // The JSONPatch payload used to update the object. +const result = await apiInstance.updateMachineAccountDeletionApprovalConfigV1(sourceId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-password-policy-holders-v1 +Update password policy +This API can be used to set up or update Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-password-policy-holders-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id | [default to undefined] +**passwordpolicyholdersdtoInnerV1** | **Array<PasswordpolicyholdersdtoInnerV1>** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const passwordpolicyholdersdtoInnerV1: Array<PasswordpolicyholdersdtoInnerV1> = ; // +const result = await apiInstance.updatePasswordPolicyHoldersV1(sourceId, passwordpolicyholdersdtoInnerV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-provisioning-policies-in-bulk-v1 +Bulk update provisioning policies +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-provisioning-policies-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**provisioningpolicydtoV1** | **Array<ProvisioningpolicydtoV1>** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const provisioningpolicydtoV1: Array<ProvisioningpolicydtoV1> = ; // +const result = await apiInstance.updateProvisioningPoliciesInBulkV1(sourceId, provisioningpolicydtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-provisioning-policy-v1 +Partial update of provisioning policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-provisioning-policy-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**usageType** | **UsagetypeV1** | 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 four usage types for all your provisioning policy needs. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the schema. | + +### Return type + +**ProvisioningpolicydtoV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const usageType: UsagetypeV1 = CREATE; // 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 four usage types for all your provisioning policy needs. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/fields/0","value":{"name":"email","transform":{"type":"identityAttribute","attributes":{"name":"email"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}}]; // The JSONPatch payload used to update the schema. +const result = await apiInstance.updateProvisioningPolicyV1(sourceId, usageType, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-source-entitlement-request-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update source entitlement request configuration +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-source-entitlement-request-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The Source id | [default to undefined] +**sourceentitlementrequestconfigV1** | **SourceentitlementrequestconfigV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**SourceentitlementrequestconfigV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 8c190e6787aa4ed9a90bd9d5344523fb; // The Source id +const sourceentitlementrequestconfigV1: SourceentitlementrequestconfigV1 = {"accessRequestConfig":{"approvalSchemes":[]}}; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.updateSourceEntitlementRequestConfigV1(id, sourceentitlementrequestconfigV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-source-schedule-v1 +Update source schedule (partial) +Use this API to selectively update an existing Schedule using a JSONPatch payload. + +The following schedule fields are immutable and cannot be updated: + +- type + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-source-schedule-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**scheduleType** | **'ACCOUNT_AGGREGATION' | 'GROUP_AGGREGATION'** | The Schedule type. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the schedule. | + +### Return type + +**Schedule3V1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const scheduleType: string = ACCOUNT_AGGREGATION; // The Schedule type. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/cronExpression","value":"0 0 6 * * ?"}]; // The JSONPatch payload used to update the schedule. +const result = await apiInstance.updateSourceScheduleV1(sourceId, scheduleType, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-source-schema-v1 +Update source schema (partial) +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-source-schema-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sourceId** | **string** | The Source id. | [default to undefined] +**schemaId** | **string** | The Schema id. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the schema. | + +### Return type + +**SchemaV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id. +const schemaId: string = 2c9180835d191a86015d28455b4a2329; // The Schema id. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"add","path":"/attributes/-","value":{"name":"location","type":"STRING","schema":null,"description":"Employee location","isMulti":false,"isEntitlement":false,"isGroup":false}}]; // The JSONPatch payload used to update the schema. +const result = await apiInstance.updateSourceSchemaV1(sourceId, schemaId, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-source-v1 +Update source (partial) +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-source-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Source ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). | + +### Return type + +**SourceV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SourcesV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SourcesV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // Source ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/description","value":"new description"}]; // A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). +const result = await apiInstance.updateSourceV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/sources/docs/Models/Accountdeleteconfigdto.md b/sdk-output/sources/docs/Models/Accountdeleteconfigdto.md new file mode 100644 index 00000000..5b52b138 --- /dev/null +++ b/sdk-output/sources/docs/Models/Accountdeleteconfigdto.md @@ -0,0 +1,20 @@ +--- +id: v1-accountdeleteconfigdto-v1 +title: AccountdeleteconfigdtoV1 +pagination_label: AccountdeleteconfigdtoV1 +sidebar_label: AccountdeleteconfigdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountdeleteconfigdtoV1', 'v1AccountdeleteconfigdtoV1'] +slug: /tools/sdk/typescript/sources/models/accountdeleteconfigdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccountdeleteconfigdtoV1', 'v1AccountdeleteconfigdtoV1'] +--- + +# AccountdeleteconfigdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalRequired** | **(optional)** **boolean** | Specifies if an account deletion request requires approval. | [default to false] +**approvalConfig** | **(optional)** **ApprovalconfigV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Approvalconfig.md b/sdk-output/sources/docs/Models/Approvalconfig.md new file mode 100644 index 00000000..6c8f1975 --- /dev/null +++ b/sdk-output/sources/docs/Models/Approvalconfig.md @@ -0,0 +1,28 @@ +--- +id: v1-approvalconfig-v1 +title: ApprovalconfigV1 +pagination_label: ApprovalconfigV1 +sidebar_label: ApprovalconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigV1', 'v1ApprovalconfigV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigV1', 'v1ApprovalconfigV1'] +--- + +# ApprovalconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reminderConfig** | **(optional)** **ApprovalconfigReminderConfigV1** | | [default to undefined] +**escalationConfig** | **(optional)** **ApprovalconfigEscalationConfigV1** | | [default to undefined] +**timeoutConfig** | **(optional)** **ApprovalconfigTimeoutConfigV1** | | [default to undefined] +**cronTimezone** | **(optional)** **ApprovalconfigCronTimezoneV1** | | [default to undefined] +**serialChain** | **(optional)** **Array<ApprovalconfigSerialChainInnerV1>** | If the approval request has an approvalCriteria of SERIAL this chain will be used to determine the assignment order. | [default to undefined] +**requiresComment** | **(optional)** **string** | Determines whether a comment is required when approving or rejecting the approval request. | [default to undefined] +**fallbackApprover** | **(optional)** **ApprovalconfigFallbackApproverV1** | | [default to undefined] +**machineIdentityManagerAssignment** | **(optional)** **string** | Specifies how to treat the identity type \"MANAGER_OF\" when the requestee is a machine identity. | [default to MachineIdentityManagerAssignmentV1_ManagerOfRequester] +**circumventApprovalProcess** | **(optional)** **boolean** | When true, all approvals will be created with the status \"PASSED\". | [default to false] +**autoApprove** | **(optional)** **string** | OFF will prevent the approval request from being assigned to the requester or requestee by assigning it to their manager instead. DIRECT will cause approval requests to be auto-approved when assigned directly and only to the requester. INDIRECT will auto-approve when the requester appears anywhere in the list of approvers, including in a governance group. This field will only be effective if requestedTarget.reauthRequired is set to false, otherwise the approval will have to be manually approved. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigCronTimezone.md b/sdk-output/sources/docs/Models/ApprovalconfigCronTimezone.md new file mode 100644 index 00000000..1435b337 --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigCronTimezone.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalconfig-cron-timezone-v1 +title: ApprovalconfigCronTimezoneV1 +pagination_label: ApprovalconfigCronTimezoneV1 +sidebar_label: ApprovalconfigCronTimezoneV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigCronTimezoneV1', 'v1ApprovalconfigCronTimezoneV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-cron-timezone-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigCronTimezoneV1', 'v1ApprovalconfigCronTimezoneV1'] +--- + +# ApprovalconfigCronTimezoneV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location** | **(optional)** **string** | Timezone location for cron schedules. | [default to undefined] +**offset** | **(optional)** **string** | Timezone offset for cron schedules. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfig.md b/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfig.md new file mode 100644 index 00000000..4f854bb0 --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfig.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalconfig-escalation-config-v1 +title: ApprovalconfigEscalationConfigV1 +pagination_label: ApprovalconfigEscalationConfigV1 +sidebar_label: ApprovalconfigEscalationConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigEscalationConfigV1', 'v1ApprovalconfigEscalationConfigV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-escalation-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigEscalationConfigV1', 'v1ApprovalconfigEscalationConfigV1'] +--- + +# ApprovalconfigEscalationConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if escalations are enabled. | [default to false] +**daysUntilFirstEscalation** | **(optional)** **number** | Number of days until the first escalation. | [default to undefined] +**escalationCronSchedule** | **(optional)** **string** | Cron schedule for escalations. | [default to undefined] +**escalationChain** | **(optional)** **Array<ApprovalconfigEscalationConfigEscalationChainInnerV1>** | Escalation chain configuration. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md b/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md new file mode 100644 index 00000000..b374dccc --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigEscalationConfigEscalationChainInner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-escalation-config-escalation-chain-inner-v1 +title: ApprovalconfigEscalationConfigEscalationChainInnerV1 +pagination_label: ApprovalconfigEscalationConfigEscalationChainInnerV1 +sidebar_label: ApprovalconfigEscalationConfigEscalationChainInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigEscalationConfigEscalationChainInnerV1', 'v1ApprovalconfigEscalationConfigEscalationChainInnerV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-escalation-config-escalation-chain-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigEscalationConfigEscalationChainInnerV1', 'v1ApprovalconfigEscalationConfigEscalationChainInnerV1'] +--- + +# ApprovalconfigEscalationConfigEscalationChainInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier** | **(optional)** **number** | Starting at 1 defines the order in which the identities will get assigned | [default to undefined] +**identityId** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'identityType\' field. | [default to undefined] +**identityType** | **(optional)** **string** | Type of identityId in the escalation chain. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigFallbackApprover.md b/sdk-output/sources/docs/Models/ApprovalconfigFallbackApprover.md new file mode 100644 index 00000000..25d4a375 --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigFallbackApprover.md @@ -0,0 +1,20 @@ +--- +id: v1-approvalconfig-fallback-approver-v1 +title: ApprovalconfigFallbackApproverV1 +pagination_label: ApprovalconfigFallbackApproverV1 +sidebar_label: ApprovalconfigFallbackApproverV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigFallbackApproverV1', 'v1ApprovalconfigFallbackApproverV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-fallback-approver-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigFallbackApproverV1', 'v1ApprovalconfigFallbackApproverV1'] +--- + +# ApprovalconfigFallbackApproverV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityID** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'type\' field. | [default to undefined] +**type** | **(optional)** **string** | Type of identityID for the fallback approver. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigReminderConfig.md b/sdk-output/sources/docs/Models/ApprovalconfigReminderConfig.md new file mode 100644 index 00000000..b66805af --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigReminderConfig.md @@ -0,0 +1,22 @@ +--- +id: v1-approvalconfig-reminder-config-v1 +title: ApprovalconfigReminderConfigV1 +pagination_label: ApprovalconfigReminderConfigV1 +sidebar_label: ApprovalconfigReminderConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigReminderConfigV1', 'v1ApprovalconfigReminderConfigV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-reminder-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigReminderConfigV1', 'v1ApprovalconfigReminderConfigV1'] +--- + +# ApprovalconfigReminderConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if reminders are enabled. | [default to false] +**daysUntilFirstReminder** | **(optional)** **number** | Number of days until the first reminder. | [default to undefined] +**reminderCronSchedule** | **(optional)** **string** | Cron schedule for reminders. | [default to undefined] +**maxReminders** | **(optional)** **number** | Maximum number of reminders. Max is 20. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigSerialChainInner.md b/sdk-output/sources/docs/Models/ApprovalconfigSerialChainInner.md new file mode 100644 index 00000000..d9283184 --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigSerialChainInner.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-serial-chain-inner-v1 +title: ApprovalconfigSerialChainInnerV1 +pagination_label: ApprovalconfigSerialChainInnerV1 +sidebar_label: ApprovalconfigSerialChainInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigSerialChainInnerV1', 'v1ApprovalconfigSerialChainInnerV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-serial-chain-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigSerialChainInnerV1', 'v1ApprovalconfigSerialChainInnerV1'] +--- + +# ApprovalconfigSerialChainInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tier** | **(optional)** **number** | Starting at 1 defines the order in which the identities will get assigned | [default to undefined] +**identityId** | **(optional)** **string** | Optional Identity ID of the type of identity defined in the \'identityType\' field. | [default to undefined] +**identityType** | **(optional)** **string** | Type of identityId in the serial chain. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ApprovalconfigTimeoutConfig.md b/sdk-output/sources/docs/Models/ApprovalconfigTimeoutConfig.md new file mode 100644 index 00000000..13ceeaf1 --- /dev/null +++ b/sdk-output/sources/docs/Models/ApprovalconfigTimeoutConfig.md @@ -0,0 +1,21 @@ +--- +id: v1-approvalconfig-timeout-config-v1 +title: ApprovalconfigTimeoutConfigV1 +pagination_label: ApprovalconfigTimeoutConfigV1 +sidebar_label: ApprovalconfigTimeoutConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalconfigTimeoutConfigV1', 'v1ApprovalconfigTimeoutConfigV1'] +slug: /tools/sdk/typescript/sources/models/approvalconfig-timeout-config-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalconfigTimeoutConfigV1', 'v1ApprovalconfigTimeoutConfigV1'] +--- + +# ApprovalconfigTimeoutConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Indicates if timeout is enabled. | [default to false] +**daysUntilTimeout** | **(optional)** **number** | Number of days until approval request times out. Max value is 90. | [default to undefined] +**timeoutResult** | **(optional)** **string** | Result of timeout. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ArrayInner.md b/sdk-output/sources/docs/Models/ArrayInner.md new file mode 100644 index 00000000..6e869858 --- /dev/null +++ b/sdk-output/sources/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/sources/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sources/docs/Models/Attributedefinition.md b/sdk-output/sources/docs/Models/Attributedefinition.md new file mode 100644 index 00000000..fb908f9e --- /dev/null +++ b/sdk-output/sources/docs/Models/Attributedefinition.md @@ -0,0 +1,26 @@ +--- +id: v1-attributedefinition-v1 +title: AttributedefinitionV1 +pagination_label: AttributedefinitionV1 +sidebar_label: AttributedefinitionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedefinitionV1', 'v1AttributedefinitionV1'] +slug: /tools/sdk/typescript/sources/models/attributedefinition-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedefinitionV1', 'v1AttributedefinitionV1'] +--- + +# AttributedefinitionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the attribute. | [default to undefined] +**nativeName** | **(optional)** **string** | Attribute name in the native system. | [default to undefined] +**type** | **(optional)** **AttributedefinitiontypeV1** | | [default to undefined] +**schema** | **(optional)** **AttributedefinitionSchemaV1** | | [default to undefined] +**description** | **(optional)** **string** | A human-readable description of the attribute. | [default to undefined] +**isMulti** | **(optional)** **boolean** | Flag indicating whether or not the attribute is multi-valued. | [default to false] +**isEntitlement** | **(optional)** **boolean** | Flag indicating whether or not the attribute is an entitlement. | [default to false] +**isGroup** | **(optional)** **boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [default to false] + diff --git a/sdk-output/sources/docs/Models/AttributedefinitionSchema.md b/sdk-output/sources/docs/Models/AttributedefinitionSchema.md new file mode 100644 index 00000000..c424da0d --- /dev/null +++ b/sdk-output/sources/docs/Models/AttributedefinitionSchema.md @@ -0,0 +1,21 @@ +--- +id: v1-attributedefinition-schema-v1 +title: AttributedefinitionSchemaV1 +pagination_label: AttributedefinitionSchemaV1 +sidebar_label: AttributedefinitionSchemaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedefinitionSchemaV1', 'v1AttributedefinitionSchemaV1'] +slug: /tools/sdk/typescript/sources/models/attributedefinition-schema-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedefinitionSchemaV1', 'v1AttributedefinitionSchemaV1'] +--- + +# AttributedefinitionSchemaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object being referenced | [default to undefined] +**id** | **(optional)** **string** | The object ID this reference applies to. | [default to undefined] +**name** | **(optional)** **string** | The human-readable display name of the object. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Attributedefinitiontype.md b/sdk-output/sources/docs/Models/Attributedefinitiontype.md new file mode 100644 index 00000000..b7c3f8f6 --- /dev/null +++ b/sdk-output/sources/docs/Models/Attributedefinitiontype.md @@ -0,0 +1,27 @@ +--- +id: v1-attributedefinitiontype-v1 +title: AttributedefinitiontypeV1 +pagination_label: AttributedefinitiontypeV1 +sidebar_label: AttributedefinitiontypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttributedefinitiontypeV1', 'v1AttributedefinitiontypeV1'] +slug: /tools/sdk/typescript/sources/models/attributedefinitiontype-v1 +tags: ['SDK', 'Software Development Kit', 'AttributedefinitiontypeV1', 'v1AttributedefinitiontypeV1'] +--- + +# AttributedefinitiontypeV1 + +## Enum + + +* `String` (value: `'STRING'`) + +* `Long` (value: `'LONG'`) + +* `Int` (value: `'INT'`) + +* `Boolean` (value: `'BOOLEAN'`) + +* `Date` (value: `'DATE'`) + + diff --git a/sdk-output/sources/docs/Models/Attrsyncsource.md b/sdk-output/sources/docs/Models/Attrsyncsource.md new file mode 100644 index 00000000..56327ab2 --- /dev/null +++ b/sdk-output/sources/docs/Models/Attrsyncsource.md @@ -0,0 +1,21 @@ +--- +id: v1-attrsyncsource-v1 +title: AttrsyncsourceV1 +pagination_label: AttrsyncsourceV1 +sidebar_label: AttrsyncsourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttrsyncsourceV1', 'v1AttrsyncsourceV1'] +slug: /tools/sdk/typescript/sources/models/attrsyncsource-v1 +tags: ['SDK', 'Software Development Kit', 'AttrsyncsourceV1', 'v1AttrsyncsourceV1'] +--- + +# AttrsyncsourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of target source for attribute synchronization. | [default to undefined] +**id** | **(optional)** **string** | ID of target source for attribute synchronization. | [default to undefined] +**name** | **(optional)** **string** | Human-readable name of target source for attribute synchronization. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Attrsyncsourceattributeconfig.md b/sdk-output/sources/docs/Models/Attrsyncsourceattributeconfig.md new file mode 100644 index 00000000..e436f41f --- /dev/null +++ b/sdk-output/sources/docs/Models/Attrsyncsourceattributeconfig.md @@ -0,0 +1,22 @@ +--- +id: v1-attrsyncsourceattributeconfig-v1 +title: AttrsyncsourceattributeconfigV1 +pagination_label: AttrsyncsourceattributeconfigV1 +sidebar_label: AttrsyncsourceattributeconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttrsyncsourceattributeconfigV1', 'v1AttrsyncsourceattributeconfigV1'] +slug: /tools/sdk/typescript/sources/models/attrsyncsourceattributeconfig-v1 +tags: ['SDK', 'Software Development Kit', 'AttrsyncsourceattributeconfigV1', 'v1AttrsyncsourceattributeconfigV1'] +--- + +# AttrsyncsourceattributeconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Name of the identity attribute | [default to undefined] +**displayName** | **string** | Display name of the identity attribute | [default to undefined] +**enabled** | **boolean** | Determines whether or not the attribute is enabled for synchronization | [default to undefined] +**target** | **string** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Attrsyncsourceconfig.md b/sdk-output/sources/docs/Models/Attrsyncsourceconfig.md new file mode 100644 index 00000000..bc86b991 --- /dev/null +++ b/sdk-output/sources/docs/Models/Attrsyncsourceconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-attrsyncsourceconfig-v1 +title: AttrsyncsourceconfigV1 +pagination_label: AttrsyncsourceconfigV1 +sidebar_label: AttrsyncsourceconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AttrsyncsourceconfigV1', 'v1AttrsyncsourceconfigV1'] +slug: /tools/sdk/typescript/sources/models/attrsyncsourceconfig-v1 +tags: ['SDK', 'Software Development Kit', 'AttrsyncsourceconfigV1', 'v1AttrsyncsourceconfigV1'] +--- + +# AttrsyncsourceconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **AttrsyncsourceV1** | | [default to undefined] +**attributes** | **Array<AttrsyncsourceattributeconfigV1>** | Attribute synchronization configuration for specific identity attributes in the context of a source | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Basereferencedto.md b/sdk-output/sources/docs/Models/Basereferencedto.md new file mode 100644 index 00000000..636aefed --- /dev/null +++ b/sdk-output/sources/docs/Models/Basereferencedto.md @@ -0,0 +1,21 @@ +--- +id: v1-basereferencedto-v1 +title: BasereferencedtoV1 +pagination_label: BasereferencedtoV1 +sidebar_label: BasereferencedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +slug: /tools/sdk/typescript/sources/models/basereferencedto-v1 +tags: ['SDK', 'Software Development Kit', 'BasereferencedtoV1', 'v1BasereferencedtoV1'] +--- + +# BasereferencedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **DtotypeV1** | | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Connectordetail.md b/sdk-output/sources/docs/Models/Connectordetail.md new file mode 100644 index 00000000..2d2d1757 --- /dev/null +++ b/sdk-output/sources/docs/Models/Connectordetail.md @@ -0,0 +1,34 @@ +--- +id: v1-connectordetail-v1 +title: ConnectordetailV1 +pagination_label: ConnectordetailV1 +sidebar_label: ConnectordetailV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConnectordetailV1', 'v1ConnectordetailV1'] +slug: /tools/sdk/typescript/sources/models/connectordetail-v1 +tags: ['SDK', 'Software Development Kit', 'ConnectordetailV1', 'v1ConnectordetailV1'] +--- + +# ConnectordetailV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The connector name | [default to undefined] +**type** | **(optional)** **string** | The connector type | [default to undefined] +**className** | **(optional)** **string** | The connector class name | [default to undefined] +**scriptName** | **(optional)** **string** | The connector script name | [default to undefined] +**applicationXml** | **(optional)** **string** | The connector application xml | [default to undefined] +**correlationConfigXml** | **(optional)** **string** | The connector correlation config xml | [default to undefined] +**sourceConfigXml** | **(optional)** **string** | The connector source config xml | [default to undefined] +**sourceConfig** | **(optional)** **string** | The connector source config | [default to undefined] +**sourceConfigFrom** | **(optional)** **string** | The connector source config origin | [default to undefined] +**s3Location** | **(optional)** **string** | storage path key for this connector | [default to undefined] +**uploadedFiles** | **(optional)** **Array<string>** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [default to undefined] +**fileUpload** | **(optional)** **boolean** | true if the source is file upload | [default to false] +**directConnect** | **(optional)** **boolean** | true if the source is a direct connect source | [default to false] +**translationProperties** | **(optional)** | A map containing translation attributes by loacale key | [default to undefined] +**connectorMetadata** | **(optional)** | A map containing metadata pertinent to the UI to be used | [default to undefined] +**status** | **(optional)** **string** | The connector status | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Correlationconfig.md b/sdk-output/sources/docs/Models/Correlationconfig.md new file mode 100644 index 00000000..173ea4ba --- /dev/null +++ b/sdk-output/sources/docs/Models/Correlationconfig.md @@ -0,0 +1,21 @@ +--- +id: v1-correlationconfig-v1 +title: CorrelationconfigV1 +pagination_label: CorrelationconfigV1 +sidebar_label: CorrelationconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CorrelationconfigV1', 'v1CorrelationconfigV1'] +slug: /tools/sdk/typescript/sources/models/correlationconfig-v1 +tags: ['SDK', 'Software Development Kit', 'CorrelationconfigV1', 'v1CorrelationconfigV1'] +--- + +# CorrelationconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the correlation configuration. | [default to undefined] +**name** | **(optional)** **string** | The name of the correlation configuration. | [default to undefined] +**attributeAssignments** | **(optional)** **Array<CorrelationconfigAttributeAssignmentsInnerV1>** | The list of attribute assignments of the correlation configuration. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/CorrelationconfigAttributeAssignmentsInner.md b/sdk-output/sources/docs/Models/CorrelationconfigAttributeAssignmentsInner.md new file mode 100644 index 00000000..3584c0c4 --- /dev/null +++ b/sdk-output/sources/docs/Models/CorrelationconfigAttributeAssignmentsInner.md @@ -0,0 +1,25 @@ +--- +id: v1-correlationconfig-attribute-assignments-inner-v1 +title: CorrelationconfigAttributeAssignmentsInnerV1 +pagination_label: CorrelationconfigAttributeAssignmentsInnerV1 +sidebar_label: CorrelationconfigAttributeAssignmentsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CorrelationconfigAttributeAssignmentsInnerV1', 'v1CorrelationconfigAttributeAssignmentsInnerV1'] +slug: /tools/sdk/typescript/sources/models/correlationconfig-attribute-assignments-inner-v1 +tags: ['SDK', 'Software Development Kit', 'CorrelationconfigAttributeAssignmentsInnerV1', 'v1CorrelationconfigAttributeAssignmentsInnerV1'] +--- + +# CorrelationconfigAttributeAssignmentsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**property** | **(optional)** **string** | The property of the attribute assignment. | [default to undefined] +**value** | **(optional)** **string** | The value of the attribute assignment. | [default to undefined] +**operation** | **(optional)** **string** | The operation of the attribute assignment. | [default to undefined] +**complex** | **(optional)** **boolean** | Whether or not the it\'s a complex attribute assignment. | [default to false] +**ignoreCase** | **(optional)** **boolean** | Whether or not the attribute assignment should ignore case. | [default to false] +**matchMode** | **(optional)** **string** | The match mode of the attribute assignment. | [default to undefined] +**filterString** | **(optional)** **string** | The filter string of the attribute assignment. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/DeleteSourceV1202Response.md b/sdk-output/sources/docs/Models/DeleteSourceV1202Response.md new file mode 100644 index 00000000..2f0109d8 --- /dev/null +++ b/sdk-output/sources/docs/Models/DeleteSourceV1202Response.md @@ -0,0 +1,21 @@ +--- +id: v1-delete-source-v1202-response-v1 +title: DeleteSourceV1202ResponseV1 +pagination_label: DeleteSourceV1202ResponseV1 +sidebar_label: DeleteSourceV1202ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DeleteSourceV1202ResponseV1', 'v1DeleteSourceV1202ResponseV1'] +slug: /tools/sdk/typescript/sources/models/delete-source-v1202-response-v1 +tags: ['SDK', 'Software Development Kit', 'DeleteSourceV1202ResponseV1', 'v1DeleteSourceV1202ResponseV1'] +--- + +# DeleteSourceV1202ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Task result ID. | [default to undefined] +**name** | **(optional)** **string** | Task result\'s human-readable display name (this should be null/empty). | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Dependantappconnections.md b/sdk-output/sources/docs/Models/Dependantappconnections.md new file mode 100644 index 00000000..82810c74 --- /dev/null +++ b/sdk-output/sources/docs/Models/Dependantappconnections.md @@ -0,0 +1,27 @@ +--- +id: v1-dependantappconnections-v1 +title: DependantappconnectionsV1 +pagination_label: DependantappconnectionsV1 +sidebar_label: DependantappconnectionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DependantappconnectionsV1', 'v1DependantappconnectionsV1'] +slug: /tools/sdk/typescript/sources/models/dependantappconnections-v1 +tags: ['SDK', 'Software Development Kit', 'DependantappconnectionsV1', 'v1DependantappconnectionsV1'] +--- + +# DependantappconnectionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cloudAppId** | **(optional)** **string** | Id of the connected Application | [default to undefined] +**description** | **(optional)** **string** | Description of the connected Application | [default to undefined] +**enabled** | **(optional)** **boolean** | Is the Application enabled | [default to true] +**provisionRequestEnabled** | **(optional)** **boolean** | Is Provisioning enabled for connected Application | [default to true] +**accountSource** | **(optional)** **DependantappconnectionsAccountSourceV1** | | [default to undefined] +**launcherCount** | **(optional)** **number** | The amount of launchers for connected Application (long type) | [default to undefined] +**matchAllAccount** | **(optional)** **boolean** | Is Provisioning enabled for connected Application | [default to false] +**owner** | **(optional)** **Array<BasereferencedtoV1>** | The owner of the connected Application | [default to undefined] +**appCenterEnabled** | **(optional)** **boolean** | Is App Center enabled for connected Application | [default to false] + diff --git a/sdk-output/sources/docs/Models/DependantappconnectionsAccountSource.md b/sdk-output/sources/docs/Models/DependantappconnectionsAccountSource.md new file mode 100644 index 00000000..979c8333 --- /dev/null +++ b/sdk-output/sources/docs/Models/DependantappconnectionsAccountSource.md @@ -0,0 +1,20 @@ +--- +id: v1-dependantappconnections-account-source-v1 +title: DependantappconnectionsAccountSourceV1 +pagination_label: DependantappconnectionsAccountSourceV1 +sidebar_label: DependantappconnectionsAccountSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DependantappconnectionsAccountSourceV1', 'v1DependantappconnectionsAccountSourceV1'] +slug: /tools/sdk/typescript/sources/models/dependantappconnections-account-source-v1 +tags: ['SDK', 'Software Development Kit', 'DependantappconnectionsAccountSourceV1', 'v1DependantappconnectionsAccountSourceV1'] +--- + +# DependantappconnectionsAccountSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**useForPasswordManagement** | **(optional)** **boolean** | Use this Account Source for password management | [default to false] +**passwordPolicies** | **(optional)** **Array<DependantappconnectionsAccountSourcePasswordPoliciesInnerV1>** | A list of Password Policies for this Account Source | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/DependantappconnectionsAccountSourcePasswordPoliciesInner.md b/sdk-output/sources/docs/Models/DependantappconnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 00000000..3e9727cd --- /dev/null +++ b/sdk-output/sources/docs/Models/DependantappconnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-dependantappconnections-account-source-password-policies-inner-v1 +title: DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 +pagination_label: DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 +sidebar_label: DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DependantappconnectionsAccountSourcePasswordPoliciesInnerV1', 'v1DependantappconnectionsAccountSourcePasswordPoliciesInnerV1'] +slug: /tools/sdk/typescript/sources/models/dependantappconnections-account-source-password-policies-inner-v1 +tags: ['SDK', 'Software Development Kit', 'DependantappconnectionsAccountSourcePasswordPoliciesInnerV1', 'v1DependantappconnectionsAccountSourcePasswordPoliciesInnerV1'] +--- + +# DependantappconnectionsAccountSourcePasswordPoliciesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type | [default to undefined] +**id** | **(optional)** **string** | ID of the object to which this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Dependantconnectionsmissingdto.md b/sdk-output/sources/docs/Models/Dependantconnectionsmissingdto.md new file mode 100644 index 00000000..a3e5cc2a --- /dev/null +++ b/sdk-output/sources/docs/Models/Dependantconnectionsmissingdto.md @@ -0,0 +1,20 @@ +--- +id: v1-dependantconnectionsmissingdto-v1 +title: DependantconnectionsmissingdtoV1 +pagination_label: DependantconnectionsmissingdtoV1 +sidebar_label: DependantconnectionsmissingdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DependantconnectionsmissingdtoV1', 'v1DependantconnectionsmissingdtoV1'] +slug: /tools/sdk/typescript/sources/models/dependantconnectionsmissingdto-v1 +tags: ['SDK', 'Software Development Kit', 'DependantconnectionsmissingdtoV1', 'v1DependantconnectionsmissingdtoV1'] +--- + +# DependantconnectionsmissingdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dependencyType** | **(optional)** **string** | The type of dependency type that is missing in the SourceConnections | [default to undefined] +**reason** | **(optional)** **string** | The reason why this dependency is missing | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Dtotype.md b/sdk-output/sources/docs/Models/Dtotype.md new file mode 100644 index 00000000..7a37c984 --- /dev/null +++ b/sdk-output/sources/docs/Models/Dtotype.md @@ -0,0 +1,75 @@ +--- +id: v1-dtotype-v1 +title: DtotypeV1 +pagination_label: DtotypeV1 +sidebar_label: DtotypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'DtotypeV1', 'v1DtotypeV1'] +slug: /tools/sdk/typescript/sources/models/dtotype-v1 +tags: ['SDK', 'Software Development Kit', 'DtotypeV1', 'v1DtotypeV1'] +--- + +# DtotypeV1 + +## Enum + + +* `AccountCorrelationConfig` (value: `'ACCOUNT_CORRELATION_CONFIG'`) + +* `AccessProfile` (value: `'ACCESS_PROFILE'`) + +* `AccessRequestApproval` (value: `'ACCESS_REQUEST_APPROVAL'`) + +* `Account` (value: `'ACCOUNT'`) + +* `Application` (value: `'APPLICATION'`) + +* `Campaign` (value: `'CAMPAIGN'`) + +* `CampaignFilter` (value: `'CAMPAIGN_FILTER'`) + +* `Certification` (value: `'CERTIFICATION'`) + +* `Cluster` (value: `'CLUSTER'`) + +* `ConnectorSchema` (value: `'CONNECTOR_SCHEMA'`) + +* `Entitlement` (value: `'ENTITLEMENT'`) + +* `GovernanceGroup` (value: `'GOVERNANCE_GROUP'`) + +* `Identity` (value: `'IDENTITY'`) + +* `IdentityProfile` (value: `'IDENTITY_PROFILE'`) + +* `IdentityRequest` (value: `'IDENTITY_REQUEST'`) + +* `MachineIdentity` (value: `'MACHINE_IDENTITY'`) + +* `LifecycleState` (value: `'LIFECYCLE_STATE'`) + +* `PasswordPolicy` (value: `'PASSWORD_POLICY'`) + +* `Role` (value: `'ROLE'`) + +* `Rule` (value: `'RULE'`) + +* `SodPolicy` (value: `'SOD_POLICY'`) + +* `Source` (value: `'SOURCE'`) + +* `Tag` (value: `'TAG'`) + +* `TagCategory` (value: `'TAG_CATEGORY'`) + +* `TaskResult` (value: `'TASK_RESULT'`) + +* `ReportResult` (value: `'REPORT_RESULT'`) + +* `SodViolation` (value: `'SOD_VIOLATION'`) + +* `AccountActivity` (value: `'ACCOUNT_ACTIVITY'`) + +* `Workgroup` (value: `'WORKGROUP'`) + + diff --git a/sdk-output/sources/docs/Models/Entitlementaccessrequestconfig.md b/sdk-output/sources/docs/Models/Entitlementaccessrequestconfig.md new file mode 100644 index 00000000..1fc57299 --- /dev/null +++ b/sdk-output/sources/docs/Models/Entitlementaccessrequestconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-entitlementaccessrequestconfig-v1 +title: EntitlementaccessrequestconfigV1 +pagination_label: EntitlementaccessrequestconfigV1 +sidebar_label: EntitlementaccessrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +slug: /tools/sdk/typescript/sources/models/entitlementaccessrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigV1', 'v1EntitlementaccessrequestconfigV1'] +--- + +# EntitlementaccessrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] +**requestCommentRequired** | **(optional)** **boolean** | If the requester must provide a comment during access request. | [default to false] +**denialCommentRequired** | **(optional)** **boolean** | If the reviewer must provide a comment when denying the access request. | [default to false] +**reauthorizationRequired** | **(optional)** **boolean** | Is Reauthorization Required | [default to false] +**requireEndDate** | **(optional)** **boolean** | If true, then remove date or sunset date is required in access request of the entitlement. | [default to false] +**maxPermittedAccessDuration** | **(optional)** **EntitlementaccessrequestconfigMaxPermittedAccessDurationV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md b/sdk-output/sources/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md new file mode 100644 index 00000000..bf988343 --- /dev/null +++ b/sdk-output/sources/docs/Models/EntitlementaccessrequestconfigMaxPermittedAccessDuration.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementaccessrequestconfig-max-permitted-access-duration-v1 +title: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +pagination_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_label: EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +slug: /tools/sdk/typescript/sources/models/entitlementaccessrequestconfig-max-permitted-access-duration-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementaccessrequestconfigMaxPermittedAccessDurationV1', 'v1EntitlementaccessrequestconfigMaxPermittedAccessDurationV1'] +--- + +# EntitlementaccessrequestconfigMaxPermittedAccessDurationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **number** | The numeric value of the duration. | [default to undefined] +**timeUnit** | **(optional)** **string** | The time unit for the duration. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Entitlementapprovalscheme.md b/sdk-output/sources/docs/Models/Entitlementapprovalscheme.md new file mode 100644 index 00000000..316e6f18 --- /dev/null +++ b/sdk-output/sources/docs/Models/Entitlementapprovalscheme.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementapprovalscheme-v1 +title: EntitlementapprovalschemeV1 +pagination_label: EntitlementapprovalschemeV1 +sidebar_label: EntitlementapprovalschemeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +slug: /tools/sdk/typescript/sources/models/entitlementapprovalscheme-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementapprovalschemeV1', 'v1EntitlementapprovalschemeV1'] +--- + +# EntitlementapprovalschemeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approverType** | **(optional)** **string** | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field **WORKFLOW**: A Workflow, the ID of which is specified by the **approverId** field, Workflows are exclusive to other types of approvals and License required. | [default to undefined] +**approverId** | **(optional)** **string** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP or WORKFLOW | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Entitlementrevocationrequestconfig.md b/sdk-output/sources/docs/Models/Entitlementrevocationrequestconfig.md new file mode 100644 index 00000000..8044723e --- /dev/null +++ b/sdk-output/sources/docs/Models/Entitlementrevocationrequestconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementrevocationrequestconfig-v1 +title: EntitlementrevocationrequestconfigV1 +pagination_label: EntitlementrevocationrequestconfigV1 +sidebar_label: EntitlementrevocationrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +slug: /tools/sdk/typescript/sources/models/entitlementrevocationrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrevocationrequestconfigV1', 'v1EntitlementrevocationrequestconfigV1'] +--- + +# EntitlementrevocationrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalSchemes** | **(optional)** **Array<EntitlementapprovalschemeV1>** | Ordered list of approval steps for the access request. Empty when no approval is required. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Errormessagedto.md b/sdk-output/sources/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8297d980 --- /dev/null +++ b/sdk-output/sources/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/sources/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Errorresponsedto.md b/sdk-output/sources/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..af232a11 --- /dev/null +++ b/sdk-output/sources/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/sources/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Fielddetailsdto.md b/sdk-output/sources/docs/Models/Fielddetailsdto.md new file mode 100644 index 00000000..8cecb4c5 --- /dev/null +++ b/sdk-output/sources/docs/Models/Fielddetailsdto.md @@ -0,0 +1,24 @@ +--- +id: v1-fielddetailsdto-v1 +title: FielddetailsdtoV1 +pagination_label: FielddetailsdtoV1 +sidebar_label: FielddetailsdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FielddetailsdtoV1', 'v1FielddetailsdtoV1'] +slug: /tools/sdk/typescript/sources/models/fielddetailsdto-v1 +tags: ['SDK', 'Software Development Kit', 'FielddetailsdtoV1', 'v1FielddetailsdtoV1'] +--- + +# FielddetailsdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the attribute. | [default to undefined] +**transform** | **(optional)** **object** | The transform to apply to the field | [default to undefined] +**attributes** | **(optional)** **object** | Attributes required for the transform | [default to undefined] +**isRequired** | **(optional)** **boolean** | Flag indicating whether or not the attribute is required. | [readonly] [default to false] +**type** | **(optional)** **string** | 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. | [default to undefined] +**isMultiValued** | **(optional)** **boolean** | Flag indicating whether or not the attribute is multi-valued. | [default to false] + diff --git a/sdk-output/sources/docs/Models/Identityprofilesconnections.md b/sdk-output/sources/docs/Models/Identityprofilesconnections.md new file mode 100644 index 00000000..42826814 --- /dev/null +++ b/sdk-output/sources/docs/Models/Identityprofilesconnections.md @@ -0,0 +1,21 @@ +--- +id: v1-identityprofilesconnections-v1 +title: IdentityprofilesconnectionsV1 +pagination_label: IdentityprofilesconnectionsV1 +sidebar_label: IdentityprofilesconnectionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityprofilesconnectionsV1', 'v1IdentityprofilesconnectionsV1'] +slug: /tools/sdk/typescript/sources/models/identityprofilesconnections-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityprofilesconnectionsV1', 'v1IdentityprofilesconnectionsV1'] +--- + +# IdentityprofilesconnectionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the IdentityProfile this reference applies | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the IdentityProfile to which this reference applies | [default to undefined] +**identityCount** | **(optional)** **number** | The Number of Identities managed by this IdentityProfile | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ImportAccountsSchemaV1Request.md b/sdk-output/sources/docs/Models/ImportAccountsSchemaV1Request.md new file mode 100644 index 00000000..5465fdee --- /dev/null +++ b/sdk-output/sources/docs/Models/ImportAccountsSchemaV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-import-accounts-schema-v1-request-v1 +title: ImportAccountsSchemaV1RequestV1 +pagination_label: ImportAccountsSchemaV1RequestV1 +sidebar_label: ImportAccountsSchemaV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportAccountsSchemaV1RequestV1', 'v1ImportAccountsSchemaV1RequestV1'] +slug: /tools/sdk/typescript/sources/models/import-accounts-schema-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportAccountsSchemaV1RequestV1', 'v1ImportAccountsSchemaV1RequestV1'] +--- + +# ImportAccountsSchemaV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **(optional)** **File** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ImportAccountsV1Request.md b/sdk-output/sources/docs/Models/ImportAccountsV1Request.md new file mode 100644 index 00000000..43de418e --- /dev/null +++ b/sdk-output/sources/docs/Models/ImportAccountsV1Request.md @@ -0,0 +1,20 @@ +--- +id: v1-import-accounts-v1-request-v1 +title: ImportAccountsV1RequestV1 +pagination_label: ImportAccountsV1RequestV1 +sidebar_label: ImportAccountsV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportAccountsV1RequestV1', 'v1ImportAccountsV1RequestV1'] +slug: /tools/sdk/typescript/sources/models/import-accounts-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportAccountsV1RequestV1', 'v1ImportAccountsV1RequestV1'] +--- + +# ImportAccountsV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **(optional)** **File** | The CSV file containing the source accounts to aggregate. | [default to undefined] +**disableOptimization** | **(optional)** **string** | Use this flag to reprocess every account whether or not the data has changed. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ImportEntitlementsV1Request.md b/sdk-output/sources/docs/Models/ImportEntitlementsV1Request.md new file mode 100644 index 00000000..0f093cc2 --- /dev/null +++ b/sdk-output/sources/docs/Models/ImportEntitlementsV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-import-entitlements-v1-request-v1 +title: ImportEntitlementsV1RequestV1 +pagination_label: ImportEntitlementsV1RequestV1 +sidebar_label: ImportEntitlementsV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportEntitlementsV1RequestV1', 'v1ImportEntitlementsV1RequestV1'] +slug: /tools/sdk/typescript/sources/models/import-entitlements-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsV1RequestV1', 'v1ImportEntitlementsV1RequestV1'] +--- + +# ImportEntitlementsV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**file** | **(optional)** **File** | The CSV file containing the source entitlements to aggregate. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Index.md b/sdk-output/sources/docs/Models/Index.md new file mode 100644 index 00000000..f28b4420 --- /dev/null +++ b/sdk-output/sources/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: sources-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: sources-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'sources', 'models'] +slug: /tools/sdk/typescript/sources/models +tags: ['SDK', 'Software Development Kit', 'sources', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/sources/docs/Models/Jsonpatchoperation.md b/sdk-output/sources/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..c3c1e172 --- /dev/null +++ b/sdk-output/sources/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/sources/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/JsonpatchoperationValue.md b/sdk-output/sources/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..a5243efb --- /dev/null +++ b/sdk-output/sources/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/sources/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sources/docs/Models/ListSourcesV1401Response.md b/sdk-output/sources/docs/Models/ListSourcesV1401Response.md new file mode 100644 index 00000000..ca4ef633 --- /dev/null +++ b/sdk-output/sources/docs/Models/ListSourcesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-sources-v1401-response-v1 +title: ListSourcesV1401ResponseV1 +pagination_label: ListSourcesV1401ResponseV1 +sidebar_label: ListSourcesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSourcesV1401ResponseV1', 'v1ListSourcesV1401ResponseV1'] +slug: /tools/sdk/typescript/sources/models/list-sources-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSourcesV1401ResponseV1', 'v1ListSourcesV1401ResponseV1'] +--- + +# ListSourcesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/ListSourcesV1429Response.md b/sdk-output/sources/docs/Models/ListSourcesV1429Response.md new file mode 100644 index 00000000..352dfc1c --- /dev/null +++ b/sdk-output/sources/docs/Models/ListSourcesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-sources-v1429-response-v1 +title: ListSourcesV1429ResponseV1 +pagination_label: ListSourcesV1429ResponseV1 +sidebar_label: ListSourcesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListSourcesV1429ResponseV1', 'v1ListSourcesV1429ResponseV1'] +slug: /tools/sdk/typescript/sources/models/list-sources-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListSourcesV1429ResponseV1', 'v1ListSourcesV1429ResponseV1'] +--- + +# ListSourcesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Loadaccountstask.md b/sdk-output/sources/docs/Models/Loadaccountstask.md new file mode 100644 index 00000000..848f505a --- /dev/null +++ b/sdk-output/sources/docs/Models/Loadaccountstask.md @@ -0,0 +1,20 @@ +--- +id: v1-loadaccountstask-v1 +title: LoadaccountstaskV1 +pagination_label: LoadaccountstaskV1 +sidebar_label: LoadaccountstaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadaccountstaskV1', 'v1LoadaccountstaskV1'] +slug: /tools/sdk/typescript/sources/models/loadaccountstask-v1 +tags: ['SDK', 'Software Development Kit', 'LoadaccountstaskV1', 'v1LoadaccountstaskV1'] +--- + +# LoadaccountstaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **(optional)** **boolean** | The status of the result | [default to true] +**task** | **(optional)** **LoadaccountstaskTaskV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoadaccountstaskTask.md b/sdk-output/sources/docs/Models/LoadaccountstaskTask.md new file mode 100644 index 00000000..f4a1882e --- /dev/null +++ b/sdk-output/sources/docs/Models/LoadaccountstaskTask.md @@ -0,0 +1,32 @@ +--- +id: v1-loadaccountstask-task-v1 +title: LoadaccountstaskTaskV1 +pagination_label: LoadaccountstaskTaskV1 +sidebar_label: LoadaccountstaskTaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadaccountstaskTaskV1', 'v1LoadaccountstaskTaskV1'] +slug: /tools/sdk/typescript/sources/models/loadaccountstask-task-v1 +tags: ['SDK', 'Software Development Kit', 'LoadaccountstaskTaskV1', 'v1LoadaccountstaskTaskV1'] +--- + +# LoadaccountstaskTaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the task this taskStatus represents | [default to undefined] +**type** | **(optional)** **string** | Type of task this task represents | [default to undefined] +**name** | **(optional)** **string** | The name of the aggregation process | [default to undefined] +**description** | **(optional)** **string** | The description of the task | [default to undefined] +**launcher** | **(optional)** **string** | The user who initiated the task | [default to undefined] +**created** | **(optional)** **string** | The Task creation date | [default to undefined] +**launched** | **(optional)** **string** | The task start date | [default to undefined] +**completed** | **(optional)** **string** | The task completion date | [default to undefined] +**completionStatus** | **(optional)** **string** | Task completion status. | [default to undefined] +**parentName** | **(optional)** **string** | Name of the parent task if exists. | [default to undefined] +**messages** | **(optional)** **Array<LoadaccountstaskTaskMessagesInnerV1>** | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [default to undefined] +**progress** | **(optional)** **string** | Current task state. | [default to undefined] +**attributes** | **(optional)** **LoadaccountstaskTaskAttributesV1** | | [default to undefined] +**returns** | **(optional)** **Array<LoadaccountstaskTaskReturnsInnerV1>** | Return values from the task | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoadaccountstaskTaskAttributes.md b/sdk-output/sources/docs/Models/LoadaccountstaskTaskAttributes.md new file mode 100644 index 00000000..35a4727e --- /dev/null +++ b/sdk-output/sources/docs/Models/LoadaccountstaskTaskAttributes.md @@ -0,0 +1,20 @@ +--- +id: v1-loadaccountstask-task-attributes-v1 +title: LoadaccountstaskTaskAttributesV1 +pagination_label: LoadaccountstaskTaskAttributesV1 +sidebar_label: LoadaccountstaskTaskAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadaccountstaskTaskAttributesV1', 'v1LoadaccountstaskTaskAttributesV1'] +slug: /tools/sdk/typescript/sources/models/loadaccountstask-task-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'LoadaccountstaskTaskAttributesV1', 'v1LoadaccountstaskTaskAttributesV1'] +--- + +# LoadaccountstaskTaskAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**appId** | **(optional)** **string** | The id of the source | [default to undefined] +**optimizedAggregation** | **(optional)** **string** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoadaccountstaskTaskMessagesInner.md b/sdk-output/sources/docs/Models/LoadaccountstaskTaskMessagesInner.md new file mode 100644 index 00000000..7bf0529b --- /dev/null +++ b/sdk-output/sources/docs/Models/LoadaccountstaskTaskMessagesInner.md @@ -0,0 +1,23 @@ +--- +id: v1-loadaccountstask-task-messages-inner-v1 +title: LoadaccountstaskTaskMessagesInnerV1 +pagination_label: LoadaccountstaskTaskMessagesInnerV1 +sidebar_label: LoadaccountstaskTaskMessagesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadaccountstaskTaskMessagesInnerV1', 'v1LoadaccountstaskTaskMessagesInnerV1'] +slug: /tools/sdk/typescript/sources/models/loadaccountstask-task-messages-inner-v1 +tags: ['SDK', 'Software Development Kit', 'LoadaccountstaskTaskMessagesInnerV1', 'v1LoadaccountstaskTaskMessagesInnerV1'] +--- + +# LoadaccountstaskTaskMessagesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the message. | [default to undefined] +**error** | **(optional)** **boolean** | Flag whether message is an error. | [default to false] +**warning** | **(optional)** **boolean** | Flag whether message is a warning. | [default to false] +**key** | **(optional)** **string** | Message string identifier. | [default to undefined] +**localizedText** | **(optional)** **string** | Message context with the locale based language. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoadaccountstaskTaskReturnsInner.md b/sdk-output/sources/docs/Models/LoadaccountstaskTaskReturnsInner.md new file mode 100644 index 00000000..412104fe --- /dev/null +++ b/sdk-output/sources/docs/Models/LoadaccountstaskTaskReturnsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-loadaccountstask-task-returns-inner-v1 +title: LoadaccountstaskTaskReturnsInnerV1 +pagination_label: LoadaccountstaskTaskReturnsInnerV1 +sidebar_label: LoadaccountstaskTaskReturnsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadaccountstaskTaskReturnsInnerV1', 'v1LoadaccountstaskTaskReturnsInnerV1'] +slug: /tools/sdk/typescript/sources/models/loadaccountstask-task-returns-inner-v1 +tags: ['SDK', 'Software Development Kit', 'LoadaccountstaskTaskReturnsInnerV1', 'v1LoadaccountstaskTaskReturnsInnerV1'] +--- + +# LoadaccountstaskTaskReturnsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayLabel** | **(optional)** **string** | The display label of the return value | [default to undefined] +**attributeName** | **(optional)** **string** | The attribute name of the return value | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Loadentitlementtask.md b/sdk-output/sources/docs/Models/Loadentitlementtask.md new file mode 100644 index 00000000..ee862021 --- /dev/null +++ b/sdk-output/sources/docs/Models/Loadentitlementtask.md @@ -0,0 +1,25 @@ +--- +id: v1-loadentitlementtask-v1 +title: LoadentitlementtaskV1 +pagination_label: LoadentitlementtaskV1 +sidebar_label: LoadentitlementtaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadentitlementtaskV1', 'v1LoadentitlementtaskV1'] +slug: /tools/sdk/typescript/sources/models/loadentitlementtask-v1 +tags: ['SDK', 'Software Development Kit', 'LoadentitlementtaskV1', 'v1LoadentitlementtaskV1'] +--- + +# LoadentitlementtaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the task this taskStatus represents | [default to undefined] +**type** | **(optional)** **string** | Type of task this task represents | [default to undefined] +**uniqueName** | **(optional)** **string** | The name of the task | [default to undefined] +**description** | **(optional)** **string** | The description of the task | [default to undefined] +**launcher** | **(optional)** **string** | The user who initiated the task | [default to undefined] +**created** | **(optional)** **string** | The creation date of the task | [default to undefined] +**returns** | **(optional)** **Array<LoadentitlementtaskReturnsInnerV1>** | Return values from the task | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoadentitlementtaskReturnsInner.md b/sdk-output/sources/docs/Models/LoadentitlementtaskReturnsInner.md new file mode 100644 index 00000000..9d91d10e --- /dev/null +++ b/sdk-output/sources/docs/Models/LoadentitlementtaskReturnsInner.md @@ -0,0 +1,20 @@ +--- +id: v1-loadentitlementtask-returns-inner-v1 +title: LoadentitlementtaskReturnsInnerV1 +pagination_label: LoadentitlementtaskReturnsInnerV1 +sidebar_label: LoadentitlementtaskReturnsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoadentitlementtaskReturnsInnerV1', 'v1LoadentitlementtaskReturnsInnerV1'] +slug: /tools/sdk/typescript/sources/models/loadentitlementtask-returns-inner-v1 +tags: ['SDK', 'Software Development Kit', 'LoadentitlementtaskReturnsInnerV1', 'v1LoadentitlementtaskReturnsInnerV1'] +--- + +# LoadentitlementtaskReturnsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**displayLabel** | **(optional)** **string** | The display label for the return value | [default to undefined] +**attributeName** | **(optional)** **string** | The attribute name for the return value | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Loaduncorrelatedaccountstask.md b/sdk-output/sources/docs/Models/Loaduncorrelatedaccountstask.md new file mode 100644 index 00000000..429886bf --- /dev/null +++ b/sdk-output/sources/docs/Models/Loaduncorrelatedaccountstask.md @@ -0,0 +1,20 @@ +--- +id: v1-loaduncorrelatedaccountstask-v1 +title: LoaduncorrelatedaccountstaskV1 +pagination_label: LoaduncorrelatedaccountstaskV1 +sidebar_label: LoaduncorrelatedaccountstaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoaduncorrelatedaccountstaskV1', 'v1LoaduncorrelatedaccountstaskV1'] +slug: /tools/sdk/typescript/sources/models/loaduncorrelatedaccountstask-v1 +tags: ['SDK', 'Software Development Kit', 'LoaduncorrelatedaccountstaskV1', 'v1LoaduncorrelatedaccountstaskV1'] +--- + +# LoaduncorrelatedaccountstaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**success** | **(optional)** **boolean** | The status of the result | [default to true] +**task** | **(optional)** **LoaduncorrelatedaccountstaskTaskV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTask.md b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTask.md new file mode 100644 index 00000000..e9d4f419 --- /dev/null +++ b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTask.md @@ -0,0 +1,32 @@ +--- +id: v1-loaduncorrelatedaccountstask-task-v1 +title: LoaduncorrelatedaccountstaskTaskV1 +pagination_label: LoaduncorrelatedaccountstaskTaskV1 +sidebar_label: LoaduncorrelatedaccountstaskTaskV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoaduncorrelatedaccountstaskTaskV1', 'v1LoaduncorrelatedaccountstaskTaskV1'] +slug: /tools/sdk/typescript/sources/models/loaduncorrelatedaccountstask-task-v1 +tags: ['SDK', 'Software Development Kit', 'LoaduncorrelatedaccountstaskTaskV1', 'v1LoaduncorrelatedaccountstaskTaskV1'] +--- + +# LoaduncorrelatedaccountstaskTaskV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | System-generated unique ID of the task this taskStatus represents | [default to undefined] +**type** | **(optional)** **string** | Type of task this task represents | [default to undefined] +**name** | **(optional)** **string** | The name of uncorrelated accounts process | [default to undefined] +**description** | **(optional)** **string** | The description of the task | [default to undefined] +**launcher** | **(optional)** **string** | The user who initiated the task | [default to undefined] +**created** | **(optional)** **string** | The Task creation date | [default to undefined] +**launched** | **(optional)** **string** | The task start date | [default to undefined] +**completed** | **(optional)** **string** | The task completion date | [default to undefined] +**completionStatus** | **(optional)** **string** | Task completion status. | [default to undefined] +**parentName** | **(optional)** **string** | Name of the parent task if exists. | [default to undefined] +**messages** | **(optional)** **Array<LoaduncorrelatedaccountstaskTaskMessagesInnerV1>** | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [default to undefined] +**progress** | **(optional)** **string** | Current task state. | [default to undefined] +**attributes** | **(optional)** **LoaduncorrelatedaccountstaskTaskAttributesV1** | | [default to undefined] +**returns** | **(optional)** **object** | Return values from the task | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskAttributes.md b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskAttributes.md new file mode 100644 index 00000000..80f61518 --- /dev/null +++ b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskAttributes.md @@ -0,0 +1,20 @@ +--- +id: v1-loaduncorrelatedaccountstask-task-attributes-v1 +title: LoaduncorrelatedaccountstaskTaskAttributesV1 +pagination_label: LoaduncorrelatedaccountstaskTaskAttributesV1 +sidebar_label: LoaduncorrelatedaccountstaskTaskAttributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoaduncorrelatedaccountstaskTaskAttributesV1', 'v1LoaduncorrelatedaccountstaskTaskAttributesV1'] +slug: /tools/sdk/typescript/sources/models/loaduncorrelatedaccountstask-task-attributes-v1 +tags: ['SDK', 'Software Development Kit', 'LoaduncorrelatedaccountstaskTaskAttributesV1', 'v1LoaduncorrelatedaccountstaskTaskAttributesV1'] +--- + +# LoaduncorrelatedaccountstaskTaskAttributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**qpocJobId** | **(optional)** **string** | The id of qpoc job | [default to undefined] +**taskStartDelay** | **(optional)** **any** | the task start delay value | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskMessagesInner.md b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskMessagesInner.md new file mode 100644 index 00000000..dcdae6e7 --- /dev/null +++ b/sdk-output/sources/docs/Models/LoaduncorrelatedaccountstaskTaskMessagesInner.md @@ -0,0 +1,23 @@ +--- +id: v1-loaduncorrelatedaccountstask-task-messages-inner-v1 +title: LoaduncorrelatedaccountstaskTaskMessagesInnerV1 +pagination_label: LoaduncorrelatedaccountstaskTaskMessagesInnerV1 +sidebar_label: LoaduncorrelatedaccountstaskTaskMessagesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LoaduncorrelatedaccountstaskTaskMessagesInnerV1', 'v1LoaduncorrelatedaccountstaskTaskMessagesInnerV1'] +slug: /tools/sdk/typescript/sources/models/loaduncorrelatedaccountstask-task-messages-inner-v1 +tags: ['SDK', 'Software Development Kit', 'LoaduncorrelatedaccountstaskTaskMessagesInnerV1', 'v1LoaduncorrelatedaccountstaskTaskMessagesInnerV1'] +--- + +# LoaduncorrelatedaccountstaskTaskMessagesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of the message. | [default to undefined] +**error** | **(optional)** **boolean** | Flag whether message is an error. | [default to false] +**warning** | **(optional)** **boolean** | Flag whether message is a warning. | [default to false] +**key** | **(optional)** **string** | Message string identifier. | [default to undefined] +**localizedText** | **(optional)** **string** | Message context with the locale based language. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Localeorigin.md b/sdk-output/sources/docs/Models/Localeorigin.md new file mode 100644 index 00000000..cdda4a29 --- /dev/null +++ b/sdk-output/sources/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/sources/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/sources/docs/Models/Managercorrelationmapping.md b/sdk-output/sources/docs/Models/Managercorrelationmapping.md new file mode 100644 index 00000000..14bbd0ec --- /dev/null +++ b/sdk-output/sources/docs/Models/Managercorrelationmapping.md @@ -0,0 +1,20 @@ +--- +id: v1-managercorrelationmapping-v1 +title: ManagercorrelationmappingV1 +pagination_label: ManagercorrelationmappingV1 +sidebar_label: ManagercorrelationmappingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ManagercorrelationmappingV1', 'v1ManagercorrelationmappingV1'] +slug: /tools/sdk/typescript/sources/models/managercorrelationmapping-v1 +tags: ['SDK', 'Software Development Kit', 'ManagercorrelationmappingV1', 'v1ManagercorrelationmappingV1'] +--- + +# ManagercorrelationmappingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountAttributeName** | **(optional)** **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. | [default to undefined] +**identityAttributeName** | **(optional)** **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Nativechangedetectionconfig.md b/sdk-output/sources/docs/Models/Nativechangedetectionconfig.md new file mode 100644 index 00000000..fb5d2cec --- /dev/null +++ b/sdk-output/sources/docs/Models/Nativechangedetectionconfig.md @@ -0,0 +1,24 @@ +--- +id: v1-nativechangedetectionconfig-v1 +title: NativechangedetectionconfigV1 +pagination_label: NativechangedetectionconfigV1 +sidebar_label: NativechangedetectionconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'NativechangedetectionconfigV1', 'v1NativechangedetectionconfigV1'] +slug: /tools/sdk/typescript/sources/models/nativechangedetectionconfig-v1 +tags: ['SDK', 'Software Development Kit', 'NativechangedetectionconfigV1', 'v1NativechangedetectionconfigV1'] +--- + +# NativechangedetectionconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | A flag indicating if Native Change Detection is enabled for a source. | [default to false] +**operations** | **(optional)** **Array<string>** | Operation types for which Native Change Detection is enabled for a source. | [default to undefined] +**allEntitlements** | **(optional)** **boolean** | A flag indicating that all entitlements participate in Native Change Detection. | [default to false] +**allNonEntitlementAttributes** | **(optional)** **boolean** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [default to false] +**selectedEntitlements** | **(optional)** **Array<string>** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [default to undefined] +**selectedNonEntitlementAttributes** | **(optional)** **Array<string>** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoInner.md b/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoInner.md new file mode 100644 index 00000000..97ed5968 --- /dev/null +++ b/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoInner.md @@ -0,0 +1,21 @@ +--- +id: v1-passwordpolicyholdersdto-inner-v1 +title: PasswordpolicyholdersdtoInnerV1 +pagination_label: PasswordpolicyholdersdtoInnerV1 +sidebar_label: PasswordpolicyholdersdtoInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordpolicyholdersdtoInnerV1', 'v1PasswordpolicyholdersdtoInnerV1'] +slug: /tools/sdk/typescript/sources/models/passwordpolicyholdersdto-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordpolicyholdersdtoInnerV1', 'v1PasswordpolicyholdersdtoInnerV1'] +--- + +# PasswordpolicyholdersdtoInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**policyId** | **(optional)** **string** | The password policy Id. | [default to undefined] +**policyName** | **(optional)** **string** | The name of the password policy. | [default to undefined] +**selectors** | **(optional)** **PasswordpolicyholdersdtoattributesV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Passwordpolicyholdersdtoattributes.md b/sdk-output/sources/docs/Models/Passwordpolicyholdersdtoattributes.md new file mode 100644 index 00000000..baf9990d --- /dev/null +++ b/sdk-output/sources/docs/Models/Passwordpolicyholdersdtoattributes.md @@ -0,0 +1,19 @@ +--- +id: v1-passwordpolicyholdersdtoattributes-v1 +title: PasswordpolicyholdersdtoattributesV1 +pagination_label: PasswordpolicyholdersdtoattributesV1 +sidebar_label: PasswordpolicyholdersdtoattributesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordpolicyholdersdtoattributesV1', 'v1PasswordpolicyholdersdtoattributesV1'] +slug: /tools/sdk/typescript/sources/models/passwordpolicyholdersdtoattributes-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordpolicyholdersdtoattributesV1', 'v1PasswordpolicyholdersdtoattributesV1'] +--- + +# PasswordpolicyholdersdtoattributesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityAttr** | **(optional)** **Array<PasswordpolicyholdersdtoattributesIdentityAttrInnerV1>** | Attributes of PasswordPolicyHoldersDto | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoattributesIdentityAttrInner.md b/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoattributesIdentityAttrInner.md new file mode 100644 index 00000000..2ba72f2c --- /dev/null +++ b/sdk-output/sources/docs/Models/PasswordpolicyholdersdtoattributesIdentityAttrInner.md @@ -0,0 +1,20 @@ +--- +id: v1-passwordpolicyholdersdtoattributes-identity-attr-inner-v1 +title: PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 +pagination_label: PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 +sidebar_label: PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PasswordpolicyholdersdtoattributesIdentityAttrInnerV1', 'v1PasswordpolicyholdersdtoattributesIdentityAttrInnerV1'] +slug: /tools/sdk/typescript/sources/models/passwordpolicyholdersdtoattributes-identity-attr-inner-v1 +tags: ['SDK', 'Software Development Kit', 'PasswordpolicyholdersdtoattributesIdentityAttrInnerV1', 'v1PasswordpolicyholdersdtoattributesIdentityAttrInnerV1'] +--- + +# PasswordpolicyholdersdtoattributesIdentityAttrInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Attribute\'s name | [default to undefined] +**value** | **(optional)** **string** | Attribute\'s value | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Provisioningpolicydto.md b/sdk-output/sources/docs/Models/Provisioningpolicydto.md new file mode 100644 index 00000000..5cf98875 --- /dev/null +++ b/sdk-output/sources/docs/Models/Provisioningpolicydto.md @@ -0,0 +1,22 @@ +--- +id: v1-provisioningpolicydto-v1 +title: ProvisioningpolicydtoV1 +pagination_label: ProvisioningpolicydtoV1 +sidebar_label: ProvisioningpolicydtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningpolicydtoV1', 'v1ProvisioningpolicydtoV1'] +slug: /tools/sdk/typescript/sources/models/provisioningpolicydto-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningpolicydtoV1', 'v1ProvisioningpolicydtoV1'] +--- + +# ProvisioningpolicydtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | the provisioning policy name | [default to undefined] +**description** | **(optional)** **string** | the description of the provisioning policy | [default to undefined] +**usageType** | **(optional)** **UsagetypeV1** | | [default to undefined] +**fields** | **(optional)** **Array<FielddetailsdtoV1>** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/README.md b/sdk-output/sources/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sources/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sources/docs/Models/Resourceobject.md b/sdk-output/sources/docs/Models/Resourceobject.md new file mode 100644 index 00000000..85955ade --- /dev/null +++ b/sdk-output/sources/docs/Models/Resourceobject.md @@ -0,0 +1,31 @@ +--- +id: v1-resourceobject-v1 +title: ResourceobjectV1 +pagination_label: ResourceobjectV1 +sidebar_label: ResourceobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ResourceobjectV1', 'v1ResourceobjectV1'] +slug: /tools/sdk/typescript/sources/models/resourceobject-v1 +tags: ['SDK', 'Software Development Kit', 'ResourceobjectV1', 'v1ResourceobjectV1'] +--- + +# ResourceobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**instance** | **(optional)** **string** | Identifier of the specific instance where this object resides. | [readonly] [default to undefined] +**identity** | **(optional)** **string** | Native identity of the object in the Source. | [readonly] [default to undefined] +**uuid** | **(optional)** **string** | Universal unique identifier of the object in the Source. | [readonly] [default to undefined] +**previousIdentity** | **(optional)** **string** | Native identity that the object has previously. | [readonly] [default to undefined] +**name** | **(optional)** **string** | Display name for this object. | [readonly] [default to undefined] +**objectType** | **(optional)** **string** | Type of object. | [readonly] [default to undefined] +**incomplete** | **(optional)** **boolean** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [readonly] [default to undefined] +**incremental** | **(optional)** **boolean** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [readonly] [default to undefined] +**_delete** | **(optional)** **boolean** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [readonly] [default to undefined] +**remove** | **(optional)** **boolean** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [readonly] [default to undefined] +**missing** | **(optional)** **Array<string>** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\". | [readonly] [default to undefined] +**attributes** | **(optional)** **object** | Attributes of this ResourceObject. | [readonly] [default to undefined] +**finalUpdate** | **(optional)** **boolean** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [readonly] [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Resourceobjectsrequest.md b/sdk-output/sources/docs/Models/Resourceobjectsrequest.md new file mode 100644 index 00000000..439f1c16 --- /dev/null +++ b/sdk-output/sources/docs/Models/Resourceobjectsrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-resourceobjectsrequest-v1 +title: ResourceobjectsrequestV1 +pagination_label: ResourceobjectsrequestV1 +sidebar_label: ResourceobjectsrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ResourceobjectsrequestV1', 'v1ResourceobjectsrequestV1'] +slug: /tools/sdk/typescript/sources/models/resourceobjectsrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ResourceobjectsrequestV1', 'v1ResourceobjectsrequestV1'] +--- + +# ResourceobjectsrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectType** | **(optional)** **string** | The type of resource objects to iterate over. | [default to 'account'] +**maxCount** | **(optional)** **number** | The maximum number of resource objects to iterate over and return. | [default to 25] + diff --git a/sdk-output/sources/docs/Models/Resourceobjectsresponse.md b/sdk-output/sources/docs/Models/Resourceobjectsresponse.md new file mode 100644 index 00000000..5888f0c6 --- /dev/null +++ b/sdk-output/sources/docs/Models/Resourceobjectsresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-resourceobjectsresponse-v1 +title: ResourceobjectsresponseV1 +pagination_label: ResourceobjectsresponseV1 +sidebar_label: ResourceobjectsresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ResourceobjectsresponseV1', 'v1ResourceobjectsresponseV1'] +slug: /tools/sdk/typescript/sources/models/resourceobjectsresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ResourceobjectsresponseV1', 'v1ResourceobjectsresponseV1'] +--- + +# ResourceobjectsresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the source | [readonly] [default to undefined] +**name** | **(optional)** **string** | Name of the source | [readonly] [default to undefined] +**objectCount** | **(optional)** **number** | The number of objects that were fetched by the connector. | [readonly] [default to undefined] +**elapsedMillis** | **(optional)** **number** | The number of milliseconds spent on the entire request. | [readonly] [default to undefined] +**resourceObjects** | **(optional)** **Array<ResourceobjectV1>** | Fetched objects from the source connector. | [readonly] [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Schedule3.md b/sdk-output/sources/docs/Models/Schedule3.md new file mode 100644 index 00000000..b9063669 --- /dev/null +++ b/sdk-output/sources/docs/Models/Schedule3.md @@ -0,0 +1,20 @@ +--- +id: v1-schedule3-v1 +title: Schedule3V1 +pagination_label: Schedule3V1 +sidebar_label: Schedule3V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Schedule3V1', 'v1Schedule3V1'] +slug: /tools/sdk/typescript/sources/models/schedule3-v1 +tags: ['SDK', 'Software Development Kit', 'Schedule3V1', 'v1Schedule3V1'] +--- + +# Schedule3V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of the Schedule. | [default to undefined] +**cronExpression** | **string** | The cron expression of the schedule. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Schema.md b/sdk-output/sources/docs/Models/Schema.md new file mode 100644 index 00000000..fb644f10 --- /dev/null +++ b/sdk-output/sources/docs/Models/Schema.md @@ -0,0 +1,30 @@ +--- +id: v1-schema-v1 +title: SchemaV1 +pagination_label: SchemaV1 +sidebar_label: SchemaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SchemaV1', 'v1SchemaV1'] +slug: /tools/sdk/typescript/sources/models/schema-v1 +tags: ['SDK', 'Software Development Kit', 'SchemaV1', 'v1SchemaV1'] +--- + +# SchemaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the Schema. | [default to undefined] +**name** | **(optional)** **string** | The name of the Schema. | [default to undefined] +**nativeObjectType** | **(optional)** **string** | The name of the object type on the native system that the schema represents. | [default to undefined] +**identityAttribute** | **(optional)** **string** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [default to undefined] +**displayAttribute** | **(optional)** **string** | The name of the attribute used to calculate the display value for an object in the schema. | [default to undefined] +**hierarchyAttribute** | **(optional)** **string** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [default to undefined] +**includePermissions** | **(optional)** **boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [default to false] +**features** | **(optional)** **Array<string>** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [default to undefined] +**configuration** | **(optional)** **object** | Holds any extra configuration data that the schema may require. | [default to undefined] +**attributes** | **(optional)** **Array<AttributedefinitionV1>** | The attribute definitions which form the schema. | [default to undefined] +**created** | **(optional)** **string** | The date the Schema was created. | [default to undefined] +**modified** | **(optional)** **string** | The date the Schema was last modified. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Source.md b/sdk-output/sources/docs/Models/Source.md new file mode 100644 index 00000000..ff14101a --- /dev/null +++ b/sdk-output/sources/docs/Models/Source.md @@ -0,0 +1,49 @@ +--- +id: v1-source-v1 +title: SourceV1 +pagination_label: SourceV1 +sidebar_label: SourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceV1', 'v1SourceV1'] +slug: /tools/sdk/typescript/sources/models/source-v1 +tags: ['SDK', 'Software Development Kit', 'SourceV1', 'v1SourceV1'] +--- + +# SourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Source ID. | [readonly] [default to undefined] +**name** | **string** | Source\'s human-readable name. | [default to undefined] +**description** | **(optional)** **string** | Source\'s human-readable description. | [default to undefined] +**owner** | **SourceOwnerV1** | | [default to undefined] +**cluster** | **(optional)** **SourceClusterV1** | | [default to undefined] +**accountCorrelationConfig** | **(optional)** **SourceAccountCorrelationConfigV1** | | [default to undefined] +**accountCorrelationRule** | **(optional)** **SourceAccountCorrelationRuleV1** | | [default to undefined] +**managerCorrelationMapping** | **(optional)** **SourceManagerCorrelationMappingV1** | | [default to undefined] +**managerCorrelationRule** | **(optional)** **SourceManagerCorrelationRuleV1** | | [default to undefined] +**beforeProvisioningRule** | **(optional)** **SourceBeforeProvisioningRuleV1** | | [default to undefined] +**schemas** | **(optional)** **Array<SourceSchemasInnerV1>** | List of references to schema objects. | [default to undefined] +**passwordPolicies** | **(optional)** **Array<SourcePasswordPoliciesInnerV1>** | List of references to the associated PasswordPolicy objects. | [default to undefined] +**features** | **(optional)** **Array<string>** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [default to undefined] +**type** | **(optional)** **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [default to undefined] +**connector** | **string** | Connector script name. | [default to undefined] +**connectorClass** | **(optional)** **string** | Fully qualified name of the Java class that implements the connector interface. | [default to undefined] +**connectorAttributes** | **(optional)** **object** | Connector specific configuration. This configuration will differ from type to type. | [default to undefined] +**deleteThreshold** | **(optional)** **number** | Number from 0 to 100 that specifies when to skip the delete phase. | [default to undefined] +**authoritative** | **(optional)** **boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [default to false] +**managementWorkgroup** | **(optional)** **SourceManagementWorkgroupV1** | | [default to undefined] +**healthy** | **(optional)** **boolean** | When this is true, it indicates that the source is healthy. | [default to false] +**status** | **(optional)** **string** | Status identifier that gives specific information about why a source is or isn\'t healthy. | [default to undefined] +**since** | **(optional)** **string** | Timestamp that shows when a source health check was last performed. | [default to undefined] +**connectorId** | **(optional)** **string** | Connector ID | [default to undefined] +**connectorName** | **(optional)** **string** | Name of the connector that was chosen during source creation. | [default to undefined] +**connectionType** | **(optional)** **string** | Type of connection (direct or file). | [default to undefined] +**connectorImplementationId** | **(optional)** **string** | Connector implementation ID. | [default to undefined] +**created** | **(optional)** **string** | Date-time when the source was created | [default to undefined] +**modified** | **(optional)** **string** | Date-time when the source was last modified. | [default to undefined] +**credentialProviderEnabled** | **(optional)** **boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [default to false] +**category** | **(optional)** **string** | Source category (e.g. null, CredentialProvider). | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceAccountCorrelationConfig.md b/sdk-output/sources/docs/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 00000000..e3f7c6d9 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,21 @@ +--- +id: v1-source-account-correlation-config-v1 +title: SourceAccountCorrelationConfigV1 +pagination_label: SourceAccountCorrelationConfigV1 +sidebar_label: SourceAccountCorrelationConfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceAccountCorrelationConfigV1', 'v1SourceAccountCorrelationConfigV1'] +slug: /tools/sdk/typescript/sources/models/source-account-correlation-config-v1 +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfigV1', 'v1SourceAccountCorrelationConfigV1'] +--- + +# SourceAccountCorrelationConfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Account correlation config ID. | [default to undefined] +**name** | **(optional)** **string** | Account correlation config\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceAccountCorrelationRule.md b/sdk-output/sources/docs/Models/SourceAccountCorrelationRule.md new file mode 100644 index 00000000..0ecf5125 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,21 @@ +--- +id: v1-source-account-correlation-rule-v1 +title: SourceAccountCorrelationRuleV1 +pagination_label: SourceAccountCorrelationRuleV1 +sidebar_label: SourceAccountCorrelationRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceAccountCorrelationRuleV1', 'v1SourceAccountCorrelationRuleV1'] +slug: /tools/sdk/typescript/sources/models/source-account-correlation-rule-v1 +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRuleV1', 'v1SourceAccountCorrelationRuleV1'] +--- + +# SourceAccountCorrelationRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceBeforeProvisioningRule.md b/sdk-output/sources/docs/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 00000000..fb550267 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,21 @@ +--- +id: v1-source-before-provisioning-rule-v1 +title: SourceBeforeProvisioningRuleV1 +pagination_label: SourceBeforeProvisioningRuleV1 +sidebar_label: SourceBeforeProvisioningRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceBeforeProvisioningRuleV1', 'v1SourceBeforeProvisioningRuleV1'] +slug: /tools/sdk/typescript/sources/models/source-before-provisioning-rule-v1 +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRuleV1', 'v1SourceBeforeProvisioningRuleV1'] +--- + +# SourceBeforeProvisioningRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceCluster.md b/sdk-output/sources/docs/Models/SourceCluster.md new file mode 100644 index 00000000..30ad08cb --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceCluster.md @@ -0,0 +1,21 @@ +--- +id: v1-source-cluster-v1 +title: SourceClusterV1 +pagination_label: SourceClusterV1 +sidebar_label: SourceClusterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceClusterV1', 'v1SourceClusterV1'] +slug: /tools/sdk/typescript/sources/models/source-cluster-v1 +tags: ['SDK', 'Software Development Kit', 'SourceClusterV1', 'v1SourceClusterV1'] +--- + +# SourceClusterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of object being referenced. | [default to undefined] +**id** | **string** | Cluster ID. | [default to undefined] +**name** | **string** | Cluster\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceManagementWorkgroup.md b/sdk-output/sources/docs/Models/SourceManagementWorkgroup.md new file mode 100644 index 00000000..dad42b45 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceManagementWorkgroup.md @@ -0,0 +1,21 @@ +--- +id: v1-source-management-workgroup-v1 +title: SourceManagementWorkgroupV1 +pagination_label: SourceManagementWorkgroupV1 +sidebar_label: SourceManagementWorkgroupV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceManagementWorkgroupV1', 'v1SourceManagementWorkgroupV1'] +slug: /tools/sdk/typescript/sources/models/source-management-workgroup-v1 +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroupV1', 'v1SourceManagementWorkgroupV1'] +--- + +# SourceManagementWorkgroupV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Management workgroup ID. | [default to undefined] +**name** | **(optional)** **string** | Management workgroup\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceManagerCorrelationMapping.md b/sdk-output/sources/docs/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 00000000..dc77b839 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,20 @@ +--- +id: v1-source-manager-correlation-mapping-v1 +title: SourceManagerCorrelationMappingV1 +pagination_label: SourceManagerCorrelationMappingV1 +sidebar_label: SourceManagerCorrelationMappingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceManagerCorrelationMappingV1', 'v1SourceManagerCorrelationMappingV1'] +slug: /tools/sdk/typescript/sources/models/source-manager-correlation-mapping-v1 +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMappingV1', 'v1SourceManagerCorrelationMappingV1'] +--- + +# SourceManagerCorrelationMappingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accountAttributeName** | **(optional)** **string** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager\'s identity. | [default to undefined] +**identityAttributeName** | **(optional)** **string** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceManagerCorrelationRule.md b/sdk-output/sources/docs/Models/SourceManagerCorrelationRule.md new file mode 100644 index 00000000..7fa9cfbc --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,21 @@ +--- +id: v1-source-manager-correlation-rule-v1 +title: SourceManagerCorrelationRuleV1 +pagination_label: SourceManagerCorrelationRuleV1 +sidebar_label: SourceManagerCorrelationRuleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceManagerCorrelationRuleV1', 'v1SourceManagerCorrelationRuleV1'] +slug: /tools/sdk/typescript/sources/models/source-manager-correlation-rule-v1 +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRuleV1', 'v1SourceManagerCorrelationRuleV1'] +--- + +# SourceManagerCorrelationRuleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Rule ID. | [default to undefined] +**name** | **(optional)** **string** | Rule\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceOwner.md b/sdk-output/sources/docs/Models/SourceOwner.md new file mode 100644 index 00000000..4572caa4 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-source-owner-v1 +title: SourceOwnerV1 +pagination_label: SourceOwnerV1 +sidebar_label: SourceOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceOwnerV1', 'v1SourceOwnerV1'] +slug: /tools/sdk/typescript/sources/models/source-owner-v1 +tags: ['SDK', 'Software Development Kit', 'SourceOwnerV1', 'v1SourceOwnerV1'] +--- + +# SourceOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Owner identity\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Owner identity\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourcePasswordPoliciesInner.md b/sdk-output/sources/docs/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 00000000..f59d9493 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-source-password-policies-inner-v1 +title: SourcePasswordPoliciesInnerV1 +pagination_label: SourcePasswordPoliciesInnerV1 +sidebar_label: SourcePasswordPoliciesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcePasswordPoliciesInnerV1', 'v1SourcePasswordPoliciesInnerV1'] +slug: /tools/sdk/typescript/sources/models/source-password-policies-inner-v1 +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInnerV1', 'v1SourcePasswordPoliciesInnerV1'] +--- + +# SourcePasswordPoliciesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Policy ID. | [default to undefined] +**name** | **(optional)** **string** | Policy\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/SourceSchemasInner.md b/sdk-output/sources/docs/Models/SourceSchemasInner.md new file mode 100644 index 00000000..ffb49ad6 --- /dev/null +++ b/sdk-output/sources/docs/Models/SourceSchemasInner.md @@ -0,0 +1,21 @@ +--- +id: v1-source-schemas-inner-v1 +title: SourceSchemasInnerV1 +pagination_label: SourceSchemasInnerV1 +sidebar_label: SourceSchemasInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceSchemasInnerV1', 'v1SourceSchemasInnerV1'] +slug: /tools/sdk/typescript/sources/models/source-schemas-inner-v1 +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInnerV1', 'v1SourceSchemasInnerV1'] +--- + +# SourceSchemasInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Type of object being referenced. | [default to undefined] +**id** | **(optional)** **string** | Schema ID. | [default to undefined] +**name** | **(optional)** **string** | Schema\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Sourceconnectionsdto.md b/sdk-output/sources/docs/Models/Sourceconnectionsdto.md new file mode 100644 index 00000000..8aa3a900 --- /dev/null +++ b/sdk-output/sources/docs/Models/Sourceconnectionsdto.md @@ -0,0 +1,25 @@ +--- +id: v1-sourceconnectionsdto-v1 +title: SourceconnectionsdtoV1 +pagination_label: SourceconnectionsdtoV1 +sidebar_label: SourceconnectionsdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceconnectionsdtoV1', 'v1SourceconnectionsdtoV1'] +slug: /tools/sdk/typescript/sources/models/sourceconnectionsdto-v1 +tags: ['SDK', 'Software Development Kit', 'SourceconnectionsdtoV1', 'v1SourceconnectionsdtoV1'] +--- + +# SourceconnectionsdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identityProfiles** | **(optional)** **Array<IdentityprofilesconnectionsV1>** | The IdentityProfile attached to this source | [default to undefined] +**credentialProfiles** | **(optional)** **Array<string>** | Name of the CredentialProfile attached to this source | [default to undefined] +**sourceAttributes** | **(optional)** **Array<string>** | The attributes attached to this source | [default to undefined] +**mappingProfiles** | **(optional)** **Array<string>** | The profiles attached to this source | [default to undefined] +**dependentCustomTransforms** | **(optional)** **Array<TransformreadV1>** | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [default to undefined] +**dependentApps** | **(optional)** **Array<DependantappconnectionsV1>** | | [default to undefined] +**missingDependents** | **(optional)** **Array<DependantconnectionsmissingdtoV1>** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Sourceentitlementrequestconfig.md b/sdk-output/sources/docs/Models/Sourceentitlementrequestconfig.md new file mode 100644 index 00000000..1dd83e0f --- /dev/null +++ b/sdk-output/sources/docs/Models/Sourceentitlementrequestconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-sourceentitlementrequestconfig-v1 +title: SourceentitlementrequestconfigV1 +pagination_label: SourceentitlementrequestconfigV1 +sidebar_label: SourceentitlementrequestconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceentitlementrequestconfigV1', 'v1SourceentitlementrequestconfigV1'] +slug: /tools/sdk/typescript/sources/models/sourceentitlementrequestconfig-v1 +tags: ['SDK', 'Software Development Kit', 'SourceentitlementrequestconfigV1', 'v1SourceentitlementrequestconfigV1'] +--- + +# SourceentitlementrequestconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestConfig** | **(optional)** **EntitlementaccessrequestconfigV1** | | [default to undefined] +**revocationRequestConfig** | **(optional)** **EntitlementrevocationrequestconfigV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Sourcehealthdto.md b/sdk-output/sources/docs/Models/Sourcehealthdto.md new file mode 100644 index 00000000..078bc51f --- /dev/null +++ b/sdk-output/sources/docs/Models/Sourcehealthdto.md @@ -0,0 +1,28 @@ +--- +id: v1-sourcehealthdto-v1 +title: SourcehealthdtoV1 +pagination_label: SourcehealthdtoV1 +sidebar_label: SourcehealthdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcehealthdtoV1', 'v1SourcehealthdtoV1'] +slug: /tools/sdk/typescript/sources/models/sourcehealthdto-v1 +tags: ['SDK', 'Software Development Kit', 'SourcehealthdtoV1', 'v1SourcehealthdtoV1'] +--- + +# SourcehealthdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | the id of the Source | [readonly] [default to undefined] +**type** | **(optional)** **string** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [default to undefined] +**name** | **(optional)** **string** | the name of the source | [default to undefined] +**org** | **(optional)** **string** | source\'s org | [default to undefined] +**isAuthoritative** | **(optional)** **boolean** | Is the source authoritative | [default to undefined] +**isCluster** | **(optional)** **boolean** | Is the source in a cluster | [default to undefined] +**hostname** | **(optional)** **string** | source\'s hostname | [default to undefined] +**pod** | **(optional)** **string** | source\'s pod | [default to undefined] +**iqServiceVersion** | **(optional)** **string** | The version of the iqService | [default to undefined] +**status** | **(optional)** **string** | connection test result | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Sourcesyncjob.md b/sdk-output/sources/docs/Models/Sourcesyncjob.md new file mode 100644 index 00000000..8bcaefc7 --- /dev/null +++ b/sdk-output/sources/docs/Models/Sourcesyncjob.md @@ -0,0 +1,21 @@ +--- +id: v1-sourcesyncjob-v1 +title: SourcesyncjobV1 +pagination_label: SourcesyncjobV1 +sidebar_label: SourcesyncjobV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcesyncjobV1', 'v1SourcesyncjobV1'] +slug: /tools/sdk/typescript/sources/models/sourcesyncjob-v1 +tags: ['SDK', 'Software Development Kit', 'SourcesyncjobV1', 'v1SourcesyncjobV1'] +--- + +# SourcesyncjobV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Job ID. | [default to undefined] +**status** | **string** | The job status. | [default to undefined] +**payload** | **SourcesyncpayloadV1** | | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Sourcesyncpayload.md b/sdk-output/sources/docs/Models/Sourcesyncpayload.md new file mode 100644 index 00000000..d0077700 --- /dev/null +++ b/sdk-output/sources/docs/Models/Sourcesyncpayload.md @@ -0,0 +1,20 @@ +--- +id: v1-sourcesyncpayload-v1 +title: SourcesyncpayloadV1 +pagination_label: SourcesyncpayloadV1 +sidebar_label: SourcesyncpayloadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcesyncpayloadV1', 'v1SourcesyncpayloadV1'] +slug: /tools/sdk/typescript/sources/models/sourcesyncpayload-v1 +tags: ['SDK', 'Software Development Kit', 'SourcesyncpayloadV1', 'v1SourcesyncpayloadV1'] +--- + +# SourcesyncpayloadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Payload type. | [default to undefined] +**dataJson** | **string** | Payload type. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Statusresponse.md b/sdk-output/sources/docs/Models/Statusresponse.md new file mode 100644 index 00000000..572bd738 --- /dev/null +++ b/sdk-output/sources/docs/Models/Statusresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-statusresponse-v1 +title: StatusresponseV1 +pagination_label: StatusresponseV1 +sidebar_label: StatusresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StatusresponseV1', 'v1StatusresponseV1'] +slug: /tools/sdk/typescript/sources/models/statusresponse-v1 +tags: ['SDK', 'Software Development Kit', 'StatusresponseV1', 'v1StatusresponseV1'] +--- + +# StatusresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the source | [readonly] [default to undefined] +**name** | **(optional)** **string** | Name of the source | [readonly] [default to undefined] +**status** | **(optional)** **string** | The status of the health check. | [readonly] [default to undefined] +**elapsedMillis** | **(optional)** **number** | The number of milliseconds spent on the entire request. | [readonly] [default to undefined] +**details** | **(optional)** **object** | The document contains the results of the health check. The schema of this document depends on the type of source used. | [readonly] [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Taskresultdto.md b/sdk-output/sources/docs/Models/Taskresultdto.md new file mode 100644 index 00000000..f7ae854f --- /dev/null +++ b/sdk-output/sources/docs/Models/Taskresultdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taskresultdto-v1 +title: TaskresultdtoV1 +pagination_label: TaskresultdtoV1 +sidebar_label: TaskresultdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +slug: /tools/sdk/typescript/sources/models/taskresultdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaskresultdtoV1', 'v1TaskresultdtoV1'] +--- + +# TaskresultdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Task result DTO type. | [default to undefined] +**id** | **(optional)** **string** | Task result ID. | [default to undefined] +**name** | **(optional)** **string** | Task result display name. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Transform.md b/sdk-output/sources/docs/Models/Transform.md new file mode 100644 index 00000000..6dc42367 --- /dev/null +++ b/sdk-output/sources/docs/Models/Transform.md @@ -0,0 +1,21 @@ +--- +id: v1-transform-v1 +title: TransformV1 +pagination_label: TransformV1 +sidebar_label: TransformV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransformV1', 'v1TransformV1'] +slug: /tools/sdk/typescript/sources/models/transform-v1 +tags: ['SDK', 'Software Development Kit', 'TransformV1', 'v1TransformV1'] +--- + +# TransformV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Unique name of this transform | [default to undefined] +**type** | **string** | The type of transform operation | [default to undefined] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [default to undefined] + diff --git a/sdk-output/sources/docs/Models/Transformread.md b/sdk-output/sources/docs/Models/Transformread.md new file mode 100644 index 00000000..3a22db14 --- /dev/null +++ b/sdk-output/sources/docs/Models/Transformread.md @@ -0,0 +1,23 @@ +--- +id: v1-transformread-v1 +title: TransformreadV1 +pagination_label: TransformreadV1 +sidebar_label: TransformreadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransformreadV1', 'v1TransformreadV1'] +slug: /tools/sdk/typescript/sources/models/transformread-v1 +tags: ['SDK', 'Software Development Kit', 'TransformreadV1', 'v1TransformreadV1'] +--- + +# TransformreadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Unique name of this transform | [default to undefined] +**type** | **string** | The type of transform operation | [default to undefined] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [default to undefined] +**id** | **string** | Unique ID of this transform | [default to undefined] +**internal** | **boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + diff --git a/sdk-output/sources/docs/Models/Usagetype.md b/sdk-output/sources/docs/Models/Usagetype.md new file mode 100644 index 00000000..0e7ae7e9 --- /dev/null +++ b/sdk-output/sources/docs/Models/Usagetype.md @@ -0,0 +1,49 @@ +--- +id: v1-usagetype-v1 +title: UsagetypeV1 +pagination_label: UsagetypeV1 +sidebar_label: UsagetypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UsagetypeV1', 'v1UsagetypeV1'] +slug: /tools/sdk/typescript/sources/models/usagetype-v1 +tags: ['SDK', 'Software Development Kit', 'UsagetypeV1', 'v1UsagetypeV1'] +--- + +# UsagetypeV1 + +## Enum + + +* `Create` (value: `'CREATE'`) + +* `Update` (value: `'UPDATE'`) + +* `Enable` (value: `'ENABLE'`) + +* `Disable` (value: `'DISABLE'`) + +* `Delete` (value: `'DELETE'`) + +* `Assign` (value: `'ASSIGN'`) + +* `Unassign` (value: `'UNASSIGN'`) + +* `CreateGroup` (value: `'CREATE_GROUP'`) + +* `UpdateGroup` (value: `'UPDATE_GROUP'`) + +* `DeleteGroup` (value: `'DELETE_GROUP'`) + +* `Register` (value: `'REGISTER'`) + +* `CreateIdentity` (value: `'CREATE_IDENTITY'`) + +* `UpdateIdentity` (value: `'UPDATE_IDENTITY'`) + +* `EditGroup` (value: `'EDIT_GROUP'`) + +* `Unlock` (value: `'UNLOCK'`) + +* `ChangePassword` (value: `'CHANGE_PASSWORD'`) + + diff --git a/sdk-output/sp_config/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/sp_config/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..43f3e73b --- /dev/null +++ b/sdk-output/sp_config/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,106 @@ +- path: /sp-config/v1/export + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#export-sp-config-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const exportpayloadV1: ExportpayloadV1 = {"description":"Export all available objects","excludeTypes":[],"includeTypes":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","CONNECTOR_RULE","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SEGMENT","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TAG","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOW"],"objectOptions":{}}; // ExportpayloadV1 | Export options control what will be included in the export. + const result = await apiInstance.exportSpConfigV1(exportpayloadV1); + console.log(result); +- path: /sp-config/v1/export/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#get-sp-config-export-status-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the export job whose status will be returned. (default to undefined) + const result = await apiInstance.getSpConfigExportStatusV1(id); + console.log(result); +- path: /sp-config/v1/export/{id}/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#get-sp-config-export-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the export job whose results will be downloaded. (default to undefined) + const result = await apiInstance.getSpConfigExportV1(id); + console.log(result); +- path: /sp-config/v1/import/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#get-sp-config-import-status-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the import job whose status will be returned. (default to undefined) + const result = await apiInstance.getSpConfigImportStatusV1(id); + console.log(result); +- path: /sp-config/v1/import/{id}/download + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#get-sp-config-import-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the import job whose results will be downloaded. (default to undefined) + const result = await apiInstance.getSpConfigImportV1(id); + console.log(result); +- path: /sp-config/v1/import + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#import-sp-config-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const data: File = BINARY_DATA_HERE; // File | JSON file containing the objects to be imported. (default to undefined) + const preview: boolean = true; // boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to false) + const _options: ImportoptionsV1 = ; // ImportoptionsV1 | (optional) (default to undefined) + const result = await apiInstance.importSpConfigV1(data); + console.log(result); +- path: /sp-config/v1/config-objects + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/sp_config/methods/sp-config#list-sp-config-objects-v1 + source: | + import { SPConfigV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SPConfigV1Api(configuration); + const result = await apiInstance.listSpConfigObjectsV1(); + console.log(result); diff --git a/sdk-output/sp_config/docs/Methods/Index.md b/sdk-output/sp_config/docs/Methods/Index.md new file mode 100644 index 00000000..7de07e74 --- /dev/null +++ b/sdk-output/sp_config/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: sp_config-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: sp_config-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'sp_config', 'methods'] +slug: /tools/sdk/typescript/sp_config/methods +tags: ['SDK', 'Software Development Kit', 'sp_config', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/sp_config/docs/Methods/SPConfigV1Api.md b/sdk-output/sp_config/docs/Methods/SPConfigV1Api.md new file mode 100644 index 00000000..59f203b0 --- /dev/null +++ b/sdk-output/sp_config/docs/Methods/SPConfigV1Api.md @@ -0,0 +1,313 @@ +--- +id: v1-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SPConfig', 'v1SPConfig'] +slug: /tools/sdk/typescript/sp_config/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'v1SPConfig'] +--- + +# SPConfigV1Api + Import and export configuration for some objects between tenants. +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**export-sp-config-v1**](#export-sp-config-v1) | **POST** `/sp-config/v1/export` | Initiates configuration objects export job +[**get-sp-config-export-status-v1**](#get-sp-config-export-status-v1) | **GET** `/sp-config/v1/export/{id}` | Get export job status +[**get-sp-config-export-v1**](#get-sp-config-export-v1) | **GET** `/sp-config/v1/export/{id}/download` | Download export job result. +[**get-sp-config-import-status-v1**](#get-sp-config-import-status-v1) | **GET** `/sp-config/v1/import/{id}` | Get import job status +[**get-sp-config-import-v1**](#get-sp-config-import-v1) | **GET** `/sp-config/v1/import/{id}/download` | Download import job result +[**import-sp-config-v1**](#import-sp-config-v1) | **POST** `/sp-config/v1/import` | Initiates configuration objects import job +[**list-sp-config-objects-v1**](#list-sp-config-objects-v1) | **GET** `/sp-config/v1/config-objects` | List config objects + + +## export-sp-config-v1 +Initiates configuration objects export job +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + +[API Spec](https://developer.sailpoint.com/docs/api/v1/export-sp-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**exportpayloadV1** | **ExportpayloadV1** | Export options control what will be included in the export. | + +### Return type + +**SpconfigexportjobV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const exportpayloadV1: ExportpayloadV1 = {"description":"Export all available objects","excludeTypes":[],"includeTypes":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","CONNECTOR_RULE","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SEGMENT","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TAG","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOW"],"objectOptions":{}}; // Export options control what will be included in the export. +const result = await apiInstance.exportSpConfigV1(exportpayloadV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-sp-config-export-status-v1 +Get export job status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sp-config-export-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the export job whose status will be returned. | [default to undefined] + +### Return type + +**SpconfigexportjobstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the export job whose status will be returned. +const result = await apiInstance.getSpConfigExportStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sp-config-export-v1 +Download export job result. +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sp-config-export-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the export job whose results will be downloaded. | [default to undefined] + +### Return type + +**SpconfigexportresultsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the export job whose results will be downloaded. +const result = await apiInstance.getSpConfigExportV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sp-config-import-status-v1 +Get import job status +'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects).' + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sp-config-import-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the import job whose status will be returned. | [default to undefined] + +### Return type + +**SpconfigimportjobstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the import job whose status will be returned. +const result = await apiInstance.getSpConfigImportStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-sp-config-import-v1 +Download import job result +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sp-config-import-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the import job whose results will be downloaded. | [default to undefined] + +### Return type + +**SpconfigimportresultsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the import job whose results will be downloaded. +const result = await apiInstance.getSpConfigImportV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## import-sp-config-v1 +Initiates configuration objects import job +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/docs/extensibility/configuration-management/saas-configuration#supported-objects). + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/import-sp-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**data** | **File** | JSON file containing the objects to be imported. | [default to undefined] +**preview** | **boolean** | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. | [optional] [default to false] +**_options** | **ImportoptionsV1** | | [optional] [default to undefined] + +### Return type + +**SpconfigjobV1** + +### HTTP request headers + +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const data: File = BINARY_DATA_HERE; // JSON file containing the objects to be imported. +const preview: boolean = true; // This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) +const _options: ImportoptionsV1 = ; // (optional) +const result = await apiInstance.importSpConfigV1(data); +console.log(result); +``` + +[[Back to top]](#) + +## list-sp-config-objects-v1 +List config objects +Get a list of object configurations that the tenant export/import service knows. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-sp-config-objects-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SPConfigV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SPConfigV1Api(configuration); +const result = await apiInstance.listSpConfigObjectsV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/sp_config/docs/Models/Configobject.md b/sdk-output/sp_config/docs/Models/Configobject.md new file mode 100644 index 00000000..d47b11aa --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Configobject.md @@ -0,0 +1,21 @@ +--- +id: v1-configobject-v1 +title: ConfigobjectV1 +pagination_label: ConfigobjectV1 +sidebar_label: ConfigobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigobjectV1', 'v1ConfigobjectV1'] +slug: /tools/sdk/typescript/sp_config/models/configobject-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigobjectV1', 'v1ConfigobjectV1'] +--- + +# ConfigobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **(optional)** **number** | Current version of configuration object. | [default to undefined] +**self** | **(optional)** **SelfimportexportdtoV1** | | [default to undefined] +**object** | **(optional)** | Object details. Format dependant on the object type. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Errormessagedto.md b/sdk-output/sp_config/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..4592f59e --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/sp_config/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Errorresponsedto.md b/sdk-output/sp_config/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..4a138fdc --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/sp_config/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/ExportSpConfigV1401Response.md b/sdk-output/sp_config/docs/Models/ExportSpConfigV1401Response.md new file mode 100644 index 00000000..71312659 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/ExportSpConfigV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-export-sp-config-v1401-response-v1 +title: ExportSpConfigV1401ResponseV1 +pagination_label: ExportSpConfigV1401ResponseV1 +sidebar_label: ExportSpConfigV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportSpConfigV1401ResponseV1', 'v1ExportSpConfigV1401ResponseV1'] +slug: /tools/sdk/typescript/sp_config/models/export-sp-config-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ExportSpConfigV1401ResponseV1', 'v1ExportSpConfigV1401ResponseV1'] +--- + +# ExportSpConfigV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/ExportSpConfigV1429Response.md b/sdk-output/sp_config/docs/Models/ExportSpConfigV1429Response.md new file mode 100644 index 00000000..a0802c58 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/ExportSpConfigV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-export-sp-config-v1429-response-v1 +title: ExportSpConfigV1429ResponseV1 +pagination_label: ExportSpConfigV1429ResponseV1 +sidebar_label: ExportSpConfigV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportSpConfigV1429ResponseV1', 'v1ExportSpConfigV1429ResponseV1'] +slug: /tools/sdk/typescript/sp_config/models/export-sp-config-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ExportSpConfigV1429ResponseV1', 'v1ExportSpConfigV1429ResponseV1'] +--- + +# ExportSpConfigV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Exportoptions.md b/sdk-output/sp_config/docs/Models/Exportoptions.md new file mode 100644 index 00000000..1ef33963 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Exportoptions.md @@ -0,0 +1,21 @@ +--- +id: v1-exportoptions-v1 +title: ExportoptionsV1 +pagination_label: ExportoptionsV1 +sidebar_label: ExportoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportoptionsV1', 'v1ExportoptionsV1'] +slug: /tools/sdk/typescript/sp_config/models/exportoptions-v1 +tags: ['SDK', 'Software Development Kit', 'ExportoptionsV1', 'v1ExportoptionsV1'] +--- + +# ExportoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**excludeTypes** | **(optional)** **Array<string>** | Object type names to be excluded from an sp-config export command. | [default to undefined] +**includeTypes** | **(optional)** **Array<string>** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [default to undefined] +**objectOptions** | **(optional)** | Additional options targeting specific objects related to each item in the includeTypes field | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Exportpayload.md b/sdk-output/sp_config/docs/Models/Exportpayload.md new file mode 100644 index 00000000..86297197 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Exportpayload.md @@ -0,0 +1,22 @@ +--- +id: v1-exportpayload-v1 +title: ExportpayloadV1 +pagination_label: ExportpayloadV1 +sidebar_label: ExportpayloadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ExportpayloadV1', 'v1ExportpayloadV1'] +slug: /tools/sdk/typescript/sp_config/models/exportpayload-v1 +tags: ['SDK', 'Software Development Kit', 'ExportpayloadV1', 'v1ExportpayloadV1'] +--- + +# ExportpayloadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **(optional)** **string** | Optional user defined description/name for export job. | [default to undefined] +**excludeTypes** | **(optional)** **Array<string>** | Object type names to be excluded from an sp-config export command. | [default to undefined] +**includeTypes** | **(optional)** **Array<string>** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [default to undefined] +**objectOptions** | **(optional)** | Additional options targeting specific objects related to each item in the includeTypes field | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/ImportSpConfigV1Request.md b/sdk-output/sp_config/docs/Models/ImportSpConfigV1Request.md new file mode 100644 index 00000000..e394dd07 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/ImportSpConfigV1Request.md @@ -0,0 +1,20 @@ +--- +id: v1-import-sp-config-v1-request-v1 +title: ImportSpConfigV1RequestV1 +pagination_label: ImportSpConfigV1RequestV1 +sidebar_label: ImportSpConfigV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportSpConfigV1RequestV1', 'v1ImportSpConfigV1RequestV1'] +slug: /tools/sdk/typescript/sp_config/models/import-sp-config-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigV1RequestV1', 'v1ImportSpConfigV1RequestV1'] +--- + +# ImportSpConfigV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **File** | JSON file containing the objects to be imported. | [default to undefined] +**_options** | **(optional)** **ImportoptionsV1** | | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Importobject.md b/sdk-output/sp_config/docs/Models/Importobject.md new file mode 100644 index 00000000..0c8e22f3 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Importobject.md @@ -0,0 +1,21 @@ +--- +id: v1-importobject-v1 +title: ImportobjectV1 +pagination_label: ImportobjectV1 +sidebar_label: ImportobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportobjectV1', 'v1ImportobjectV1'] +slug: /tools/sdk/typescript/sp_config/models/importobject-v1 +tags: ['SDK', 'Software Development Kit', 'ImportobjectV1', 'v1ImportobjectV1'] +--- + +# ImportobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of object created or updated by import. | [default to undefined] +**id** | **(optional)** **string** | ID of object created or updated by import. | [default to undefined] +**name** | **(optional)** **string** | Display name of object created or updated by import. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Importoptions.md b/sdk-output/sp_config/docs/Models/Importoptions.md new file mode 100644 index 00000000..2859eec2 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Importoptions.md @@ -0,0 +1,23 @@ +--- +id: v1-importoptions-v1 +title: ImportoptionsV1 +pagination_label: ImportoptionsV1 +sidebar_label: ImportoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ImportoptionsV1', 'v1ImportoptionsV1'] +slug: /tools/sdk/typescript/sp_config/models/importoptions-v1 +tags: ['SDK', 'Software Development Kit', 'ImportoptionsV1', 'v1ImportoptionsV1'] +--- + +# ImportoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**excludeTypes** | **(optional)** **Array<string>** | Object type names to be excluded from an sp-config export command. | [default to undefined] +**includeTypes** | **(optional)** **Array<string>** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [default to undefined] +**objectOptions** | **(optional)** | Additional options targeting specific objects related to each item in the includeTypes field | [default to undefined] +**defaultReferences** | **(optional)** **Array<string>** | List of object types that can be used to resolve references on import. | [default to undefined] +**excludeBackup** | **(optional)** **boolean** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [default to false] + diff --git a/sdk-output/sp_config/docs/Models/Index.md b/sdk-output/sp_config/docs/Models/Index.md new file mode 100644 index 00000000..691688a8 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: sp_config-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: sp_config-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'sp_config', 'models'] +slug: /tools/sdk/typescript/sp_config/models +tags: ['SDK', 'Software Development Kit', 'sp_config', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/sp_config/docs/Models/Localeorigin.md b/sdk-output/sp_config/docs/Models/Localeorigin.md new file mode 100644 index 00000000..89ce09bf --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/sp_config/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/sp_config/docs/Models/Objectexportimportoptions.md b/sdk-output/sp_config/docs/Models/Objectexportimportoptions.md new file mode 100644 index 00000000..eb4775ed --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Objectexportimportoptions.md @@ -0,0 +1,20 @@ +--- +id: v1-objectexportimportoptions-v1 +title: ObjectexportimportoptionsV1 +pagination_label: ObjectexportimportoptionsV1 +sidebar_label: ObjectexportimportoptionsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ObjectexportimportoptionsV1', 'v1ObjectexportimportoptionsV1'] +slug: /tools/sdk/typescript/sp_config/models/objectexportimportoptions-v1 +tags: ['SDK', 'Software Development Kit', 'ObjectexportimportoptionsV1', 'v1ObjectexportimportoptionsV1'] +--- + +# ObjectexportimportoptionsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**includedIds** | **(optional)** **Array<string>** | Object ids to be included in an import or export. | [default to undefined] +**includedNames** | **(optional)** **Array<string>** | Object names to be included in an import or export. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Objectimportresult2.md b/sdk-output/sp_config/docs/Models/Objectimportresult2.md new file mode 100644 index 00000000..99478aad --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Objectimportresult2.md @@ -0,0 +1,22 @@ +--- +id: v1-objectimportresult2-v1 +title: Objectimportresult2V1 +pagination_label: Objectimportresult2V1 +sidebar_label: Objectimportresult2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Objectimportresult2V1', 'v1Objectimportresult2V1'] +slug: /tools/sdk/typescript/sp_config/models/objectimportresult2-v1 +tags: ['SDK', 'Software Development Kit', 'Objectimportresult2V1', 'v1Objectimportresult2V1'] +--- + +# Objectimportresult2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**infos** | **Array<Spconfigmessage2V1>** | Informational messages returned from the target service on import. | [default to undefined] +**warnings** | **Array<Spconfigmessage2V1>** | Warning messages returned from the target service on import. | [default to undefined] +**errors** | **Array<Spconfigmessage2V1>** | Error messages returned from the target service on import. | [default to undefined] +**importedObjects** | **Array<ImportobjectV1>** | References to objects that were created or updated by the import. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/README.md b/sdk-output/sp_config/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/sp_config/docs/Models/Selfimportexportdto.md b/sdk-output/sp_config/docs/Models/Selfimportexportdto.md new file mode 100644 index 00000000..3951cdf2 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Selfimportexportdto.md @@ -0,0 +1,21 @@ +--- +id: v1-selfimportexportdto-v1 +title: SelfimportexportdtoV1 +pagination_label: SelfimportexportdtoV1 +sidebar_label: SelfimportexportdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SelfimportexportdtoV1', 'v1SelfimportexportdtoV1'] +slug: /tools/sdk/typescript/sp_config/models/selfimportexportdto-v1 +tags: ['SDK', 'Software Development Kit', 'SelfimportexportdtoV1', 'v1SelfimportexportdtoV1'] +--- + +# SelfimportexportdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Imported/exported object\'s DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [default to undefined] +**id** | **(optional)** **string** | Imported/exported object\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Imported/exported object\'s display name. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigexportjob.md b/sdk-output/sp_config/docs/Models/Spconfigexportjob.md new file mode 100644 index 00000000..1f0f16ca --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigexportjob.md @@ -0,0 +1,25 @@ +--- +id: v1-spconfigexportjob-v1 +title: SpconfigexportjobV1 +pagination_label: SpconfigexportjobV1 +sidebar_label: SpconfigexportjobV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigexportjobV1', 'v1SpconfigexportjobV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigexportjob-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigexportjobV1', 'v1SpconfigexportjobV1'] +--- + +# SpconfigexportjobV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **string** | Unique id assigned to this job. | [default to undefined] +**status** | **string** | Status of the job. | [default to undefined] +**type** | **string** | Type of the job, either export or import. | [default to undefined] +**expiration** | **(optional)** **string** | The time until which the artifacts will be available for download. | [default to undefined] +**created** | **string** | The time the job was started. | [default to undefined] +**modified** | **string** | The time of the last update to the job. | [default to undefined] +**description** | **(optional)** **string** | Optional user defined description/name for export job. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigexportjobstatus.md b/sdk-output/sp_config/docs/Models/Spconfigexportjobstatus.md new file mode 100644 index 00000000..44857bd5 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigexportjobstatus.md @@ -0,0 +1,26 @@ +--- +id: v1-spconfigexportjobstatus-v1 +title: SpconfigexportjobstatusV1 +pagination_label: SpconfigexportjobstatusV1 +sidebar_label: SpconfigexportjobstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigexportjobstatusV1', 'v1SpconfigexportjobstatusV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigexportjobstatus-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigexportjobstatusV1', 'v1SpconfigexportjobstatusV1'] +--- + +# SpconfigexportjobstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **string** | Unique id assigned to this job. | [default to undefined] +**status** | **string** | Status of the job. | [default to undefined] +**type** | **string** | Type of the job, either export or import. | [default to undefined] +**expiration** | **(optional)** **string** | The time until which the artifacts will be available for download. | [default to undefined] +**created** | **string** | The time the job was started. | [default to undefined] +**modified** | **string** | The time of the last update to the job. | [default to undefined] +**description** | **(optional)** **string** | Optional user defined description/name for export job. | [default to undefined] +**completed** | **(optional)** **string** | The time the job was completed. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigexportresults.md b/sdk-output/sp_config/docs/Models/Spconfigexportresults.md new file mode 100644 index 00000000..c293921e --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigexportresults.md @@ -0,0 +1,24 @@ +--- +id: v1-spconfigexportresults-v1 +title: SpconfigexportresultsV1 +pagination_label: SpconfigexportresultsV1 +sidebar_label: SpconfigexportresultsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigexportresultsV1', 'v1SpconfigexportresultsV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigexportresults-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigexportresultsV1', 'v1SpconfigexportresultsV1'] +--- + +# SpconfigexportresultsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**version** | **(optional)** **number** | Current version of the export results object. | [default to undefined] +**timestamp** | **(optional)** **string** | Time the export was completed. | [default to undefined] +**tenant** | **(optional)** **string** | Name of the tenant where this export originated. | [default to undefined] +**description** | **(optional)** **string** | Optional user defined description/name for export job. | [default to undefined] +**_options** | **(optional)** **ExportoptionsV1** | | [default to undefined] +**objects** | **(optional)** **Array<ConfigobjectV1>** | | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigimportjobstatus.md b/sdk-output/sp_config/docs/Models/Spconfigimportjobstatus.md new file mode 100644 index 00000000..1772c281 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigimportjobstatus.md @@ -0,0 +1,26 @@ +--- +id: v1-spconfigimportjobstatus-v1 +title: SpconfigimportjobstatusV1 +pagination_label: SpconfigimportjobstatusV1 +sidebar_label: SpconfigimportjobstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigimportjobstatusV1', 'v1SpconfigimportjobstatusV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigimportjobstatus-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigimportjobstatusV1', 'v1SpconfigimportjobstatusV1'] +--- + +# SpconfigimportjobstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **string** | Unique id assigned to this job. | [default to undefined] +**status** | **string** | Status of the job. | [default to undefined] +**type** | **string** | Type of the job, either export or import. | [default to undefined] +**expiration** | **(optional)** **string** | The time until which the artifacts will be available for download. | [default to undefined] +**created** | **string** | The time the job was started. | [default to undefined] +**modified** | **string** | The time of the last update to the job. | [default to undefined] +**message** | **(optional)** **string** | This message contains additional information about the overall status of the job. | [default to undefined] +**completed** | **(optional)** **string** | The time the job was completed. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigimportresults.md b/sdk-output/sp_config/docs/Models/Spconfigimportresults.md new file mode 100644 index 00000000..43d20e87 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigimportresults.md @@ -0,0 +1,20 @@ +--- +id: v1-spconfigimportresults-v1 +title: SpconfigimportresultsV1 +pagination_label: SpconfigimportresultsV1 +sidebar_label: SpconfigimportresultsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigimportresultsV1', 'v1SpconfigimportresultsV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigimportresults-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigimportresultsV1', 'v1SpconfigimportresultsV1'] +--- + +# SpconfigimportresultsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | | The results of an object configuration import job. | [default to undefined] +**exportJobId** | **(optional)** **string** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigjob.md b/sdk-output/sp_config/docs/Models/Spconfigjob.md new file mode 100644 index 00000000..3d1db2a8 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigjob.md @@ -0,0 +1,24 @@ +--- +id: v1-spconfigjob-v1 +title: SpconfigjobV1 +pagination_label: SpconfigjobV1 +sidebar_label: SpconfigjobV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigjobV1', 'v1SpconfigjobV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigjob-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigjobV1', 'v1SpconfigjobV1'] +--- + +# SpconfigjobV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jobId** | **string** | Unique id assigned to this job. | [default to undefined] +**status** | **string** | Status of the job. | [default to undefined] +**type** | **string** | Type of the job, either export or import. | [default to undefined] +**expiration** | **(optional)** **string** | The time until which the artifacts will be available for download. | [default to undefined] +**created** | **string** | The time the job was started. | [default to undefined] +**modified** | **string** | The time of the last update to the job. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigmessage2.md b/sdk-output/sp_config/docs/Models/Spconfigmessage2.md new file mode 100644 index 00000000..c7aa95e5 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigmessage2.md @@ -0,0 +1,21 @@ +--- +id: v1-spconfigmessage2-v1 +title: Spconfigmessage2V1 +pagination_label: Spconfigmessage2V1 +sidebar_label: Spconfigmessage2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Spconfigmessage2V1', 'v1Spconfigmessage2V1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigmessage2-v1 +tags: ['SDK', 'Software Development Kit', 'Spconfigmessage2V1', 'v1Spconfigmessage2V1'] +--- + +# Spconfigmessage2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **string** | Message key. | [default to undefined] +**text** | **string** | Message text. | [default to undefined] +**details** | | Message details if any, in key:value pairs. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigobject.md b/sdk-output/sp_config/docs/Models/Spconfigobject.md new file mode 100644 index 00000000..ec3d8e94 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigobject.md @@ -0,0 +1,26 @@ +--- +id: v1-spconfigobject-v1 +title: SpconfigobjectV1 +pagination_label: SpconfigobjectV1 +sidebar_label: SpconfigobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigobjectV1', 'v1SpconfigobjectV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigobject-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigobjectV1', 'v1SpconfigobjectV1'] +--- + +# SpconfigobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectType** | **(optional)** **string** | Object type the configuration is for. | [default to undefined] +**referenceExtractors** | **(optional)** **Array<string>** | List of JSON paths within an exported object of this type, representing references that must be resolved. | [default to undefined] +**signatureRequired** | **(optional)** **boolean** | Indicates whether this type of object will be JWS signed and cannot be modified before import. | [default to false] +**alwaysResolveById** | **(optional)** **boolean** | Indicates whether this object type must be always be resolved by ID. | [default to false] +**legacyObject** | **(optional)** **boolean** | Indicates whether this is a legacy object. | [default to false] +**onePerTenant** | **(optional)** **boolean** | Indicates whether there is only one object of this type. | [default to false] +**exportable** | **(optional)** **boolean** | Indicates whether the object can be exported or is just a reference object. | [default to false] +**rules** | **(optional)** **SpconfigrulesV1** | | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/Spconfigrule.md b/sdk-output/sp_config/docs/Models/Spconfigrule.md new file mode 100644 index 00000000..c8226ac1 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigrule.md @@ -0,0 +1,21 @@ +--- +id: v1-spconfigrule-v1 +title: SpconfigruleV1 +pagination_label: SpconfigruleV1 +sidebar_label: SpconfigruleV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigruleV1', 'v1SpconfigruleV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigrule-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigruleV1', 'v1SpconfigruleV1'] +--- + +# SpconfigruleV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**path** | **(optional)** **string** | JSONPath expression denoting the path within the object where a value substitution should be applied. | [default to undefined] +**value** | **(optional)** **SpconfigruleValueV1** | | [default to undefined] +**modes** | **(optional)** **Array<string>** | Draft modes the rule will apply to. | [default to undefined] + diff --git a/sdk-output/sp_config/docs/Models/SpconfigruleValue.md b/sdk-output/sp_config/docs/Models/SpconfigruleValue.md new file mode 100644 index 00000000..5fef6b89 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/SpconfigruleValue.md @@ -0,0 +1,18 @@ +--- +id: v1-spconfigrule-value-v1 +title: SpconfigruleValueV1 +pagination_label: SpconfigruleValueV1 +sidebar_label: SpconfigruleValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigruleValueV1', 'v1SpconfigruleValueV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigrule-value-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigruleValueV1', 'v1SpconfigruleValueV1'] +--- + +# SpconfigruleValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/sp_config/docs/Models/Spconfigrules.md b/sdk-output/sp_config/docs/Models/Spconfigrules.md new file mode 100644 index 00000000..d71e93c3 --- /dev/null +++ b/sdk-output/sp_config/docs/Models/Spconfigrules.md @@ -0,0 +1,21 @@ +--- +id: v1-spconfigrules-v1 +title: SpconfigrulesV1 +pagination_label: SpconfigrulesV1 +sidebar_label: SpconfigrulesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SpconfigrulesV1', 'v1SpconfigrulesV1'] +slug: /tools/sdk/typescript/sp_config/models/spconfigrules-v1 +tags: ['SDK', 'Software Development Kit', 'SpconfigrulesV1', 'v1SpconfigrulesV1'] +--- + +# SpconfigrulesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**takeFromTargetRules** | **(optional)** **Array<SpconfigruleV1>** | | [default to undefined] +**defaultRules** | **(optional)** **Array<SpconfigruleV1>** | | [default to undefined] +**editable** | **(optional)** **boolean** | Indicates whether the object can be edited. | [default to false] + diff --git a/sdk-output/suggested_entitlement_description/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/suggested_entitlement_description/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..f385e650 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,239 @@ +- path: /entitlement-recommendations/v1/bulk-approve + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#approve-bulk-entitlement-recommendations-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const bulkapproveentitlementrecommendationrequestV1: BulkapproveentitlementrecommendationrequestV1 = ; // BulkapproveentitlementrecommendationrequestV1 | The list of recommendation items to approve. + const result = await apiInstance.approveBulkEntitlementRecommendationsV1(bulkapproveentitlementrecommendationrequestV1); + console.log(result); +- path: /suggested-entitlement-descriptions/v1/auto-write-settings + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#create-auto-write-settings-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const autowritesettingV1: AutowritesettingV1 = ; // AutowritesettingV1 | Auto-write settings to create + const result = await apiInstance.createAutoWriteSettingsV1(autowritesettingV1); + console.log(result); +- path: /suggested-entitlement-descriptions/v1/auto-write-settings + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#get-auto-write-settings-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const result = await apiInstance.getAutoWriteSettingsV1(); + console.log(result); +- path: /suggested-entitlement-description-batches/v1/{batchId}/stats + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#get-sed-batch-stats-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const batchId: string = '8c190e67-87aa-4ed9-a90b-d9d5344523fb'; // string | Batch Id (default to undefined) + const result = await apiInstance.getSedBatchStatsV1(batchId); + console.log(result); +- path: /suggested-entitlement-description-batches/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#get-sed-batches-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const offset: number = 0; // number | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + const limit: number = 250; // number | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + const count: boolean = true; // boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to false) + const countOnly: boolean = true; // boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + const status: string = 'completed, failed, submitted, materialized, failed'; // string | Batch Status (optional) (default to undefined) + const result = await apiInstance.getSedBatchesV1(); + console.log(result); +- path: /entitlement-recommendations/v1/pending-approvals + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#list-pending-entitlement-recommendation-approvals-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.listPendingEntitlementRecommendationApprovalsV1(); + console.log(result); +- path: /privileged-recommendations/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#list-privileged-entitlement-recommendations-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const result = await apiInstance.listPrivilegedEntitlementRecommendationsV1(); + console.log(result); +- path: /suggested-entitlement-descriptions/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#list-seds-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'displayName co "Read and Write"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) (default to undefined) + const sorters: string = 'sorters=displayName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) (default to undefined) + const countOnly: boolean = count-only=true; // boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to false) + const requestedByAnyone: boolean = requested-by-anyone=true; // boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to false) + const showPendingStatusOnly: boolean = show-pending-status-only=true; // boolean | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to false) + const result = await apiInstance.listSedsV1(); + console.log(result); +- path: /entitlement-recommendations/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#patch-entitlement-recommendation-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const id: string = '79db50d4-723c-4aa0-a824-83c2205d82d1'; // string | The unique identifier of the entitlement recommendation to update. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | The patch operations to apply to the entitlement recommendation record. + const result = await apiInstance.patchEntitlementRecommendationV1(id, jsonpatchoperationV1); + console.log(result); +- path: /suggested-entitlement-descriptions/v1 + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#patch-sed-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const id: string = 'ebab396f-0af1-4050-89b7-dafc63ec70e7'; // string | id is sed id (default to undefined) + const sedpatchV1: Array<SedpatchV1> = ; // Array | Sed Patch Request + const result = await apiInstance.patchSedV1(id, sedpatchV1); + console.log(result); +- path: /entitlement-recommendations/v1/assign + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#submit-entitlement-recommendations-assignment-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const entitlementrecommendationassignrequestV1: EntitlementrecommendationassignrequestV1 = ; // EntitlementrecommendationassignrequestV1 | The recommendation IDs and the target assignee. + const result = await apiInstance.submitEntitlementRecommendationsAssignmentV1(entitlementrecommendationassignrequestV1); + console.log(result); +- path: /suggested-entitlement-description-approvals/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#submit-sed-approval-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const sedapprovalV1: Array<SedapprovalV1> = ; // Array | Sed Approval + const result = await apiInstance.submitSedApprovalV1(sedapprovalV1); + console.log(result); +- path: /suggested-entitlement-description-assignments/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#submit-sed-assignment-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const sedassignmentV1: SedassignmentV1 = ; // SedassignmentV1 | Sed Assignment Request + const result = await apiInstance.submitSedAssignmentV1(sedassignmentV1); + console.log(result); +- path: /suggested-entitlement-description-batches/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#submit-sed-batch-request-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const sedbatchrequestV1: SedbatchrequestV1 = ; // SedbatchrequestV1 | Sed Batch Request (optional) + const result = await apiInstance.submitSedBatchRequestV1(); + console.log(result); +- path: /suggested-entitlement-descriptions/v1/auto-write-settings + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description#update-auto-write-settings-v1 + source: | + import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); + const autowritesettingpatchV1: Array<AutowritesettingpatchV1> = ; // Array | Patch operations for auto-write settings + const result = await apiInstance.updateAutoWriteSettingsV1(autowritesettingpatchV1); + console.log(result); diff --git a/sdk-output/suggested_entitlement_description/docs/Methods/Index.md b/sdk-output/suggested_entitlement_description/docs/Methods/Index.md new file mode 100644 index 00000000..eea3cb7c --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: suggested_entitlement_description-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: suggested_entitlement_description-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'suggested_entitlement_description', 'methods'] +slug: /tools/sdk/typescript/suggested_entitlement_description/methods +tags: ['SDK', 'Software Development Kit', 'suggested_entitlement_description', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionV1Api.md b/sdk-output/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionV1Api.md new file mode 100644 index 00000000..2cb06324 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionV1Api.md @@ -0,0 +1,655 @@ +--- +id: v1-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SuggestedEntitlementDescription', 'v1SuggestedEntitlementDescription'] +slug: /tools/sdk/typescript/suggested_entitlement_description/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'v1SuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescriptionV1Api + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-bulk-entitlement-recommendations-v1**](#approve-bulk-entitlement-recommendations-v1) | **POST** `/entitlement-recommendations/v1/bulk-approve` | Bulk approve entitlement recommendations +[**create-auto-write-settings-v1**](#create-auto-write-settings-v1) | **POST** `/suggested-entitlement-descriptions/v1/auto-write-settings` | Create auto-write settings for SED +[**get-auto-write-settings-v1**](#get-auto-write-settings-v1) | **GET** `/suggested-entitlement-descriptions/v1/auto-write-settings` | Get auto-write settings for SED +[**get-sed-batch-stats-v1**](#get-sed-batch-stats-v1) | **GET** `/suggested-entitlement-description-batches/v1/{batchId}/stats` | Submit sed batch stats request +[**get-sed-batches-v1**](#get-sed-batches-v1) | **GET** `/suggested-entitlement-description-batches/v1` | List Sed Batch Record +[**list-pending-entitlement-recommendation-approvals-v1**](#list-pending-entitlement-recommendation-approvals-v1) | **GET** `/entitlement-recommendations/v1/pending-approvals` | List pending entitlement recommendation approvals +[**list-privileged-entitlement-recommendations-v1**](#list-privileged-entitlement-recommendations-v1) | **GET** `/privileged-recommendations/v1` | List privileged entitlement recommendations +[**list-seds-v1**](#list-seds-v1) | **GET** `/suggested-entitlement-descriptions/v1` | List suggested entitlement descriptions +[**patch-entitlement-recommendation-v1**](#patch-entitlement-recommendation-v1) | **PATCH** `/entitlement-recommendations/v1/{id}` | Update an entitlement recommendation +[**patch-sed-v1**](#patch-sed-v1) | **PATCH** `/suggested-entitlement-descriptions/v1` | Patch suggested entitlement description +[**submit-entitlement-recommendations-assignment-v1**](#submit-entitlement-recommendations-assignment-v1) | **POST** `/entitlement-recommendations/v1/assign` | Assign entitlement recommendations for review +[**submit-sed-approval-v1**](#submit-sed-approval-v1) | **POST** `/suggested-entitlement-description-approvals/v1` | Submit bulk approval request +[**submit-sed-assignment-v1**](#submit-sed-assignment-v1) | **POST** `/suggested-entitlement-description-assignments/v1` | Submit sed assignment request +[**submit-sed-batch-request-v1**](#submit-sed-batch-request-v1) | **POST** `/suggested-entitlement-description-batches/v1` | Submit sed batch request +[**update-auto-write-settings-v1**](#update-auto-write-settings-v1) | **PATCH** `/suggested-entitlement-descriptions/v1/auto-write-settings` | Update auto-write settings for SED + + +## approve-bulk-entitlement-recommendations-v1 +Bulk approve entitlement recommendations +Approve multiple entitlement recommendations in a single request. Each item in the request must include the recommendation ID and, depending on the record type, either an approved description (SED items) or an approved privilege level (privilege items). Returns a per-item result indicating success or failure. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-bulk-entitlement-recommendations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkapproveentitlementrecommendationrequestV1** | **BulkapproveentitlementrecommendationrequestV1** | The list of recommendation items to approve. | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const bulkapproveentitlementrecommendationrequestV1: BulkapproveentitlementrecommendationrequestV1 = ; // The list of recommendation items to approve. +const result = await apiInstance.approveBulkEntitlementRecommendationsV1(bulkapproveentitlementrecommendationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-auto-write-settings-v1 +Create auto-write settings for SED +Create the initial auto-write settings for a tenant. Returns 409 Conflict if settings already exist. Use PATCH to update existing settings. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-auto-write-settings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**autowritesettingV1** | **AutowritesettingV1** | Auto-write settings to create | + +### Return type + +**AutowritesettingresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const autowritesettingV1: AutowritesettingV1 = ; // Auto-write settings to create +const result = await apiInstance.createAutoWriteSettingsV1(autowritesettingV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-auto-write-settings-v1 +Get auto-write settings for SED +Get the current auto-write configuration for the tenant, including the enabled state and source include/exclude lists. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-auto-write-settings-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**AutowritesettingresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const result = await apiInstance.getAutoWriteSettingsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-sed-batch-stats-v1 +Submit sed batch stats request +'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sed-batch-stats-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**batchId** | **string** | Batch Id | [default to undefined] + +### Return type + +**SedbatchstatsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const batchId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // Batch Id +const result = await apiInstance.getSedBatchStatsV1(batchId); +console.log(result); +``` + +[[Back to top]](#) + +## get-sed-batches-v1 +List Sed Batch Record +List Sed Batches. +API responses with Sed Batch Records + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-sed-batches-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0] +**limit** | **number** | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250] +**count** | **boolean** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | [optional] [default to false] +**countOnly** | **boolean** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [optional] [default to false] +**status** | **string** | Batch Status | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) +const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +const count: boolean = true; // If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) +const countOnly: boolean = true; // If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) +const status: string = completed, failed, submitted, materialized, failed; // Batch Status (optional) +const result = await apiInstance.getSedBatchesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-pending-entitlement-recommendation-approvals-v1 +List pending entitlement recommendation approvals +Returns a list of entitlement recommendations (SED and/or privilege) that are currently awaiting review or approval. Each record includes the recommendation type, entitlement details, and any AI-generated suggestions. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-pending-entitlement-recommendation-approvals-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listPendingEntitlementRecommendationApprovalsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-privileged-entitlement-recommendations-v1 +List privileged entitlement recommendations +Returns a list of privileged entitlement recommendation groups. Each group aggregates individual entitlement instances that share the same entitlement name and connector type, along with a recommendation score and instance count. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-privileged-entitlement-recommendations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listPrivilegedEntitlementRecommendationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-seds-v1 +List suggested entitlement descriptions +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-seds-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** | [optional] [default to undefined] +**countOnly** | **boolean** | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. | [optional] [default to false] +**requestedByAnyone** | **boolean** | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested | [optional] [default to false] +**showPendingStatusOnly** | **boolean** | Will limit records to items that are in \"suggested\" or \"approved\" status | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = displayName co "Read and Write"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) +const sorters: string = sorters=displayName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) +const countOnly: boolean = count-only=true; // If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) +const requestedByAnyone: boolean = requested-by-anyone=true; // By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) +const showPendingStatusOnly: boolean = show-pending-status-only=true; // Will limit records to items that are in \"suggested\" or \"approved\" status (optional) +const result = await apiInstance.listSedsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-entitlement-recommendation-v1 +Update an entitlement recommendation +Partially update a single entitlement recommendation record by its ID. Use this endpoint to update the status, description, or privilege level of a specific SED or privilege recommendation. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-entitlement-recommendation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the entitlement recommendation to update. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The patch operations to apply to the entitlement recommendation record. | + +### Return type + +**EntitlementrecommendationrecordV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const id: string = 79db50d4-723c-4aa0-a824-83c2205d82d1; // The unique identifier of the entitlement recommendation to update. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // The patch operations to apply to the entitlement recommendation record. +const result = await apiInstance.patchEntitlementRecommendationV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## patch-sed-v1 +Patch suggested entitlement description +Patch Suggested Entitlement Description + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-sed-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | id is sed id | [default to undefined] +**sedpatchV1** | **Array<SedpatchV1>** | Sed Patch Request | + +### Return type + +**SedV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const id: string = ebab396f-0af1-4050-89b7-dafc63ec70e7; // id is sed id +const sedpatchV1: Array<SedpatchV1> = ; // Sed Patch Request +const result = await apiInstance.patchSedV1(id, sedpatchV1); +console.log(result); +``` + +[[Back to top]](#) + +## submit-entitlement-recommendations-assignment-v1 +Assign entitlement recommendations for review +Assign a set of entitlement recommendation records to a reviewer. The assignee can be a specific identity, a governance group, or a role-based assignee such as source owner or entitlement owner. Returns a batch ID that can be used to track the assignment. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-entitlement-recommendations-assignment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**entitlementrecommendationassignrequestV1** | **EntitlementrecommendationassignrequestV1** | The recommendation IDs and the target assignee. | + +### Return type + +**EntitlementrecommendationassignresultV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const entitlementrecommendationassignrequestV1: EntitlementrecommendationassignrequestV1 = ; // The recommendation IDs and the target assignee. +const result = await apiInstance.submitEntitlementRecommendationsAssignmentV1(entitlementrecommendationassignrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## submit-sed-approval-v1 +Submit bulk approval request +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-sed-approval-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sedapprovalV1** | **Array<SedapprovalV1>** | Sed Approval | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const sedapprovalV1: Array<SedapprovalV1> = ; // Sed Approval +const result = await apiInstance.submitSedApprovalV1(sedapprovalV1); +console.log(result); +``` + +[[Back to top]](#) + +## submit-sed-assignment-v1 +Submit sed assignment request +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-sed-assignment-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sedassignmentV1** | **SedassignmentV1** | Sed Assignment Request | + +### Return type + +**SedassignmentresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const sedassignmentV1: SedassignmentV1 = ; // Sed Assignment Request +const result = await apiInstance.submitSedAssignmentV1(sedassignmentV1); +console.log(result); +``` + +[[Back to top]](#) + +## submit-sed-batch-request-v1 +Submit sed batch request +Submit Sed Batch Request. +Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-sed-batch-request-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**sedbatchrequestV1** | **SedbatchrequestV1** | Sed Batch Request | [optional] + +### Return type + +**SedbatchresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const sedbatchrequestV1: SedbatchrequestV1 = ; // Sed Batch Request (optional) +const result = await apiInstance.submitSedBatchRequestV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-auto-write-settings-v1 +Update auto-write settings for SED +Partially update the auto-write settings for a tenant using JSON Patch operations. Only the "replace" operation is supported. Returns 404 if no settings exist yet - use POST to create them first. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-auto-write-settings-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**autowritesettingpatchV1** | **Array<AutowritesettingpatchV1>** | Patch operations for auto-write settings | + +### Return type + +**AutowritesettingresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { SuggestedEntitlementDescriptionV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new SuggestedEntitlementDescriptionV1Api(configuration); +const autowritesettingpatchV1: Array<AutowritesettingpatchV1> = ; // Patch operations for auto-write settings +const result = await apiInstance.updateAutoWriteSettingsV1(autowritesettingpatchV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/ArrayInner.md b/sdk-output/suggested_entitlement_description/docs/Models/ArrayInner.md new file mode 100644 index 00000000..d1d77e73 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Autowritesetting.md b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesetting.md new file mode 100644 index 00000000..d938bfd5 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesetting.md @@ -0,0 +1,21 @@ +--- +id: v1-autowritesetting-v1 +title: AutowritesettingV1 +pagination_label: AutowritesettingV1 +sidebar_label: AutowritesettingV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AutowritesettingV1', 'v1AutowritesettingV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/autowritesetting-v1 +tags: ['SDK', 'Software Development Kit', 'AutowritesettingV1', 'v1AutowritesettingV1'] +--- + +# AutowritesettingV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Whether auto-write is currently enabled for the tenant | [default to false] +**includedSourceIds** | **(optional)** **Array<string>** | Source IDs in the allowlist. Empty array means not in allowlist mode. | [default to undefined] +**excludedSourceIds** | **(optional)** **Array<string>** | Source IDs to exclude from auto-write. Always applied. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingpatch.md b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingpatch.md new file mode 100644 index 00000000..7d2db8d7 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingpatch.md @@ -0,0 +1,21 @@ +--- +id: v1-autowritesettingpatch-v1 +title: AutowritesettingpatchV1 +pagination_label: AutowritesettingpatchV1 +sidebar_label: AutowritesettingpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AutowritesettingpatchV1', 'v1AutowritesettingpatchV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/autowritesettingpatch-v1 +tags: ['SDK', 'Software Development Kit', 'AutowritesettingpatchV1', 'v1AutowritesettingpatchV1'] +--- + +# AutowritesettingpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to perform. Only \"replace\" is supported. | [default to undefined] +**path** | **string** | The field to update. Allowed values: /enabled, /includedSourceIds, /excludedSourceIds | [default to undefined] +**value** | **AutowritesettingpatchValueV1** | | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/AutowritesettingpatchValue.md b/sdk-output/suggested_entitlement_description/docs/Models/AutowritesettingpatchValue.md new file mode 100644 index 00000000..9eefc8ee --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/AutowritesettingpatchValue.md @@ -0,0 +1,18 @@ +--- +id: v1-autowritesettingpatch-value-v1 +title: AutowritesettingpatchValueV1 +pagination_label: AutowritesettingpatchValueV1 +sidebar_label: AutowritesettingpatchValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AutowritesettingpatchValueV1', 'v1AutowritesettingpatchValueV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/autowritesettingpatch-value-v1 +tags: ['SDK', 'Software Development Kit', 'AutowritesettingpatchValueV1', 'v1AutowritesettingpatchValueV1'] +--- + +# AutowritesettingpatchValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingresponse.md b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingresponse.md new file mode 100644 index 00000000..12bd9bab --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Autowritesettingresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-autowritesettingresponse-v1 +title: AutowritesettingresponseV1 +pagination_label: AutowritesettingresponseV1 +sidebar_label: AutowritesettingresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AutowritesettingresponseV1', 'v1AutowritesettingresponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/autowritesettingresponse-v1 +tags: ['SDK', 'Software Development Kit', 'AutowritesettingresponseV1', 'v1AutowritesettingresponseV1'] +--- + +# AutowritesettingresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **(optional)** **boolean** | Whether auto-write is currently enabled for the tenant | [default to false] +**includedSourceIds** | **(optional)** **Array<string>** | Source IDs in the allowlist. Empty array means not in allowlist mode. | [default to undefined] +**excludedSourceIds** | **(optional)** **Array<string>** | Source IDs to exclude from auto-write. Always applied. | [default to undefined] +**createdAt** | **(optional)** **string** | When settings were first created | [default to undefined] +**updatedAt** | **(optional)** **string** | When settings were last modified | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationitem.md b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationitem.md new file mode 100644 index 00000000..0e00fc6b --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationitem.md @@ -0,0 +1,22 @@ +--- +id: v1-bulkapproveentitlementrecommendationitem-v1 +title: BulkapproveentitlementrecommendationitemV1 +pagination_label: BulkapproveentitlementrecommendationitemV1 +sidebar_label: BulkapproveentitlementrecommendationitemV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkapproveentitlementrecommendationitemV1', 'v1BulkapproveentitlementrecommendationitemV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/bulkapproveentitlementrecommendationitem-v1 +tags: ['SDK', 'Software Development Kit', 'BulkapproveentitlementrecommendationitemV1', 'v1BulkapproveentitlementrecommendationitemV1'] +--- + +# BulkapproveentitlementrecommendationitemV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the recommendation record to approve. | [default to undefined] +**recordType** | **(optional)** **string** | The type of the recommendation. When omitted, the backend resolves the type by looking up the ID. | [default to undefined] +**description** | **(optional)** **string** | The approved description text. Required for SED-type items; ignored for privilege items. | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The approved privilege level. Required for privilege-type items; ignored for SED items. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationrequest.md b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationrequest.md new file mode 100644 index 00000000..4ab5c2b2 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-bulkapproveentitlementrecommendationrequest-v1 +title: BulkapproveentitlementrecommendationrequestV1 +pagination_label: BulkapproveentitlementrecommendationrequestV1 +sidebar_label: BulkapproveentitlementrecommendationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkapproveentitlementrecommendationrequestV1', 'v1BulkapproveentitlementrecommendationrequestV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/bulkapproveentitlementrecommendationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'BulkapproveentitlementrecommendationrequestV1', 'v1BulkapproveentitlementrecommendationrequestV1'] +--- + +# BulkapproveentitlementrecommendationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **Array<BulkapproveentitlementrecommendationitemV1>** | The list of recommendation items to approve. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationresult.md b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationresult.md new file mode 100644 index 00000000..bda3bf8e --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Bulkapproveentitlementrecommendationresult.md @@ -0,0 +1,21 @@ +--- +id: v1-bulkapproveentitlementrecommendationresult-v1 +title: BulkapproveentitlementrecommendationresultV1 +pagination_label: BulkapproveentitlementrecommendationresultV1 +sidebar_label: BulkapproveentitlementrecommendationresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkapproveentitlementrecommendationresultV1', 'v1BulkapproveentitlementrecommendationresultV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/bulkapproveentitlementrecommendationresult-v1 +tags: ['SDK', 'Software Development Kit', 'BulkapproveentitlementrecommendationresultV1', 'v1BulkapproveentitlementrecommendationresultV1'] +--- + +# BulkapproveentitlementrecommendationresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the processed recommendation record. | [default to undefined] +**status** | **(optional)** **string** | The outcome of the approval for this item. | [default to undefined] +**failedReason** | **(optional)** **string** | The reason for failure if status is FAILURE; null on success. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/CreateAutoWriteSettingsV1409Response.md b/sdk-output/suggested_entitlement_description/docs/Models/CreateAutoWriteSettingsV1409Response.md new file mode 100644 index 00000000..5d1d3846 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/CreateAutoWriteSettingsV1409Response.md @@ -0,0 +1,21 @@ +--- +id: v1-create-auto-write-settings-v1409-response-v1 +title: CreateAutoWriteSettingsV1409ResponseV1 +pagination_label: CreateAutoWriteSettingsV1409ResponseV1 +sidebar_label: CreateAutoWriteSettingsV1409ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateAutoWriteSettingsV1409ResponseV1', 'v1CreateAutoWriteSettingsV1409ResponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/create-auto-write-settings-v1409-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateAutoWriteSettingsV1409ResponseV1', 'v1CreateAutoWriteSettingsV1409ResponseV1'] +--- + +# CreateAutoWriteSettingsV1409ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errorName** | **(optional)** **any** | A message describing the error | [default to undefined] +**errorMessage** | **(optional)** **any** | Description of the error | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignee.md b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignee.md new file mode 100644 index 00000000..54887a97 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignee.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrecommendationassignee-v1 +title: EntitlementrecommendationassigneeV1 +pagination_label: EntitlementrecommendationassigneeV1 +sidebar_label: EntitlementrecommendationassigneeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationassigneeV1', 'v1EntitlementrecommendationassigneeV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationassignee-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationassigneeV1', 'v1EntitlementrecommendationassigneeV1'] +--- + +# EntitlementrecommendationassigneeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of assignee. | [default to undefined] +**value** | **string** | The ID of the identity or governance group to assign to. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf.md b/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf.md new file mode 100644 index 00000000..03e3fe0f --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrecommendationassignee-one-of-v1 +title: EntitlementrecommendationassigneeOneOfV1 +pagination_label: EntitlementrecommendationassigneeOneOfV1 +sidebar_label: EntitlementrecommendationassigneeOneOfV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationassigneeOneOfV1', 'v1EntitlementrecommendationassigneeOneOfV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationassignee-one-of-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationassigneeOneOfV1', 'v1EntitlementrecommendationassigneeOneOfV1'] +--- + +# EntitlementrecommendationassigneeOneOfV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of assignee. | [default to undefined] +**value** | **string** | The ID of the identity or governance group to assign to. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf1.md b/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf1.md new file mode 100644 index 00000000..5162ff59 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/EntitlementrecommendationassigneeOneOf1.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementrecommendationassignee-one-of1-v1 +title: EntitlementrecommendationassigneeOneOf1V1 +pagination_label: EntitlementrecommendationassigneeOneOf1V1 +sidebar_label: EntitlementrecommendationassigneeOneOf1V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationassigneeOneOf1V1', 'v1EntitlementrecommendationassigneeOneOf1V1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationassignee-one-of1-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationassigneeOneOf1V1', 'v1EntitlementrecommendationassigneeOneOf1V1'] +--- + +# EntitlementrecommendationassigneeOneOf1V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of assignee. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignrequest.md b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignrequest.md new file mode 100644 index 00000000..b5e064f1 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignrequest.md @@ -0,0 +1,20 @@ +--- +id: v1-entitlementrecommendationassignrequest-v1 +title: EntitlementrecommendationassignrequestV1 +pagination_label: EntitlementrecommendationassignrequestV1 +sidebar_label: EntitlementrecommendationassignrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationassignrequestV1', 'v1EntitlementrecommendationassignrequestV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationassignrequest-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationassignrequestV1', 'v1EntitlementrecommendationassignrequestV1'] +--- + +# EntitlementrecommendationassignrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **Array<string>** | The list of recommendation record IDs to assign. | [default to undefined] +**assignee** | **EntitlementrecommendationassigneeV1** | | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignresult.md b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignresult.md new file mode 100644 index 00000000..a9dc2347 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationassignresult.md @@ -0,0 +1,19 @@ +--- +id: v1-entitlementrecommendationassignresult-v1 +title: EntitlementrecommendationassignresultV1 +pagination_label: EntitlementrecommendationassignresultV1 +sidebar_label: EntitlementrecommendationassignresultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationassignresultV1', 'v1EntitlementrecommendationassignresultV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationassignresult-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationassignresultV1', 'v1EntitlementrecommendationassignresultV1'] +--- + +# EntitlementrecommendationassignresultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batchId** | **(optional)** **string** | The unique identifier of the assignment batch created by this request. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationrecord.md b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationrecord.md new file mode 100644 index 00000000..c4d2c556 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Entitlementrecommendationrecord.md @@ -0,0 +1,36 @@ +--- +id: v1-entitlementrecommendationrecord-v1 +title: EntitlementrecommendationrecordV1 +pagination_label: EntitlementrecommendationrecordV1 +sidebar_label: EntitlementrecommendationrecordV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EntitlementrecommendationrecordV1', 'v1EntitlementrecommendationrecordV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/entitlementrecommendationrecord-v1 +tags: ['SDK', 'Software Development Kit', 'EntitlementrecommendationrecordV1', 'v1EntitlementrecommendationrecordV1'] +--- + +# EntitlementrecommendationrecordV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recordType** | **(optional)** **string** | The type of recommendation. \"SED\" indicates a suggested description recommendation; \"privilege\" indicates a privilege-level recommendation. | [default to undefined] +**id** | **(optional)** **string** | The unique identifier for this recommendation record. | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name (e.g. \"groups\"). | [default to undefined] +**displayName** | **(optional)** **string** | The human-readable display name of the entitlement. | [default to undefined] +**name** | **(optional)** **string** | The internal name of the entitlement. | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source that owns this entitlement. | [default to undefined] +**sourceName** | **(optional)** **string** | The display name of the source that owns this entitlement. | [default to undefined] +**status** | **(optional)** **string** | The current review status of the recommendation. | [default to undefined] +**type** | **(optional)** **string** | The entitlement type (e.g. \"group\"). | [default to undefined] +**value** | **(optional)** **string** | The entitlement value or identifier. | [default to undefined] +**description** | **(optional)** **string** | The current description of the entitlement, if one exists. | [default to undefined] +**suggestedDescription** | **(optional)** **string** | The AI-generated suggested description for the entitlement (SED records only). | [default to undefined] +**privilege** | **(optional)** **string** | The current privilege level assigned to the entitlement. | [default to undefined] +**suggestedPrivilege** | **(optional)** **string** | The AI-suggested privilege level for the entitlement (privilege records only). | [default to undefined] +**approvedBy** | **(optional)** **string** | The ID of the identity who approved this recommendation. | [default to undefined] +**approvedType** | **(optional)** **string** | How the recommendation was approved (e.g. \"direct\"). | [default to undefined] +**approvedWhen** | **(optional)** **string** | The timestamp when the recommendation was approved. | [default to undefined] +**llmBatchCreatedAt** | **(optional)** **string** | The timestamp when the LLM batch that generated this recommendation was created. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Errormessagedto.md b/sdk-output/suggested_entitlement_description/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..37647a53 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Errorresponsedto.md b/sdk-output/suggested_entitlement_description/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fcd00120 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1401Response.md b/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1401Response.md new file mode 100644 index 00000000..785c0aeb --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auto-write-settings-v1401-response-v1 +title: GetAutoWriteSettingsV1401ResponseV1 +pagination_label: GetAutoWriteSettingsV1401ResponseV1 +sidebar_label: GetAutoWriteSettingsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAutoWriteSettingsV1401ResponseV1', 'v1GetAutoWriteSettingsV1401ResponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/get-auto-write-settings-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAutoWriteSettingsV1401ResponseV1', 'v1GetAutoWriteSettingsV1401ResponseV1'] +--- + +# GetAutoWriteSettingsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1429Response.md b/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1429Response.md new file mode 100644 index 00000000..3e9d9f2d --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/GetAutoWriteSettingsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-auto-write-settings-v1429-response-v1 +title: GetAutoWriteSettingsV1429ResponseV1 +pagination_label: GetAutoWriteSettingsV1429ResponseV1 +sidebar_label: GetAutoWriteSettingsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetAutoWriteSettingsV1429ResponseV1', 'v1GetAutoWriteSettingsV1429ResponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/get-auto-write-settings-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetAutoWriteSettingsV1429ResponseV1', 'v1GetAutoWriteSettingsV1429ResponseV1'] +--- + +# GetAutoWriteSettingsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Index.md b/sdk-output/suggested_entitlement_description/docs/Models/Index.md new file mode 100644 index 00000000..d752422c --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: suggested_entitlement_description-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: suggested_entitlement_description-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'suggested_entitlement_description', 'models'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models +tags: ['SDK', 'Software Development Kit', 'suggested_entitlement_description', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Jsonpatchoperation.md b/sdk-output/suggested_entitlement_description/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..3a531cad --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/JsonpatchoperationValue.md b/sdk-output/suggested_entitlement_description/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..0230c32e --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Localeorigin.md b/sdk-output/suggested_entitlement_description/docs/Models/Localeorigin.md new file mode 100644 index 00000000..1bd4e88b --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationgroup.md b/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationgroup.md new file mode 100644 index 00000000..8b099f7c --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationgroup.md @@ -0,0 +1,24 @@ +--- +id: v1-privilegedrecommendationgroup-v1 +title: PrivilegedrecommendationgroupV1 +pagination_label: PrivilegedrecommendationgroupV1 +sidebar_label: PrivilegedrecommendationgroupV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegedrecommendationgroupV1', 'v1PrivilegedrecommendationgroupV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/privilegedrecommendationgroup-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegedrecommendationgroupV1', 'v1PrivilegedrecommendationgroupV1'] +--- + +# PrivilegedrecommendationgroupV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementName** | **(optional)** **string** | The name of the entitlement shared across all instances in this group. | [default to undefined] +**connectorType** | **(optional)** **string** | The connector type associated with all instances in this group. | [default to undefined] +**recommendationScore** | **(optional)** **string** | A decimal string representing the confidence score of the privilege recommendation (0.0-1.0). | [default to undefined] +**orgCount** | **(optional)** **number** | The number of organizations in which this entitlement appears as privileged. | [default to undefined] +**instanceCount** | **(optional)** **number** | The total number of individual entitlement instances in this group. | [default to undefined] +**instances** | **(optional)** **Array<PrivilegedrecommendationinstanceV1>** | The individual entitlement instances belonging to this group. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationinstance.md b/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationinstance.md new file mode 100644 index 00000000..b9b05c1a --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Privilegedrecommendationinstance.md @@ -0,0 +1,28 @@ +--- +id: v1-privilegedrecommendationinstance-v1 +title: PrivilegedrecommendationinstanceV1 +pagination_label: PrivilegedrecommendationinstanceV1 +sidebar_label: PrivilegedrecommendationinstanceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'PrivilegedrecommendationinstanceV1', 'v1PrivilegedrecommendationinstanceV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/privilegedrecommendationinstance-v1 +tags: ['SDK', 'Software Development Kit', 'PrivilegedrecommendationinstanceV1', 'v1PrivilegedrecommendationinstanceV1'] +--- + +# PrivilegedrecommendationinstanceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier for this entitlement instance. | [default to undefined] +**attribute** | **(optional)** **string** | The entitlement attribute name. | [default to undefined] +**sourceId** | **(optional)** **string** | The ID of the source that owns this entitlement. | [default to undefined] +**sourceName** | **(optional)** **string** | The display name of the source. | [default to undefined] +**type** | **(optional)** **string** | The entitlement type. | [default to undefined] +**value** | **(optional)** **string** | The entitlement value or distinguished name. | [default to undefined] +**status** | **(optional)** **string** | The current review status of this instance. | [default to undefined] +**privilegeLevel** | **(optional)** **string** | The currently assigned privilege level, if any. | [default to undefined] +**description** | **(optional)** **string** | The current description of the entitlement, if one exists. | [default to undefined] +**recommendedAt** | **(optional)** **string** | The timestamp when this instance was recommended. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/README.md b/sdk-output/suggested_entitlement_description/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Searchcriteria.md b/sdk-output/suggested_entitlement_description/docs/Models/Searchcriteria.md new file mode 100644 index 00000000..40879158 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Searchcriteria.md @@ -0,0 +1,26 @@ +--- +id: v1-searchcriteria-v1 +title: SearchcriteriaV1 +pagination_label: SearchcriteriaV1 +sidebar_label: SearchcriteriaV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaV1', 'v1SearchcriteriaV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaV1', 'v1SearchcriteriaV1'] +--- + +# SearchcriteriaV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indices** | **Array<string>** | A list of indices to search within. Must contain exactly one item, typically \"entitlements\". | [default to undefined] +**filters** | **(optional)** | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [default to undefined] +**query** | **(optional)** **SearchcriteriaQueryV1** | | [default to undefined] +**queryType** | **(optional)** **string** | Specifies the type of query. Must be \"TEXT\" if `textQuery` is used. | [default to undefined] +**textQuery** | **(optional)** **SearchcriteriaTextQueryV1** | | [default to undefined] +**includeNested** | **(optional)** **boolean** | Whether to include nested objects in the search results. | [default to false] +**sort** | **(optional)** **Array<string>** | Specifies the sorting order for the results. | [default to undefined] +**searchAfter** | **(optional)** **Array<string>** | Used for pagination to fetch results after a specific point. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValue.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValue.md new file mode 100644 index 00000000..27232e43 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValue.md @@ -0,0 +1,21 @@ +--- +id: v1-searchcriteria-filters-value-v1 +title: SearchcriteriaFiltersValueV1 +pagination_label: SearchcriteriaFiltersValueV1 +sidebar_label: SearchcriteriaFiltersValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaFiltersValueV1', 'v1SearchcriteriaFiltersValueV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-filters-value-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaFiltersValueV1', 'v1SearchcriteriaFiltersValueV1'] +--- + +# SearchcriteriaFiltersValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of filter, e.g., \"TERMS\" or \"RANGE\". | [default to undefined] +**terms** | **(optional)** **Array<string>** | Terms to filter by (for \"TERMS\" type). | [default to undefined] +**range** | **(optional)** **SearchcriteriaFiltersValueRangeV1** | | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRange.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRange.md new file mode 100644 index 00000000..02640856 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRange.md @@ -0,0 +1,20 @@ +--- +id: v1-searchcriteria-filters-value-range-v1 +title: SearchcriteriaFiltersValueRangeV1 +pagination_label: SearchcriteriaFiltersValueRangeV1 +sidebar_label: SearchcriteriaFiltersValueRangeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaFiltersValueRangeV1', 'v1SearchcriteriaFiltersValueRangeV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-filters-value-range-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaFiltersValueRangeV1', 'v1SearchcriteriaFiltersValueRangeV1'] +--- + +# SearchcriteriaFiltersValueRangeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**lower** | **(optional)** **SearchcriteriaFiltersValueRangeLowerV1** | | [default to undefined] +**upper** | **(optional)** **SearchcriteriaFiltersValueRangeUpperV1** | | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeLower.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeLower.md new file mode 100644 index 00000000..30b5f209 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeLower.md @@ -0,0 +1,20 @@ +--- +id: v1-searchcriteria-filters-value-range-lower-v1 +title: SearchcriteriaFiltersValueRangeLowerV1 +pagination_label: SearchcriteriaFiltersValueRangeLowerV1 +sidebar_label: SearchcriteriaFiltersValueRangeLowerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaFiltersValueRangeLowerV1', 'v1SearchcriteriaFiltersValueRangeLowerV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-filters-value-range-lower-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaFiltersValueRangeLowerV1', 'v1SearchcriteriaFiltersValueRangeLowerV1'] +--- + +# SearchcriteriaFiltersValueRangeLowerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The lower bound value. | [default to undefined] +**inclusive** | **(optional)** **boolean** | Whether the lower bound is inclusive. | [default to false] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeUpper.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeUpper.md new file mode 100644 index 00000000..b7f4bc92 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaFiltersValueRangeUpper.md @@ -0,0 +1,20 @@ +--- +id: v1-searchcriteria-filters-value-range-upper-v1 +title: SearchcriteriaFiltersValueRangeUpperV1 +pagination_label: SearchcriteriaFiltersValueRangeUpperV1 +sidebar_label: SearchcriteriaFiltersValueRangeUpperV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaFiltersValueRangeUpperV1', 'v1SearchcriteriaFiltersValueRangeUpperV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-filters-value-range-upper-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaFiltersValueRangeUpperV1', 'v1SearchcriteriaFiltersValueRangeUpperV1'] +--- + +# SearchcriteriaFiltersValueRangeUpperV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **(optional)** **string** | The upper bound value. | [default to undefined] +**inclusive** | **(optional)** **boolean** | Whether the upper bound is inclusive. | [default to false] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaQuery.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaQuery.md new file mode 100644 index 00000000..693430b5 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaQuery.md @@ -0,0 +1,19 @@ +--- +id: v1-searchcriteria-query-v1 +title: SearchcriteriaQueryV1 +pagination_label: SearchcriteriaQueryV1 +sidebar_label: SearchcriteriaQueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaQueryV1', 'v1SearchcriteriaQueryV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-query-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaQueryV1', 'v1SearchcriteriaQueryV1'] +--- + +# SearchcriteriaQueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **(optional)** **string** | A structured query for advanced search. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaTextQuery.md b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaTextQuery.md new file mode 100644 index 00000000..29164b17 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/SearchcriteriaTextQuery.md @@ -0,0 +1,21 @@ +--- +id: v1-searchcriteria-text-query-v1 +title: SearchcriteriaTextQueryV1 +pagination_label: SearchcriteriaTextQueryV1 +sidebar_label: SearchcriteriaTextQueryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SearchcriteriaTextQueryV1', 'v1SearchcriteriaTextQueryV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/searchcriteria-text-query-v1 +tags: ['SDK', 'Software Development Kit', 'SearchcriteriaTextQueryV1', 'v1SearchcriteriaTextQueryV1'] +--- + +# SearchcriteriaTextQueryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**terms** | **(optional)** **Array<string>** | Terms to search for. | [default to undefined] +**fields** | **(optional)** **Array<string>** | Fields to search within. | [default to undefined] +**matchAny** | **(optional)** **boolean** | Whether to match any of the terms. | [default to false] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sed.md b/sdk-output/suggested_entitlement_description/docs/Models/Sed.md new file mode 100644 index 00000000..f4819037 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sed.md @@ -0,0 +1,32 @@ +--- +id: v1-sed-v1 +title: SedV1 +pagination_label: SedV1 +sidebar_label: SedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedV1', 'v1SedV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sed-v1 +tags: ['SDK', 'Software Development Kit', 'SedV1', 'v1SedV1'] +--- + +# SedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **(optional)** **string** | name of the entitlement | [default to undefined] +**approved_by** | **(optional)** **string** | entitlement approved by | [default to undefined] +**approved_type** | **(optional)** **string** | entitlement approved type | [default to undefined] +**approved_when** | **(optional)** **string** | entitlement approved then | [default to undefined] +**attribute** | **(optional)** **string** | entitlement attribute | [default to undefined] +**description** | **(optional)** **string** | description of entitlement | [default to undefined] +**displayName** | **(optional)** **string** | entitlement display name | [default to undefined] +**id** | **(optional)** **string** | sed id | [default to undefined] +**sourceId** | **(optional)** **string** | entitlement source id | [default to undefined] +**sourceName** | **(optional)** **string** | entitlement source name | [default to undefined] +**status** | **(optional)** **string** | entitlement status | [default to undefined] +**suggestedDescription** | **(optional)** **string** | llm suggested entitlement description | [default to undefined] +**type** | **(optional)** **string** | entitlement type | [default to undefined] +**value** | **(optional)** **string** | entitlement value | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedapproval.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedapproval.md new file mode 100644 index 00000000..6c75239d --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedapproval.md @@ -0,0 +1,19 @@ +--- +id: v1-sedapproval-v1 +title: SedapprovalV1 +pagination_label: SedapprovalV1 +sidebar_label: SedapprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedapprovalV1', 'v1SedapprovalV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedapproval-v1 +tags: ['SDK', 'Software Development Kit', 'SedapprovalV1', 'v1SedapprovalV1'] +--- + +# SedapprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | **(optional)** **Array<string>** | List of SED id\'s | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedapprovalstatus.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedapprovalstatus.md new file mode 100644 index 00000000..09349ae5 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedapprovalstatus.md @@ -0,0 +1,21 @@ +--- +id: v1-sedapprovalstatus-v1 +title: SedapprovalstatusV1 +pagination_label: SedapprovalstatusV1 +sidebar_label: SedapprovalstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedapprovalstatusV1', 'v1SedapprovalstatusV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedapprovalstatus-v1 +tags: ['SDK', 'Software Development Kit', 'SedapprovalstatusV1', 'v1SedapprovalstatusV1'] +--- + +# SedapprovalstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failedReason** | **(optional)** **string** | failed reason will be display if status is failed | [default to undefined] +**id** | **(optional)** **string** | Sed id | [default to undefined] +**status** | **(optional)** **string** | SUCCESS | FAILED | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedassignee.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignee.md new file mode 100644 index 00000000..e7976a93 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignee.md @@ -0,0 +1,20 @@ +--- +id: v1-sedassignee-v1 +title: SedassigneeV1 +pagination_label: SedassigneeV1 +sidebar_label: SedassigneeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedassigneeV1', 'v1SedassigneeV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedassignee-v1 +tags: ['SDK', 'Software Development Kit', 'SedassigneeV1', 'v1SedassigneeV1'] +--- + +# SedassigneeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [default to undefined] +**value** | **(optional)** **string** | Identity or Group identifier Empty when using source/entitlement owner personas | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedassignment.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignment.md new file mode 100644 index 00000000..c6dcdfe4 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignment.md @@ -0,0 +1,20 @@ +--- +id: v1-sedassignment-v1 +title: SedassignmentV1 +pagination_label: SedassignmentV1 +sidebar_label: SedassignmentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedassignmentV1', 'v1SedassignmentV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedassignment-v1 +tags: ['SDK', 'Software Development Kit', 'SedassignmentV1', 'v1SedassignmentV1'] +--- + +# SedassignmentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignee** | **(optional)** **SedassigneeV1** | | [default to undefined] +**items** | **(optional)** **Array<string>** | List of SED id\'s | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedassignmentresponse.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignmentresponse.md new file mode 100644 index 00000000..eba4ebb1 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedassignmentresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-sedassignmentresponse-v1 +title: SedassignmentresponseV1 +pagination_label: SedassignmentresponseV1 +sidebar_label: SedassignmentresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedassignmentresponseV1', 'v1SedassignmentresponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedassignmentresponse-v1 +tags: ['SDK', 'Software Development Kit', 'SedassignmentresponseV1', 'v1SedassignmentresponseV1'] +--- + +# SedassignmentresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batchId** | **(optional)** **string** | BatchId that groups all the ids together | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrecord.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrecord.md new file mode 100644 index 00000000..8ecf822a --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrecord.md @@ -0,0 +1,27 @@ +--- +id: v1-sedbatchrecord-v1 +title: SedbatchrecordV1 +pagination_label: SedbatchrecordV1 +sidebar_label: SedbatchrecordV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedbatchrecordV1', 'v1SedbatchrecordV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedbatchrecord-v1 +tags: ['SDK', 'Software Development Kit', 'SedbatchrecordV1', 'v1SedbatchrecordV1'] +--- + +# SedbatchrecordV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tenantId** | **(optional)** **string** | The tenant ID associated with the batch. | [default to undefined] +**batchId** | **(optional)** **string** | The unique ID of the batch. | [default to undefined] +**name** | **(optional)** **string** | The name of the batch. | [default to undefined] +**processedState** | **(optional)** **string** | The current state of the batch (e.g., submitted, materialized, completed). | [default to undefined] +**requestedBy** | **(optional)** **string** | The ID of the user who requested the batch. | [default to undefined] +**materializedCount** | **(optional)** **number** | The number of items materialized in the batch. | [default to undefined] +**processedCount** | **(optional)** **number** | The number of items processed in the batch. | [default to undefined] +**createdAt** | **(optional)** **string** | The timestamp when the batch was created. | [default to undefined] +**updatedAt** | **(optional)** **string** | The timestamp when the batch was last updated. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrequest.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrequest.md new file mode 100644 index 00000000..47f7ae7f --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchrequest.md @@ -0,0 +1,21 @@ +--- +id: v1-sedbatchrequest-v1 +title: SedbatchrequestV1 +pagination_label: SedbatchrequestV1 +sidebar_label: SedbatchrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedbatchrequestV1', 'v1SedbatchrequestV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedbatchrequest-v1 +tags: ['SDK', 'Software Development Kit', 'SedbatchrequestV1', 'v1SedbatchrequestV1'] +--- + +# SedbatchrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlements** | **(optional)** **Array<string>** | list of entitlement ids | [default to undefined] +**seds** | **(optional)** **Array<string>** | list of sed ids | [default to undefined] +**searchCriteria** | **(optional)** | Search criteria for the batch request. | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchresponse.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchresponse.md new file mode 100644 index 00000000..579a0d00 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchresponse.md @@ -0,0 +1,19 @@ +--- +id: v1-sedbatchresponse-v1 +title: SedbatchresponseV1 +pagination_label: SedbatchresponseV1 +sidebar_label: SedbatchresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedbatchresponseV1', 'v1SedbatchresponseV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedbatchresponse-v1 +tags: ['SDK', 'Software Development Kit', 'SedbatchresponseV1', 'v1SedbatchresponseV1'] +--- + +# SedbatchresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batchId** | **(optional)** **string** | BatchId that groups all the ids together | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchstats.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchstats.md new file mode 100644 index 00000000..efabd4d2 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedbatchstats.md @@ -0,0 +1,23 @@ +--- +id: v1-sedbatchstats-v1 +title: SedbatchstatsV1 +pagination_label: SedbatchstatsV1 +sidebar_label: SedbatchstatsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedbatchstatsV1', 'v1SedbatchstatsV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedbatchstats-v1 +tags: ['SDK', 'Software Development Kit', 'SedbatchstatsV1', 'v1SedbatchstatsV1'] +--- + +# SedbatchstatsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batchComplete** | **(optional)** **boolean** | batch complete | [default to false] +**batchId** | **(optional)** **string** | batch Id | [default to undefined] +**discoveredCount** | **(optional)** **number** | discovered count | [default to undefined] +**discoveryComplete** | **(optional)** **boolean** | discovery complete | [default to false] +**processedCount** | **(optional)** **number** | processed count | [default to undefined] + diff --git a/sdk-output/suggested_entitlement_description/docs/Models/Sedpatch.md b/sdk-output/suggested_entitlement_description/docs/Models/Sedpatch.md new file mode 100644 index 00000000..fdd6bd64 --- /dev/null +++ b/sdk-output/suggested_entitlement_description/docs/Models/Sedpatch.md @@ -0,0 +1,21 @@ +--- +id: v1-sedpatch-v1 +title: SedpatchV1 +pagination_label: SedpatchV1 +sidebar_label: SedpatchV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SedpatchV1', 'v1SedpatchV1'] +slug: /tools/sdk/typescript/suggested_entitlement_description/models/sedpatch-v1 +tags: ['SDK', 'Software Development Kit', 'SedpatchV1', 'v1SedpatchV1'] +--- + +# SedpatchV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **(optional)** **string** | desired operation | [default to undefined] +**path** | **(optional)** **string** | field to be patched | [default to undefined] +**value** | **(optional)** **any** | value to replace with | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/tagged_objects/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..15c1b1ca --- /dev/null +++ b/sdk-output/tagged_objects/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,131 @@ +- path: /tagged-objects/v1/{type}/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#delete-tagged-object-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const type: string = 'ROLE'; // 'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE' | The type of object to delete tags from. (default to undefined) + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the object to delete tags from. (default to undefined) + const result = await apiInstance.deleteTaggedObjectV1(type, id); + console.log(result); +- path: /tagged-objects/v1/bulk-remove + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#delete-tags-to-many-object-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const bulkremovetaggedobjectV1: BulkremovetaggedobjectV1 = ; // BulkremovetaggedobjectV1 | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + const result = await apiInstance.deleteTagsToManyObjectV1(bulkremovetaggedobjectV1); + console.log(result); +- path: /tagged-objects/v1/{type}/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#get-tagged-object-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const type: string = 'ROLE'; // 'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE' | The type of tagged object to retrieve. (default to undefined) + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the object reference to retrieve. (default to undefined) + const result = await apiInstance.getTaggedObjectV1(type, id); + console.log(result); +- path: /tagged-objects/v1/{type} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#list-tagged-objects-by-type-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const type: string = 'ROLE'; // 'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE' | The type of tagged object to retrieve. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) (default to undefined) + const result = await apiInstance.listTaggedObjectsByTypeV1(type); + console.log(result); +- path: /tagged-objects/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#list-tagged-objects-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'tagName eq "BU_FINANCE"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) (default to undefined) + const result = await apiInstance.listTaggedObjectsV1(); + console.log(result); +- path: /tagged-objects/v1/{type}/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#put-tagged-object-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const type: string = 'ROLE'; // 'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE' | The type of tagged object to update. (default to undefined) + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the object reference to update. (default to undefined) + const taggedobjectV1: TaggedobjectV1 = ; // TaggedobjectV1 | + const result = await apiInstance.putTaggedObjectV1(type, id, taggedobjectV1); + console.log(result); +- path: /tagged-objects/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#set-tag-to-object-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const taggedobjectV1: TaggedobjectV1 = ; // TaggedobjectV1 | + const result = await apiInstance.setTagToObjectV1(taggedobjectV1); + console.log(result); +- path: /tagged-objects/v1/bulk-add + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tagged_objects/methods/tagged-objects#set-tags-to-many-objects-v1 + source: | + import { TaggedObjectsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaggedObjectsV1Api(configuration); + const bulkaddtaggedobjectV1: BulkaddtaggedobjectV1 = ; // BulkaddtaggedobjectV1 | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + const result = await apiInstance.setTagsToManyObjectsV1(bulkaddtaggedobjectV1); + console.log(result); diff --git a/sdk-output/tagged_objects/docs/Methods/Index.md b/sdk-output/tagged_objects/docs/Methods/Index.md new file mode 100644 index 00000000..af2a1b53 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: tagged_objects-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: tagged_objects-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'tagged_objects', 'methods'] +slug: /tools/sdk/typescript/tagged_objects/methods +tags: ['SDK', 'Software Development Kit', 'tagged_objects', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/tagged_objects/docs/Methods/TaggedObjectsV1Api.md b/sdk-output/tagged_objects/docs/Methods/TaggedObjectsV1Api.md new file mode 100644 index 00000000..090a5de6 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Methods/TaggedObjectsV1Api.md @@ -0,0 +1,406 @@ +--- +id: v1-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaggedObjects', 'v1TaggedObjects'] +slug: /tools/sdk/typescript/tagged_objects/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'v1TaggedObjects'] +--- + +# TaggedObjectsV1Api + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete-tagged-object-v1**](#delete-tagged-object-v1) | **DELETE** `/tagged-objects/v1/{type}/{id}` | Delete object tags +[**delete-tags-to-many-object-v1**](#delete-tags-to-many-object-v1) | **POST** `/tagged-objects/v1/bulk-remove` | Remove tags from multiple objects +[**get-tagged-object-v1**](#get-tagged-object-v1) | **GET** `/tagged-objects/v1/{type}/{id}` | Get tagged object +[**list-tagged-objects-by-type-v1**](#list-tagged-objects-by-type-v1) | **GET** `/tagged-objects/v1/{type}` | List tagged objects by type +[**list-tagged-objects-v1**](#list-tagged-objects-v1) | **GET** `/tagged-objects/v1` | List tagged objects +[**put-tagged-object-v1**](#put-tagged-object-v1) | **PUT** `/tagged-objects/v1/{type}/{id}` | Update tagged object +[**set-tag-to-object-v1**](#set-tag-to-object-v1) | **POST** `/tagged-objects/v1` | Add tag to object +[**set-tags-to-many-objects-v1**](#set-tags-to-many-objects-v1) | **POST** `/tagged-objects/v1/bulk-add` | Tag multiple objects + + +## delete-tagged-object-v1 +Delete object tags +Delete all tags from a tagged object. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-tagged-object-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'** | The type of object to delete tags from. | [default to undefined] +**id** | **string** | The ID of the object to delete tags from. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const type: string = ROLE; // The type of object to delete tags from. +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the object to delete tags from. +const result = await apiInstance.deleteTaggedObjectV1(type, id); +console.log(result); +``` + +[[Back to top]](#) + +## delete-tags-to-many-object-v1 +Remove tags from multiple objects +This API removes tags from multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-tags-to-many-object-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkremovetaggedobjectV1** | **BulkremovetaggedobjectV1** | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const bulkremovetaggedobjectV1: BulkremovetaggedobjectV1 = ; // Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. +const result = await apiInstance.deleteTagsToManyObjectV1(bulkremovetaggedobjectV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-tagged-object-v1 +Get tagged object +This gets a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tagged-object-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'** | The type of tagged object to retrieve. | [default to undefined] +**id** | **string** | The ID of the object reference to retrieve. | [default to undefined] + +### Return type + +**TaggedobjectV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const type: string = ROLE; // The type of tagged object to retrieve. +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the object reference to retrieve. +const result = await apiInstance.getTaggedObjectV1(type, id); +console.log(result); +``` + +[[Back to top]](#) + +## list-tagged-objects-by-type-v1 +List tagged objects by type +This API returns a list of all tagged objects by type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-tagged-objects-by-type-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'** | The type of tagged object to retrieve. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const type: string = ROLE; // The type of tagged object to retrieve. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = objectRef.id eq "2c91808568c529c60168cca6f90c1313"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) +const result = await apiInstance.listTaggedObjectsByTypeV1(type); +console.log(result); +``` + +[[Back to top]](#) + +## list-tagged-objects-v1 +List tagged objects +This API returns a list of all tagged objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-tagged-objects-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = tagName eq "BU_FINANCE"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) +const result = await apiInstance.listTaggedObjectsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-tagged-object-v1 +Update tagged object +This updates a tagged object for the specified type. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-tagged-object-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**type** | **'ACCESS_PROFILE' | 'APPLICATION' | 'CAMPAIGN' | 'ENTITLEMENT' | 'IDENTITY' | 'ROLE' | 'SOD_POLICY' | 'SOURCE'** | The type of tagged object to update. | [default to undefined] +**id** | **string** | The ID of the object reference to update. | [default to undefined] +**taggedobjectV1** | **TaggedobjectV1** | | + +### Return type + +**TaggedobjectV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const type: string = ROLE; // The type of tagged object to update. +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the object reference to update. +const taggedobjectV1: TaggedobjectV1 = ; // +const result = await apiInstance.putTaggedObjectV1(type, id, taggedobjectV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-tag-to-object-v1 +Add tag to object +This adds a tag to an object. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-tag-to-object-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**taggedobjectV1** | **TaggedobjectV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const taggedobjectV1: TaggedobjectV1 = ; // +const result = await apiInstance.setTagToObjectV1(taggedobjectV1); +console.log(result); +``` + +[[Back to top]](#) + +## set-tags-to-many-objects-v1 +Tag multiple objects +This API adds tags to multiple objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-tags-to-many-objects-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**bulkaddtaggedobjectV1** | **BulkaddtaggedobjectV1** | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TaggedObjectsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaggedObjectsV1Api(configuration); +const bulkaddtaggedobjectV1: BulkaddtaggedobjectV1 = ; // Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. +const result = await apiInstance.setTagsToManyObjectsV1(bulkaddtaggedobjectV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/tagged_objects/docs/Models/Bulkaddtaggedobject.md b/sdk-output/tagged_objects/docs/Models/Bulkaddtaggedobject.md new file mode 100644 index 00000000..18e5ec05 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Bulkaddtaggedobject.md @@ -0,0 +1,21 @@ +--- +id: v1-bulkaddtaggedobject-v1 +title: BulkaddtaggedobjectV1 +pagination_label: BulkaddtaggedobjectV1 +sidebar_label: BulkaddtaggedobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkaddtaggedobjectV1', 'v1BulkaddtaggedobjectV1'] +slug: /tools/sdk/typescript/tagged_objects/models/bulkaddtaggedobject-v1 +tags: ['SDK', 'Software Development Kit', 'BulkaddtaggedobjectV1', 'v1BulkaddtaggedobjectV1'] +--- + +# BulkaddtaggedobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectRefs** | **(optional)** **Array<TaggedobjectdtoV1>** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | Label to be applied to an Object | [default to undefined] +**operation** | **(optional)** **string** | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [default to OperationV1_Append] + diff --git a/sdk-output/tagged_objects/docs/Models/Bulkremovetaggedobject.md b/sdk-output/tagged_objects/docs/Models/Bulkremovetaggedobject.md new file mode 100644 index 00000000..475e7e04 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Bulkremovetaggedobject.md @@ -0,0 +1,20 @@ +--- +id: v1-bulkremovetaggedobject-v1 +title: BulkremovetaggedobjectV1 +pagination_label: BulkremovetaggedobjectV1 +sidebar_label: BulkremovetaggedobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulkremovetaggedobjectV1', 'v1BulkremovetaggedobjectV1'] +slug: /tools/sdk/typescript/tagged_objects/models/bulkremovetaggedobject-v1 +tags: ['SDK', 'Software Development Kit', 'BulkremovetaggedobjectV1', 'v1BulkremovetaggedobjectV1'] +--- + +# BulkremovetaggedobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectRefs** | **(optional)** **Array<TaggedobjectdtoV1>** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | Label to be applied to an Object | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Bulktaggedobjectresponse.md b/sdk-output/tagged_objects/docs/Models/Bulktaggedobjectresponse.md new file mode 100644 index 00000000..fbfa3eb3 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Bulktaggedobjectresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-bulktaggedobjectresponse-v1 +title: BulktaggedobjectresponseV1 +pagination_label: BulktaggedobjectresponseV1 +sidebar_label: BulktaggedobjectresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BulktaggedobjectresponseV1', 'v1BulktaggedobjectresponseV1'] +slug: /tools/sdk/typescript/tagged_objects/models/bulktaggedobjectresponse-v1 +tags: ['SDK', 'Software Development Kit', 'BulktaggedobjectresponseV1', 'v1BulktaggedobjectresponseV1'] +--- + +# BulktaggedobjectresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectRefs** | **(optional)** **Array<TaggedobjectdtoV1>** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | Label to be applied to an Object | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Errormessagedto.md b/sdk-output/tagged_objects/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b196b953 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/tagged_objects/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Errorresponsedto.md b/sdk-output/tagged_objects/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..eba85d00 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/tagged_objects/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Index.md b/sdk-output/tagged_objects/docs/Models/Index.md new file mode 100644 index 00000000..3efc76fc --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: tagged_objects-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: tagged_objects-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'tagged_objects', 'models'] +slug: /tools/sdk/typescript/tagged_objects/models +tags: ['SDK', 'Software Development Kit', 'tagged_objects', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1401Response.md b/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1401Response.md new file mode 100644 index 00000000..c9f5ee34 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-tagged-objects-v1401-response-v1 +title: ListTaggedObjectsV1401ResponseV1 +pagination_label: ListTaggedObjectsV1401ResponseV1 +sidebar_label: ListTaggedObjectsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTaggedObjectsV1401ResponseV1', 'v1ListTaggedObjectsV1401ResponseV1'] +slug: /tools/sdk/typescript/tagged_objects/models/list-tagged-objects-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTaggedObjectsV1401ResponseV1', 'v1ListTaggedObjectsV1401ResponseV1'] +--- + +# ListTaggedObjectsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1429Response.md b/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1429Response.md new file mode 100644 index 00000000..397afb90 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/ListTaggedObjectsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-tagged-objects-v1429-response-v1 +title: ListTaggedObjectsV1429ResponseV1 +pagination_label: ListTaggedObjectsV1429ResponseV1 +sidebar_label: ListTaggedObjectsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTaggedObjectsV1429ResponseV1', 'v1ListTaggedObjectsV1429ResponseV1'] +slug: /tools/sdk/typescript/tagged_objects/models/list-tagged-objects-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTaggedObjectsV1429ResponseV1', 'v1ListTaggedObjectsV1429ResponseV1'] +--- + +# ListTaggedObjectsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Localeorigin.md b/sdk-output/tagged_objects/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e9ecc47f --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/tagged_objects/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/tagged_objects/docs/Models/README.md b/sdk-output/tagged_objects/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tagged_objects/docs/Models/Taggedobject.md b/sdk-output/tagged_objects/docs/Models/Taggedobject.md new file mode 100644 index 00000000..65ba03a5 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Taggedobject.md @@ -0,0 +1,20 @@ +--- +id: v1-taggedobject-v1 +title: TaggedobjectV1 +pagination_label: TaggedobjectV1 +sidebar_label: TaggedobjectV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaggedobjectV1', 'v1TaggedobjectV1'] +slug: /tools/sdk/typescript/tagged_objects/models/taggedobject-v1 +tags: ['SDK', 'Software Development Kit', 'TaggedobjectV1', 'v1TaggedobjectV1'] +--- + +# TaggedobjectV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**objectRef** | **(optional)** **TaggedobjectdtoV1** | | [default to undefined] +**tags** | **(optional)** **Array<string>** | Labels to be applied to an Object | [default to undefined] + diff --git a/sdk-output/tagged_objects/docs/Models/Taggedobjectdto.md b/sdk-output/tagged_objects/docs/Models/Taggedobjectdto.md new file mode 100644 index 00000000..e1e99bb6 --- /dev/null +++ b/sdk-output/tagged_objects/docs/Models/Taggedobjectdto.md @@ -0,0 +1,21 @@ +--- +id: v1-taggedobjectdto-v1 +title: TaggedobjectdtoV1 +pagination_label: TaggedobjectdtoV1 +sidebar_label: TaggedobjectdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaggedobjectdtoV1', 'v1TaggedobjectdtoV1'] +slug: /tools/sdk/typescript/tagged_objects/models/taggedobjectdto-v1 +tags: ['SDK', 'Software Development Kit', 'TaggedobjectdtoV1', 'v1TaggedobjectdtoV1'] +--- + +# TaggedobjectdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type | [default to undefined] +**id** | **(optional)** **string** | ID of the object this reference applies to | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object this reference applies to | [default to undefined] + diff --git a/sdk-output/tags/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/tags/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..454f7b78 --- /dev/null +++ b/sdk-output/tags/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,64 @@ +- path: /tags/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tags/methods/tags#create-tag-v1 + source: | + import { TagsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TagsV1Api(configuration); + const tag2V1: Tag2V1 = ; // Tag2V1 | + const result = await apiInstance.createTagV1(tag2V1); + console.log(result); +- path: /tags/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tags/methods/tags#delete-tag-by-id-v1 + source: | + import { TagsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TagsV1Api(configuration); + const id: string = '329d96cf-3bdb-40a9-988a-b5037ab89022'; // string | The ID of the object reference to delete. (default to undefined) + const result = await apiInstance.deleteTagByIdV1(id); + console.log(result); +- path: /tags/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tags/methods/tags#get-tag-by-id-v1 + source: | + import { TagsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TagsV1Api(configuration); + const id: string = '329d96cf-3bdb-40a9-988a-b5037ab89022'; // string | The ID of the object reference to retrieve. (default to undefined) + const result = await apiInstance.getTagByIdV1(id); + console.log(result); +- path: /tags/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tags/methods/tags#list-tags-v1 + source: | + import { TagsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TagsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) (default to undefined) + const sorters: string = 'name,-modified'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) (default to undefined) + const result = await apiInstance.listTagsV1(); + console.log(result); diff --git a/sdk-output/tags/docs/Methods/Index.md b/sdk-output/tags/docs/Methods/Index.md new file mode 100644 index 00000000..84a3e1da --- /dev/null +++ b/sdk-output/tags/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: tags-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: tags-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'tags', 'methods'] +slug: /tools/sdk/typescript/tags/methods +tags: ['SDK', 'Software Development Kit', 'tags', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/tags/docs/Methods/TagsV1Api.md b/sdk-output/tags/docs/Methods/TagsV1Api.md new file mode 100644 index 00000000..81bc0219 --- /dev/null +++ b/sdk-output/tags/docs/Methods/TagsV1Api.md @@ -0,0 +1,191 @@ +--- +id: v1-tags +title: Tags +pagination_label: Tags +sidebar_label: Tags +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Tags', 'v1Tags'] +slug: /tools/sdk/typescript/tags/methods/tags +tags: ['SDK', 'Software Development Kit', 'Tags', 'v1Tags'] +--- + +# TagsV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-tag-v1**](#create-tag-v1) | **POST** `/tags/v1` | Create tag +[**delete-tag-by-id-v1**](#delete-tag-by-id-v1) | **DELETE** `/tags/v1/{id}` | Delete tag +[**get-tag-by-id-v1**](#get-tag-by-id-v1) | **GET** `/tags/v1/{id}` | Get tag by id +[**list-tags-v1**](#list-tags-v1) | **GET** `/tags/v1` | List tags + + +## create-tag-v1 +Create tag +This API creates new tag. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-tag-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**tag2V1** | **Tag2V1** | | + +### Return type + +**Tag2V1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TagsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TagsV1Api(configuration); +const tag2V1: Tag2V1 = ; // +const result = await apiInstance.createTagV1(tag2V1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-tag-by-id-v1 +Delete tag +This API deletes a tag by specified id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-tag-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the object reference to delete. | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TagsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TagsV1Api(configuration); +const id: string = 329d96cf-3bdb-40a9-988a-b5037ab89022; // The ID of the object reference to delete. +const result = await apiInstance.deleteTagByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-tag-by-id-v1 +Get tag by id +Returns a tag by its id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tag-by-id-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the object reference to retrieve. | [default to undefined] + +### Return type + +**Tag2V1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TagsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TagsV1Api(configuration); +const id: string = 329d96cf-3bdb-40a9-988a-b5037ab89022; // The ID of the object reference to retrieve. +const result = await apiInstance.getTagByIdV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-tags-v1 +List tags +This API returns a list of tags. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-tags-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TagsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TagsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +const sorters: string = name,-modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) +const result = await apiInstance.listTagsV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/tags/docs/Models/Errormessagedto.md b/sdk-output/tags/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..bbd79478 --- /dev/null +++ b/sdk-output/tags/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/tags/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/tags/docs/Models/Errorresponsedto.md b/sdk-output/tags/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..78a31899 --- /dev/null +++ b/sdk-output/tags/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/tags/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/tags/docs/Models/Index.md b/sdk-output/tags/docs/Models/Index.md new file mode 100644 index 00000000..ae5fd1a9 --- /dev/null +++ b/sdk-output/tags/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: tags-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: tags-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'tags', 'models'] +slug: /tools/sdk/typescript/tags/models +tags: ['SDK', 'Software Development Kit', 'tags', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/tags/docs/Models/ListTagsV1401Response.md b/sdk-output/tags/docs/Models/ListTagsV1401Response.md new file mode 100644 index 00000000..50bbfbb9 --- /dev/null +++ b/sdk-output/tags/docs/Models/ListTagsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-tags-v1401-response-v1 +title: ListTagsV1401ResponseV1 +pagination_label: ListTagsV1401ResponseV1 +sidebar_label: ListTagsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTagsV1401ResponseV1', 'v1ListTagsV1401ResponseV1'] +slug: /tools/sdk/typescript/tags/models/list-tags-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTagsV1401ResponseV1', 'v1ListTagsV1401ResponseV1'] +--- + +# ListTagsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tags/docs/Models/ListTagsV1429Response.md b/sdk-output/tags/docs/Models/ListTagsV1429Response.md new file mode 100644 index 00000000..94a5dbe1 --- /dev/null +++ b/sdk-output/tags/docs/Models/ListTagsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-tags-v1429-response-v1 +title: ListTagsV1429ResponseV1 +pagination_label: ListTagsV1429ResponseV1 +sidebar_label: ListTagsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTagsV1429ResponseV1', 'v1ListTagsV1429ResponseV1'] +slug: /tools/sdk/typescript/tags/models/list-tags-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTagsV1429ResponseV1', 'v1ListTagsV1429ResponseV1'] +--- + +# ListTagsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tags/docs/Models/Localeorigin.md b/sdk-output/tags/docs/Models/Localeorigin.md new file mode 100644 index 00000000..0f15d0de --- /dev/null +++ b/sdk-output/tags/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/tags/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/tags/docs/Models/README.md b/sdk-output/tags/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tags/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tags/docs/Models/Tag2.md b/sdk-output/tags/docs/Models/Tag2.md new file mode 100644 index 00000000..28c4d2ce --- /dev/null +++ b/sdk-output/tags/docs/Models/Tag2.md @@ -0,0 +1,23 @@ +--- +id: v1-tag2-v1 +title: Tag2V1 +pagination_label: Tag2V1 +sidebar_label: Tag2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Tag2V1', 'v1Tag2V1'] +slug: /tools/sdk/typescript/tags/models/tag2-v1 +tags: ['SDK', 'Software Development Kit', 'Tag2V1', 'v1Tag2V1'] +--- + +# Tag2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Tag id | [readonly] [default to undefined] +**name** | **string** | Name of the tag. | [default to undefined] +**created** | **string** | Date the tag was created. | [readonly] [default to undefined] +**modified** | **string** | Date the tag was last modified. | [readonly] [default to undefined] +**tagCategoryRefs** | **Array<Tag2TagCategoryRefsInnerV1>** | | [readonly] [default to undefined] + diff --git a/sdk-output/tags/docs/Models/Tag2TagCategoryRefsInner.md b/sdk-output/tags/docs/Models/Tag2TagCategoryRefsInner.md new file mode 100644 index 00000000..14896f4a --- /dev/null +++ b/sdk-output/tags/docs/Models/Tag2TagCategoryRefsInner.md @@ -0,0 +1,21 @@ +--- +id: v1-tag2-tag-category-refs-inner-v1 +title: Tag2TagCategoryRefsInnerV1 +pagination_label: Tag2TagCategoryRefsInnerV1 +sidebar_label: Tag2TagCategoryRefsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Tag2TagCategoryRefsInnerV1', 'v1Tag2TagCategoryRefsInnerV1'] +slug: /tools/sdk/typescript/tags/models/tag2-tag-category-refs-inner-v1 +tags: ['SDK', 'Software Development Kit', 'Tag2TagCategoryRefsInnerV1', 'v1Tag2TagCategoryRefsInnerV1'] +--- + +# Tag2TagCategoryRefsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of the tagged object\'s category. | [default to undefined] +**id** | **(optional)** **string** | Tagged object\'s ID. | [default to undefined] +**name** | **(optional)** **string** | Tagged object\'s display name. | [default to undefined] + diff --git a/sdk-output/task_management/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/task_management/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..bec01eea --- /dev/null +++ b/sdk-output/task_management/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,50 @@ +- path: /task-status/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/task_management/methods/task-management#get-task-status-list-v1 + source: | + import { TaskManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaskManagementV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'type eq "CLOUD_ACCOUNT_AGGREGATION" and completionStatus isnull'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION (optional) (default to undefined) + const sorters: string = '-created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) (default to undefined) + const result = await apiInstance.getTaskStatusListV1(); + console.log(result); +- path: /task-status/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/task_management/methods/task-management#get-task-status-v1 + source: | + import { TaskManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaskManagementV1Api(configuration); + const id: string = '00eebcf881994e419d72e757fd30dc0e'; // string | Task ID. (default to undefined) + const result = await apiInstance.getTaskStatusV1(id); + console.log(result); +- path: /task-status/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/task_management/methods/task-management#update-task-status-v1 + source: | + import { TaskManagementV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TaskManagementV1Api(configuration); + const id: string = '00eebcf881994e419d72e757fd30dc0e'; // string | Task ID. (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // Array | The JSONPatch payload used to update the object. + const result = await apiInstance.updateTaskStatusV1(id, jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/task_management/docs/Methods/Index.md b/sdk-output/task_management/docs/Methods/Index.md new file mode 100644 index 00000000..73bfc08e --- /dev/null +++ b/sdk-output/task_management/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: task_management-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: task_management-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'task_management', 'methods'] +slug: /tools/sdk/typescript/task_management/methods +tags: ['SDK', 'Software Development Kit', 'task_management', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/task_management/docs/Methods/TaskManagementV1Api.md b/sdk-output/task_management/docs/Methods/TaskManagementV1Api.md new file mode 100644 index 00000000..2a17bc69 --- /dev/null +++ b/sdk-output/task_management/docs/Methods/TaskManagementV1Api.md @@ -0,0 +1,147 @@ +--- +id: v1-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskManagement', 'v1TaskManagement'] +slug: /tools/sdk/typescript/task_management/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'v1TaskManagement'] +--- + +# TaskManagementV1Api + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-task-status-list-v1**](#get-task-status-list-v1) | **GET** `/task-status/v1` | Retrieve task status list +[**get-task-status-v1**](#get-task-status-v1) | **GET** `/task-status/v1/{id}` | Get task status by id +[**update-task-status-v1**](#update-task-status-v1) | **PATCH** `/task-status/v1/{id}` | Update task status by id + + +## get-task-status-list-v1 +Retrieve task status list +Use this endpoint to get a list of statuses for **all** tasks, including completed, in-progress, terminated, and errored tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. For a list of **in-progress** tasks, apply the isnull filter to the Completion Status field. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-task-status-list-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaskManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaskManagementV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = type eq "CLOUD_ACCOUNT_AGGREGATION" and completionStatus isnull; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in, isnull* **type**: *eq, in* **launcher**: *eq, in* **Possible Values:** CLOUD_ACCOUNT_AGGREGATION, CLOUD_GROUP_AGGREGATION, CLOUD_PROCESS_UNCORRELATED_ACCOUNTS, CLOUD_REFRESH_ROLE, SOURCE_APPLICATION_DISCOVERY, AI_AGENT_AGGREGATION, CLOUD_ENTITLEMENT_IMPORT, CLOUD_UNCORRELATED_REFRESH, CLOUD_IDENTITY_AGGREGATION, CLOUD_ATTRIBUTE_SYNCHRONIZATION, IDENTITY_REFRESH, APPLICATION_DISCOVERY, MACHINE_IDENTITY_AGGREGATION, MACHINE_IDENTITY_DELETION, ACCOUNT_DELETION (optional) +const sorters: string = -created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) +const result = await apiInstance.getTaskStatusListV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-task-status-v1 +Get task status by id +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-task-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Task ID. | [default to undefined] + +### Return type + +**TaskstatusV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TaskManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaskManagementV1Api(configuration); +const id: string = 00eebcf881994e419d72e757fd30dc0e; // Task ID. +const result = await apiInstance.getTaskStatusV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## update-task-status-v1 +Update task status by id +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-task-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Task ID. | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | The JSONPatch payload used to update the object. | + +### Return type + +**TaskstatusV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { TaskManagementV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TaskManagementV1Api(configuration); +const id: string = 00eebcf881994e419d72e757fd30dc0e; // Task ID. +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = ; // The JSONPatch payload used to update the object. +const result = await apiInstance.updateTaskStatusV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/task_management/docs/Models/ArrayInner.md b/sdk-output/task_management/docs/Models/ArrayInner.md new file mode 100644 index 00000000..8e59de84 --- /dev/null +++ b/sdk-output/task_management/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/task_management/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/task_management/docs/Models/Errormessagedto.md b/sdk-output/task_management/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..df56e529 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/task_management/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Errorresponsedto.md b/sdk-output/task_management/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..b6cea264 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/task_management/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/GetTaskStatusV1401Response.md b/sdk-output/task_management/docs/Models/GetTaskStatusV1401Response.md new file mode 100644 index 00000000..a1ce9f2d --- /dev/null +++ b/sdk-output/task_management/docs/Models/GetTaskStatusV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-task-status-v1401-response-v1 +title: GetTaskStatusV1401ResponseV1 +pagination_label: GetTaskStatusV1401ResponseV1 +sidebar_label: GetTaskStatusV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTaskStatusV1401ResponseV1', 'v1GetTaskStatusV1401ResponseV1'] +slug: /tools/sdk/typescript/task_management/models/get-task-status-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTaskStatusV1401ResponseV1', 'v1GetTaskStatusV1401ResponseV1'] +--- + +# GetTaskStatusV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/GetTaskStatusV1429Response.md b/sdk-output/task_management/docs/Models/GetTaskStatusV1429Response.md new file mode 100644 index 00000000..294986c7 --- /dev/null +++ b/sdk-output/task_management/docs/Models/GetTaskStatusV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-task-status-v1429-response-v1 +title: GetTaskStatusV1429ResponseV1 +pagination_label: GetTaskStatusV1429ResponseV1 +sidebar_label: GetTaskStatusV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTaskStatusV1429ResponseV1', 'v1GetTaskStatusV1429ResponseV1'] +slug: /tools/sdk/typescript/task_management/models/get-task-status-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTaskStatusV1429ResponseV1', 'v1GetTaskStatusV1429ResponseV1'] +--- + +# GetTaskStatusV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Index.md b/sdk-output/task_management/docs/Models/Index.md new file mode 100644 index 00000000..72b7e612 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: task_management-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: task_management-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'task_management', 'models'] +slug: /tools/sdk/typescript/task_management/models +tags: ['SDK', 'Software Development Kit', 'task_management', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/task_management/docs/Models/Jsonpatchoperation.md b/sdk-output/task_management/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..a22013b3 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/task_management/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/JsonpatchoperationValue.md b/sdk-output/task_management/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..002fb9fd --- /dev/null +++ b/sdk-output/task_management/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/task_management/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/task_management/docs/Models/Localeorigin.md b/sdk-output/task_management/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e0c2f120 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/task_management/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/task_management/docs/Models/Localizedmessage.md b/sdk-output/task_management/docs/Models/Localizedmessage.md new file mode 100644 index 00000000..dbd72a00 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Localizedmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-localizedmessage-v1 +title: LocalizedmessageV1 +pagination_label: LocalizedmessageV1 +sidebar_label: LocalizedmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +slug: /tools/sdk/typescript/task_management/models/localizedmessage-v1 +tags: ['SDK', 'Software Development Kit', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +--- + +# LocalizedmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **string** | Message locale | [default to undefined] +**message** | **string** | Message text | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/README.md b/sdk-output/task_management/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/task_management/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/task_management/docs/Models/Target.md b/sdk-output/task_management/docs/Models/Target.md new file mode 100644 index 00000000..09cd8f5e --- /dev/null +++ b/sdk-output/task_management/docs/Models/Target.md @@ -0,0 +1,21 @@ +--- +id: v1-target-v1 +title: TargetV1 +pagination_label: TargetV1 +sidebar_label: TargetV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TargetV1', 'v1TargetV1'] +slug: /tools/sdk/typescript/task_management/models/target-v1 +tags: ['SDK', 'Software Development Kit', 'TargetV1', 'v1TargetV1'] +--- + +# TargetV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Target ID | [default to undefined] +**type** | **(optional)** **string** | Target type | [default to undefined] +**name** | **(optional)** **string** | Target name | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Taskdefinitionsummary.md b/sdk-output/task_management/docs/Models/Taskdefinitionsummary.md new file mode 100644 index 00000000..72fa6591 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Taskdefinitionsummary.md @@ -0,0 +1,24 @@ +--- +id: v1-taskdefinitionsummary-v1 +title: TaskdefinitionsummaryV1 +pagination_label: TaskdefinitionsummaryV1 +sidebar_label: TaskdefinitionsummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +slug: /tools/sdk/typescript/task_management/models/taskdefinitionsummary-v1 +tags: ['SDK', 'Software Development Kit', 'TaskdefinitionsummaryV1', 'v1TaskdefinitionsummaryV1'] +--- + +# TaskdefinitionsummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the TaskDefinition | [default to undefined] +**uniqueName** | **string** | Name of the TaskDefinition | [default to undefined] +**description** | **string** | Description of the TaskDefinition | [default to undefined] +**parentName** | **string** | Name of the parent of the TaskDefinition | [default to undefined] +**executor** | **string** | Executor of the TaskDefinition | [default to undefined] +**arguments** | | Formal parameters of the TaskDefinition, without values | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Taskreturndetails.md b/sdk-output/task_management/docs/Models/Taskreturndetails.md new file mode 100644 index 00000000..066ddba8 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Taskreturndetails.md @@ -0,0 +1,20 @@ +--- +id: v1-taskreturndetails-v1 +title: TaskreturndetailsV1 +pagination_label: TaskreturndetailsV1 +sidebar_label: TaskreturndetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +slug: /tools/sdk/typescript/task_management/models/taskreturndetails-v1 +tags: ['SDK', 'Software Development Kit', 'TaskreturndetailsV1', 'v1TaskreturndetailsV1'] +--- + +# TaskreturndetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Display name of the TaskReturnDetails | [default to undefined] +**attributeName** | **string** | Attribute the TaskReturnDetails is for | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Taskstatus.md b/sdk-output/task_management/docs/Models/Taskstatus.md new file mode 100644 index 00000000..af702dd0 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Taskstatus.md @@ -0,0 +1,36 @@ +--- +id: v1-taskstatus-v1 +title: TaskstatusV1 +pagination_label: TaskstatusV1 +sidebar_label: TaskstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusV1', 'v1TaskstatusV1'] +slug: /tools/sdk/typescript/task_management/models/taskstatus-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusV1', 'v1TaskstatusV1'] +--- + +# TaskstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | System-generated unique ID of the task this TaskStatus represents | [default to undefined] +**type** | **string** | Type of task this TaskStatus represents | [default to undefined] +**uniqueName** | **string** | Name of the task this TaskStatus represents | [default to undefined] +**description** | **string** | Description of the task this TaskStatus represents | [default to undefined] +**parentName** | **string** | Name of the parent of the task this TaskStatus represents | [default to undefined] +**launcher** | **string** | Service to execute the task this TaskStatus represents | [default to undefined] +**target** | **(optional)** **TargetV1** | | [default to undefined] +**created** | **string** | Creation date of the task this TaskStatus represents | [default to undefined] +**modified** | **string** | Last modification date of the task this TaskStatus represents | [default to undefined] +**launched** | **string** | Launch date of the task this TaskStatus represents | [default to undefined] +**completed** | **string** | Completion date of the task this TaskStatus represents | [default to undefined] +**completionStatus** | **string** | Completion status of the task this TaskStatus represents | [default to undefined] +**messages** | **Array<TaskstatusmessageV1>** | Messages associated with the task this TaskStatus represents | [default to undefined] +**returns** | **Array<TaskreturndetailsV1>** | Return values from the task this TaskStatus represents | [default to undefined] +**attributes** | | Attributes of the task this TaskStatus represents | [default to undefined] +**progress** | **string** | Current progress of the task this TaskStatus represents | [default to undefined] +**percentComplete** | **number** | Current percentage completion of the task this TaskStatus represents | [default to undefined] +**taskDefinitionSummary** | **(optional)** **TaskdefinitionsummaryV1** | | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/Taskstatusmessage.md b/sdk-output/task_management/docs/Models/Taskstatusmessage.md new file mode 100644 index 00000000..7d6c3544 --- /dev/null +++ b/sdk-output/task_management/docs/Models/Taskstatusmessage.md @@ -0,0 +1,22 @@ +--- +id: v1-taskstatusmessage-v1 +title: TaskstatusmessageV1 +pagination_label: TaskstatusmessageV1 +sidebar_label: TaskstatusmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +slug: /tools/sdk/typescript/task_management/models/taskstatusmessage-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageV1', 'v1TaskstatusmessageV1'] +--- + +# TaskstatusmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Type of the message | [default to undefined] +**localizedText** | **LocalizedmessageV1** | | [default to undefined] +**key** | **string** | Key of the message | [default to undefined] +**parameters** | **Array<TaskstatusmessageParametersInnerV1>** | Message parameters for internationalization | [default to undefined] + diff --git a/sdk-output/task_management/docs/Models/TaskstatusmessageParametersInner.md b/sdk-output/task_management/docs/Models/TaskstatusmessageParametersInner.md new file mode 100644 index 00000000..5fc49a35 --- /dev/null +++ b/sdk-output/task_management/docs/Models/TaskstatusmessageParametersInner.md @@ -0,0 +1,18 @@ +--- +id: v1-taskstatusmessage-parameters-inner-v1 +title: TaskstatusmessageParametersInnerV1 +pagination_label: TaskstatusmessageParametersInnerV1 +sidebar_label: TaskstatusmessageParametersInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +slug: /tools/sdk/typescript/task_management/models/taskstatusmessage-parameters-inner-v1 +tags: ['SDK', 'Software Development Kit', 'TaskstatusmessageParametersInnerV1', 'v1TaskstatusmessageParametersInnerV1'] +--- + +# TaskstatusmessageParametersInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/tenant/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/tenant/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..5da7b9de --- /dev/null +++ b/sdk-output/tenant/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,14 @@ +- path: /tenant/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tenant/methods/tenant#get-tenant-v1 + source: | + import { TenantV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TenantV1Api(configuration); + const result = await apiInstance.getTenantV1(); + console.log(result); diff --git a/sdk-output/tenant/docs/Methods/Index.md b/sdk-output/tenant/docs/Methods/Index.md new file mode 100644 index 00000000..bfc4c1f4 --- /dev/null +++ b/sdk-output/tenant/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: tenant-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: tenant-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'tenant', 'methods'] +slug: /tools/sdk/typescript/tenant/methods +tags: ['SDK', 'Software Development Kit', 'tenant', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/tenant/docs/Methods/TenantV1Api.md b/sdk-output/tenant/docs/Methods/TenantV1Api.md new file mode 100644 index 00000000..1245f9f6 --- /dev/null +++ b/sdk-output/tenant/docs/Methods/TenantV1Api.md @@ -0,0 +1,54 @@ +--- +id: v1-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Tenant', 'v1Tenant'] +slug: /tools/sdk/typescript/tenant/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'v1Tenant'] +--- + +# TenantV1Api + API for reading tenant details. +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-v1**](#get-tenant-v1) | **GET** `/tenant/v1` | Get tenant information. + + +## get-tenant-v1 +Get tenant information. +This rest endpoint can be used to retrieve tenant details. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tenant-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**TenantV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TenantV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TenantV1Api(configuration); +const result = await apiInstance.getTenantV1(); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/tenant/docs/Models/Errormessagedto.md b/sdk-output/tenant/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..0717ee7b --- /dev/null +++ b/sdk-output/tenant/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/tenant/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/Errorresponsedto.md b/sdk-output/tenant/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..fd70c2d0 --- /dev/null +++ b/sdk-output/tenant/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/tenant/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/GetTenantV1401Response.md b/sdk-output/tenant/docs/Models/GetTenantV1401Response.md new file mode 100644 index 00000000..572e91e8 --- /dev/null +++ b/sdk-output/tenant/docs/Models/GetTenantV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-v1401-response-v1 +title: GetTenantV1401ResponseV1 +pagination_label: GetTenantV1401ResponseV1 +sidebar_label: GetTenantV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantV1401ResponseV1', 'v1GetTenantV1401ResponseV1'] +slug: /tools/sdk/typescript/tenant/models/get-tenant-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantV1401ResponseV1', 'v1GetTenantV1401ResponseV1'] +--- + +# GetTenantV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/GetTenantV1429Response.md b/sdk-output/tenant/docs/Models/GetTenantV1429Response.md new file mode 100644 index 00000000..9750e8a1 --- /dev/null +++ b/sdk-output/tenant/docs/Models/GetTenantV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-v1429-response-v1 +title: GetTenantV1429ResponseV1 +pagination_label: GetTenantV1429ResponseV1 +sidebar_label: GetTenantV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantV1429ResponseV1', 'v1GetTenantV1429ResponseV1'] +slug: /tools/sdk/typescript/tenant/models/get-tenant-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantV1429ResponseV1', 'v1GetTenantV1429ResponseV1'] +--- + +# GetTenantV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/Index.md b/sdk-output/tenant/docs/Models/Index.md new file mode 100644 index 00000000..4990a47b --- /dev/null +++ b/sdk-output/tenant/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: tenant-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: tenant-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'tenant', 'models'] +slug: /tools/sdk/typescript/tenant/models +tags: ['SDK', 'Software Development Kit', 'tenant', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/tenant/docs/Models/License.md b/sdk-output/tenant/docs/Models/License.md new file mode 100644 index 00000000..ff979da4 --- /dev/null +++ b/sdk-output/tenant/docs/Models/License.md @@ -0,0 +1,20 @@ +--- +id: v1-license-v1 +title: LicenseV1 +pagination_label: LicenseV1 +sidebar_label: LicenseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LicenseV1', 'v1LicenseV1'] +slug: /tools/sdk/typescript/tenant/models/license-v1 +tags: ['SDK', 'Software Development Kit', 'LicenseV1', 'v1LicenseV1'] +--- + +# LicenseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**licenseId** | **(optional)** **string** | Name of the license | [default to undefined] +**legacyFeatureName** | **(optional)** **string** | Legacy name of the license | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/Localeorigin.md b/sdk-output/tenant/docs/Models/Localeorigin.md new file mode 100644 index 00000000..ff79e093 --- /dev/null +++ b/sdk-output/tenant/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/tenant/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/tenant/docs/Models/Product.md b/sdk-output/tenant/docs/Models/Product.md new file mode 100644 index 00000000..fe8296e8 --- /dev/null +++ b/sdk-output/tenant/docs/Models/Product.md @@ -0,0 +1,34 @@ +--- +id: v1-product-v1 +title: ProductV1 +pagination_label: ProductV1 +sidebar_label: ProductV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProductV1', 'v1ProductV1'] +slug: /tools/sdk/typescript/tenant/models/product-v1 +tags: ['SDK', 'Software Development Kit', 'ProductV1', 'v1ProductV1'] +--- + +# ProductV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**productName** | **(optional)** **string** | Name of the Product | [default to undefined] +**url** | **(optional)** **string** | URL of the Product | [default to undefined] +**productTenantId** | **(optional)** **string** | An identifier for a specific product-tenant combination | [default to undefined] +**productRegion** | **(optional)** **string** | Product region | [default to undefined] +**productRight** | **(optional)** **string** | Right needed for the Product | [default to undefined] +**apiUrl** | **(optional)** **string** | API URL of the Product | [default to undefined] +**licenses** | **(optional)** **Array<LicenseV1>** | | [default to undefined] +**attributes** | **(optional)** | Additional attributes for a product | [default to undefined] +**zone** | **(optional)** **string** | Zone | [default to undefined] +**status** | **(optional)** **string** | Status of the product | [default to undefined] +**statusDateTime** | **(optional)** **string** | Status datetime | [default to undefined] +**reason** | **(optional)** **string** | If there\'s a tenant provisioning failure then reason will have the description of error | [default to undefined] +**notes** | **(optional)** **string** | Product could have additional notes added during tenant provisioning. | [default to undefined] +**dateCreated** | **(optional)** **string** | Date when the product was created | [default to undefined] +**lastUpdated** | **(optional)** **string** | Date when the product was last updated | [default to undefined] +**orgType** | **(optional)** **string** | Type of org | [default to undefined] + diff --git a/sdk-output/tenant/docs/Models/README.md b/sdk-output/tenant/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tenant/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/tenant/docs/Models/Tenant.md b/sdk-output/tenant/docs/Models/Tenant.md new file mode 100644 index 00000000..dfd3a8f2 --- /dev/null +++ b/sdk-output/tenant/docs/Models/Tenant.md @@ -0,0 +1,25 @@ +--- +id: v1-tenant-v1 +title: TenantV1 +pagination_label: TenantV1 +sidebar_label: TenantV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantV1', 'v1TenantV1'] +slug: /tools/sdk/typescript/tenant/models/tenant-v1 +tags: ['SDK', 'Software Development Kit', 'TenantV1', 'v1TenantV1'] +--- + +# TenantV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier for the Tenant | [readonly] [default to undefined] +**name** | **(optional)** **string** | Abbreviated name of the Tenant | [default to undefined] +**fullName** | **(optional)** **string** | Human-readable name of the Tenant | [default to undefined] +**pod** | **(optional)** **string** | Deployment pod for the Tenant | [default to undefined] +**region** | **(optional)** **string** | Deployment region for the Tenant | [default to undefined] +**description** | **(optional)** **string** | Description of the Tenant | [default to undefined] +**products** | **(optional)** **Array<ProductV1>** | | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/tenant_context/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..e30103ee --- /dev/null +++ b/sdk-output/tenant_context/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,29 @@ +- path: /tenant-context/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tenant_context/methods/tenant-context#get-tenant-context-v1 + source: | + import { TenantContextV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TenantContextV1Api(configuration); + const result = await apiInstance.getTenantContextV1(); + console.log(result); +- path: /tenant-context/v1 + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/tenant_context/methods/tenant-context#patch-tenant-context-v1 + source: | + import { TenantContextV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TenantContextV1Api(configuration); + const jsonpatchoperationV1: JsonpatchoperationV1 = [{"op":"add","path":"/Key/IAS","value":"Integrated Automation System"},{"op":"replace","path":"/Key/IAS","value":"International Accounting Standards"},{"op":"remove","path":"/Key/NDR"}]; // JsonpatchoperationV1 | + const result = await apiInstance.patchTenantContextV1(jsonpatchoperationV1); + console.log(result); diff --git a/sdk-output/tenant_context/docs/Methods/Index.md b/sdk-output/tenant_context/docs/Methods/Index.md new file mode 100644 index 00000000..cda01733 --- /dev/null +++ b/sdk-output/tenant_context/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: tenant_context-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: tenant_context-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'tenant_context', 'methods'] +slug: /tools/sdk/typescript/tenant_context/methods +tags: ['SDK', 'Software Development Kit', 'tenant_context', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/tenant_context/docs/Methods/TenantContextV1Api.md b/sdk-output/tenant_context/docs/Methods/TenantContextV1Api.md new file mode 100644 index 00000000..4853d8f4 --- /dev/null +++ b/sdk-output/tenant_context/docs/Methods/TenantContextV1Api.md @@ -0,0 +1,102 @@ +--- +id: v1-tenant-context +title: TenantContext +pagination_label: TenantContext +sidebar_label: TenantContext +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantContext', 'v1TenantContext'] +slug: /tools/sdk/typescript/tenant_context/methods/tenant-context +tags: ['SDK', 'Software Development Kit', 'TenantContext', 'v1TenantContext'] +--- + +# TenantContextV1Api + The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant. +Context key-value pairs will consist of common terms and acronyms used within your organization. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-context-v1**](#get-tenant-context-v1) | **GET** `/tenant-context/v1` | Retrieve tenant context +[**patch-tenant-context-v1**](#patch-tenant-context-v1) | **PATCH** `/tenant-context/v1` | Update tenant context + + +## get-tenant-context-v1 +Retrieve tenant context +Returns all key-value pairs representing the current state of the tenant's context. +Each tenant is limited to a maximum of 100 key-value pairs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tenant-context-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TenantContextV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TenantContextV1Api(configuration); +const result = await apiInstance.getTenantContextV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-tenant-context-v1 +Update tenant context +Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs. + +Note that each tenant is limited to a maximum of 100 key-value pairs. + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-tenant-context-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**jsonpatchoperationV1** | **JsonpatchoperationV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { TenantContextV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TenantContextV1Api(configuration); +const jsonpatchoperationV1: JsonpatchoperationV1 = [{"op":"add","path":"/Key/IAS","value":"Integrated Automation System"},{"op":"replace","path":"/Key/IAS","value":"International Accounting Standards"},{"op":"remove","path":"/Key/NDR"}]; // +const result = await apiInstance.patchTenantContextV1(jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/tenant_context/docs/Models/ArrayInner.md b/sdk-output/tenant_context/docs/Models/ArrayInner.md new file mode 100644 index 00000000..b308b337 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/tenant_context/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/tenant_context/docs/Models/Errormessagedto.md b/sdk-output/tenant_context/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..6f17c8a7 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/tenant_context/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/Errorresponsedto.md b/sdk-output/tenant_context/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..a720b0ed --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/tenant_context/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/GetTenantContextV1200ResponseInner.md b/sdk-output/tenant_context/docs/Models/GetTenantContextV1200ResponseInner.md new file mode 100644 index 00000000..35e1d6b9 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/GetTenantContextV1200ResponseInner.md @@ -0,0 +1,20 @@ +--- +id: v1-get-tenant-context-v1200-response-inner-v1 +title: GetTenantContextV1200ResponseInnerV1 +pagination_label: GetTenantContextV1200ResponseInnerV1 +sidebar_label: GetTenantContextV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantContextV1200ResponseInnerV1', 'v1GetTenantContextV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/tenant_context/models/get-tenant-context-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantContextV1200ResponseInnerV1', 'v1GetTenantContextV1200ResponseInnerV1'] +--- + +# GetTenantContextV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **(optional)** **string** | | [default to undefined] +**value** | **(optional)** **string** | | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/GetTenantContextV1401Response.md b/sdk-output/tenant_context/docs/Models/GetTenantContextV1401Response.md new file mode 100644 index 00000000..e35e6be1 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/GetTenantContextV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-context-v1401-response-v1 +title: GetTenantContextV1401ResponseV1 +pagination_label: GetTenantContextV1401ResponseV1 +sidebar_label: GetTenantContextV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantContextV1401ResponseV1', 'v1GetTenantContextV1401ResponseV1'] +slug: /tools/sdk/typescript/tenant_context/models/get-tenant-context-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantContextV1401ResponseV1', 'v1GetTenantContextV1401ResponseV1'] +--- + +# GetTenantContextV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/GetTenantContextV1429Response.md b/sdk-output/tenant_context/docs/Models/GetTenantContextV1429Response.md new file mode 100644 index 00000000..dc07384e --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/GetTenantContextV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-context-v1429-response-v1 +title: GetTenantContextV1429ResponseV1 +pagination_label: GetTenantContextV1429ResponseV1 +sidebar_label: GetTenantContextV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantContextV1429ResponseV1', 'v1GetTenantContextV1429ResponseV1'] +slug: /tools/sdk/typescript/tenant_context/models/get-tenant-context-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantContextV1429ResponseV1', 'v1GetTenantContextV1429ResponseV1'] +--- + +# GetTenantContextV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/Index.md b/sdk-output/tenant_context/docs/Models/Index.md new file mode 100644 index 00000000..2115509c --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: tenant_context-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: tenant_context-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'tenant_context', 'models'] +slug: /tools/sdk/typescript/tenant_context/models +tags: ['SDK', 'Software Development Kit', 'tenant_context', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/tenant_context/docs/Models/Jsonpatchoperation.md b/sdk-output/tenant_context/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..bd608423 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/tenant_context/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/tenant_context/docs/Models/JsonpatchoperationValue.md b/sdk-output/tenant_context/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..72bd720a --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/tenant_context/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/tenant_context/docs/Models/Localeorigin.md b/sdk-output/tenant_context/docs/Models/Localeorigin.md new file mode 100644 index 00000000..a5cd74b8 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/tenant_context/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/tenant_context/docs/Models/README.md b/sdk-output/tenant_context/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/tenant_context/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/transforms/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/transforms/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..6c79761f --- /dev/null +++ b/sdk-output/transforms/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,80 @@ +- path: /transforms/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/transforms/methods/transforms#create-transform-v1 + source: | + import { TransformsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TransformsV1Api(configuration); + const transformV1: TransformV1 = {"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}; // TransformV1 | The transform to be created. + const result = await apiInstance.createTransformV1(transformV1); + console.log(result); +- path: /transforms/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/transforms/methods/transforms#delete-transform-v1 + source: | + import { TransformsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TransformsV1Api(configuration); + const id: string = '2cd78adghjkja34jh2b1hkjhasuecd'; // string | ID of the transform to delete (default to undefined) + const result = await apiInstance.deleteTransformV1(id); + console.log(result); +- path: /transforms/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/transforms/methods/transforms#get-transform-v1 + source: | + import { TransformsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TransformsV1Api(configuration); + const id: string = '2cd78adghjkja34jh2b1hkjhasuecd'; // string | ID of the transform to retrieve (default to undefined) + const result = await apiInstance.getTransformV1(id); + console.log(result); +- path: /transforms/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/transforms/methods/transforms#list-transforms-v1 + source: | + import { TransformsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TransformsV1Api(configuration); + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const name: string = 'ExampleTransformName123'; // string | Name of the transform to retrieve from the list. (optional) (default to undefined) + const filters: string = 'name eq "Uppercase"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) (default to undefined) + const result = await apiInstance.listTransformsV1(); + console.log(result); +- path: /transforms/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/transforms/methods/transforms#update-transform-v1 + source: | + import { TransformsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TransformsV1Api(configuration); + const id: string = '2cd78adghjkja34jh2b1hkjhasuecd'; // string | ID of the transform to update (default to undefined) + const transformV1: TransformV1 = {"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}; // TransformV1 | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) + const result = await apiInstance.updateTransformV1(id); + console.log(result); diff --git a/sdk-output/transforms/docs/Methods/Index.md b/sdk-output/transforms/docs/Methods/Index.md new file mode 100644 index 00000000..e8ef5019 --- /dev/null +++ b/sdk-output/transforms/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: transforms-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: transforms-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'transforms', 'methods'] +slug: /tools/sdk/typescript/transforms/methods +tags: ['SDK', 'Software Development Kit', 'transforms', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/transforms/docs/Methods/TransformsV1Api.md b/sdk-output/transforms/docs/Methods/TransformsV1Api.md new file mode 100644 index 00000000..31589891 --- /dev/null +++ b/sdk-output/transforms/docs/Methods/TransformsV1Api.md @@ -0,0 +1,229 @@ +--- +id: v1-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Transforms', 'v1Transforms'] +slug: /tools/sdk/typescript/transforms/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'v1Transforms'] +--- + +# TransformsV1Api + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-transform-v1**](#create-transform-v1) | **POST** `/transforms/v1` | Create transform +[**delete-transform-v1**](#delete-transform-v1) | **DELETE** `/transforms/v1/{id}` | Delete a transform +[**get-transform-v1**](#get-transform-v1) | **GET** `/transforms/v1/{id}` | Transform by id +[**list-transforms-v1**](#list-transforms-v1) | **GET** `/transforms/v1` | List transforms +[**update-transform-v1**](#update-transform-v1) | **PUT** `/transforms/v1/{id}` | Update a transform + + +## create-transform-v1 +Create transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-transform-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**transformV1** | **TransformV1** | The transform to be created. | + +### Return type + +**TransformreadV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TransformsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TransformsV1Api(configuration); +const transformV1: TransformV1 = {"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM dd yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}; // The transform to be created. +const result = await apiInstance.createTransformV1(transformV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-transform-v1 +Delete a transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-transform-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the transform to delete | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TransformsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TransformsV1Api(configuration); +const id: string = 2cd78adghjkja34jh2b1hkjhasuecd; // ID of the transform to delete +const result = await apiInstance.deleteTransformV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-transform-v1 +Transform by id +This API returns the transform specified by the given ID. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-transform-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the transform to retrieve | [default to undefined] + +### Return type + +**TransformreadV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TransformsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TransformsV1Api(configuration); +const id: string = 2cd78adghjkja34jh2b1hkjhasuecd; // ID of the transform to retrieve +const result = await apiInstance.getTransformV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-transforms-v1 +List transforms +Gets a list of all saved transform objects. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-transforms-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**name** | **string** | Name of the transform to retrieve from the list. | [optional] [default to undefined] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TransformsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TransformsV1Api(configuration); +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const name: string = ExampleTransformName123; // Name of the transform to retrieve from the list. (optional) +const filters: string = name eq "Uppercase"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) +const result = await apiInstance.listTransformsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## update-transform-v1 +Update a transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-transform-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the transform to update | [default to undefined] +**transformV1** | **TransformV1** | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. | [optional] + +### Return type + +**TransformreadV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TransformsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TransformsV1Api(configuration); +const id: string = 2cd78adghjkja34jh2b1hkjhasuecd; // ID of the transform to update +const transformV1: TransformV1 = {"name":"Timestamp To Date","type":"dateFormat","attributes":{"inputFormat":"MMM-dd-yyyy, HH:mm:ss.SSS","outputFormat":"yyyy/dd/MM"}}; // The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional) +const result = await apiInstance.updateTransformV1(id); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/transforms/docs/Models/Errormessagedto.md b/sdk-output/transforms/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..8521bc53 --- /dev/null +++ b/sdk-output/transforms/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/transforms/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/transforms/docs/Models/Errorresponsedto.md b/sdk-output/transforms/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..ba9c5d94 --- /dev/null +++ b/sdk-output/transforms/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/transforms/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/transforms/docs/Models/Index.md b/sdk-output/transforms/docs/Models/Index.md new file mode 100644 index 00000000..30bbc410 --- /dev/null +++ b/sdk-output/transforms/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: transforms-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: transforms-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'transforms', 'models'] +slug: /tools/sdk/typescript/transforms/models +tags: ['SDK', 'Software Development Kit', 'transforms', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/transforms/docs/Models/ListTransformsV1401Response.md b/sdk-output/transforms/docs/Models/ListTransformsV1401Response.md new file mode 100644 index 00000000..c8117f5e --- /dev/null +++ b/sdk-output/transforms/docs/Models/ListTransformsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-transforms-v1401-response-v1 +title: ListTransformsV1401ResponseV1 +pagination_label: ListTransformsV1401ResponseV1 +sidebar_label: ListTransformsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTransformsV1401ResponseV1', 'v1ListTransformsV1401ResponseV1'] +slug: /tools/sdk/typescript/transforms/models/list-transforms-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTransformsV1401ResponseV1', 'v1ListTransformsV1401ResponseV1'] +--- + +# ListTransformsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/transforms/docs/Models/ListTransformsV1429Response.md b/sdk-output/transforms/docs/Models/ListTransformsV1429Response.md new file mode 100644 index 00000000..d91b4b29 --- /dev/null +++ b/sdk-output/transforms/docs/Models/ListTransformsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-transforms-v1429-response-v1 +title: ListTransformsV1429ResponseV1 +pagination_label: ListTransformsV1429ResponseV1 +sidebar_label: ListTransformsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTransformsV1429ResponseV1', 'v1ListTransformsV1429ResponseV1'] +slug: /tools/sdk/typescript/transforms/models/list-transforms-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTransformsV1429ResponseV1', 'v1ListTransformsV1429ResponseV1'] +--- + +# ListTransformsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/transforms/docs/Models/Localeorigin.md b/sdk-output/transforms/docs/Models/Localeorigin.md new file mode 100644 index 00000000..42eb9b03 --- /dev/null +++ b/sdk-output/transforms/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/transforms/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/transforms/docs/Models/README.md b/sdk-output/transforms/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/transforms/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/transforms/docs/Models/Transform.md b/sdk-output/transforms/docs/Models/Transform.md new file mode 100644 index 00000000..12ef028e --- /dev/null +++ b/sdk-output/transforms/docs/Models/Transform.md @@ -0,0 +1,21 @@ +--- +id: v1-transform-v1 +title: TransformV1 +pagination_label: TransformV1 +sidebar_label: TransformV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransformV1', 'v1TransformV1'] +slug: /tools/sdk/typescript/transforms/models/transform-v1 +tags: ['SDK', 'Software Development Kit', 'TransformV1', 'v1TransformV1'] +--- + +# TransformV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Unique name of this transform | [default to undefined] +**type** | **string** | The type of transform operation | [default to undefined] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [default to undefined] + diff --git a/sdk-output/transforms/docs/Models/Transformread.md b/sdk-output/transforms/docs/Models/Transformread.md new file mode 100644 index 00000000..40b1a25e --- /dev/null +++ b/sdk-output/transforms/docs/Models/Transformread.md @@ -0,0 +1,23 @@ +--- +id: v1-transformread-v1 +title: TransformreadV1 +pagination_label: TransformreadV1 +sidebar_label: TransformreadV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TransformreadV1', 'v1TransformreadV1'] +slug: /tools/sdk/typescript/transforms/models/transformread-v1 +tags: ['SDK', 'Software Development Kit', 'TransformreadV1', 'v1TransformreadV1'] +--- + +# TransformreadV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Unique name of this transform | [default to undefined] +**type** | **string** | The type of transform operation | [default to undefined] +**attributes** | **object** | Meta-data about the transform. Values in this list are specific to the type of transform to be executed. | [default to undefined] +**id** | **string** | Unique ID of this transform | [default to undefined] +**internal** | **boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [default to false] + diff --git a/sdk-output/triggers/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/triggers/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..a29c8ff2 --- /dev/null +++ b/sdk-output/triggers/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,165 @@ +- path: /trigger-invocations/v1/{id}/complete + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#complete-trigger-invocation-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | The ID of the invocation to complete. (default to undefined) + const completeinvocationV1: CompleteinvocationV1 = {"secret":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","output":{"approved":false}}; // CompleteinvocationV1 | + const result = await apiInstance.completeTriggerInvocationV1(id, completeinvocationV1); + console.log(result); +- path: /trigger-subscriptions/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#create-subscription-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const subscriptionpostrequestV1: SubscriptionpostrequestV1 = {"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // SubscriptionpostrequestV1 | + const result = await apiInstance.createSubscriptionV1(subscriptionpostrequestV1); + console.log(result); +- path: /trigger-subscriptions/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#delete-subscription-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | Subscription ID (default to undefined) + const result = await apiInstance.deleteSubscriptionV1(id); + console.log(result); +- path: /trigger-subscriptions/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#list-subscriptions-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) (default to undefined) + const sorters: string = 'triggerName'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) (default to undefined) + const result = await apiInstance.listSubscriptionsV1(); + console.log(result); +- path: /trigger-invocations/v1/status + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#list-trigger-invocation-status-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'triggerId eq "idn:access-request-dynamic-approver"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) (default to undefined) + const sorters: string = 'created'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) (default to undefined) + const result = await apiInstance.listTriggerInvocationStatusV1(); + console.log(result); +- path: /triggers/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#list-triggers-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const filters: string = 'id eq "idn:access-request-post-approval"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) (default to undefined) + const sorters: string = 'name'; // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) (default to undefined) + const result = await apiInstance.listTriggersV1(); + console.log(result); +- path: /trigger-subscriptions/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#patch-subscription-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | ID of the Subscription to patch (default to undefined) + const subscriptionpatchrequestInnerV1: Array<SubscriptionpatchrequestInnerV1> = ; // Array | + const result = await apiInstance.patchSubscriptionV1(id, subscriptionpatchrequestInnerV1); + console.log(result); +- path: /trigger-invocations/v1/test + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#start-test-trigger-invocation-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const testinvocationV1: TestinvocationV1 = {"triggerId":"idn:access-requested","input":{"identityId":"201327fda1c44704ac01181e963d463c"},"contentJson":{"workflowId":1234}}; // TestinvocationV1 | + const result = await apiInstance.startTestTriggerInvocationV1(testinvocationV1); + console.log(result); +- path: /trigger-subscriptions/v1/validate-filter + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#test-subscription-filter-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const validatefilterinputdtoV1: ValidatefilterinputdtoV1 = {"input":{"identityId":"201327fda1c44704ac01181e963d463c"},"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // ValidatefilterinputdtoV1 | + const result = await apiInstance.testSubscriptionFilterV1(validatefilterinputdtoV1); + console.log(result); +- path: /trigger-subscriptions/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/triggers/methods/triggers#update-subscription-v1 + source: | + import { TriggersV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new TriggersV1Api(configuration); + const id: string = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde'; // string | Subscription ID (default to undefined) + const subscriptionputrequestV1: SubscriptionputrequestV1 = {"name":"Access request subscription","description":"Access requested to site xyz","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // SubscriptionputrequestV1 | + const result = await apiInstance.updateSubscriptionV1(id, subscriptionputrequestV1); + console.log(result); diff --git a/sdk-output/triggers/docs/Methods/Index.md b/sdk-output/triggers/docs/Methods/Index.md new file mode 100644 index 00000000..dfcae5d6 --- /dev/null +++ b/sdk-output/triggers/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: triggers-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: triggers-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'triggers', 'methods'] +slug: /tools/sdk/typescript/triggers/methods +tags: ['SDK', 'Software Development Kit', 'triggers', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/triggers/docs/Methods/TriggersV1Api.md b/sdk-output/triggers/docs/Methods/TriggersV1Api.md new file mode 100644 index 00000000..56f99538 --- /dev/null +++ b/sdk-output/triggers/docs/Methods/TriggersV1Api.md @@ -0,0 +1,485 @@ +--- +id: v1-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Triggers', 'v1Triggers'] +slug: /tools/sdk/typescript/triggers/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'v1Triggers'] +--- + +# TriggersV1Api + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**complete-trigger-invocation-v1**](#complete-trigger-invocation-v1) | **POST** `/trigger-invocations/v1/{id}/complete` | Complete trigger invocation +[**create-subscription-v1**](#create-subscription-v1) | **POST** `/trigger-subscriptions/v1` | Create a subscription +[**delete-subscription-v1**](#delete-subscription-v1) | **DELETE** `/trigger-subscriptions/v1/{id}` | Delete a subscription +[**list-subscriptions-v1**](#list-subscriptions-v1) | **GET** `/trigger-subscriptions/v1` | List subscriptions +[**list-trigger-invocation-status-v1**](#list-trigger-invocation-status-v1) | **GET** `/trigger-invocations/v1/status` | List latest invocation statuses +[**list-triggers-v1**](#list-triggers-v1) | **GET** `/triggers/v1` | List triggers +[**patch-subscription-v1**](#patch-subscription-v1) | **PATCH** `/trigger-subscriptions/v1/{id}` | Patch a subscription +[**start-test-trigger-invocation-v1**](#start-test-trigger-invocation-v1) | **POST** `/trigger-invocations/v1/test` | Start a test invocation +[**test-subscription-filter-v1**](#test-subscription-filter-v1) | **POST** `/trigger-subscriptions/v1/validate-filter` | Validate a subscription filter +[**update-subscription-v1**](#update-subscription-v1) | **PUT** `/trigger-subscriptions/v1/{id}` | Update a subscription + + +## complete-trigger-invocation-v1 +Complete trigger invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/complete-trigger-invocation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the invocation to complete. | [default to undefined] +**completeinvocationV1** | **CompleteinvocationV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // The ID of the invocation to complete. +const completeinvocationV1: CompleteinvocationV1 = {"secret":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde","output":{"approved":false}}; // +const result = await apiInstance.completeTriggerInvocationV1(id, completeinvocationV1); +console.log(result); +``` + +[[Back to top]](#) + +## create-subscription-v1 +Create a subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-subscription-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**subscriptionpostrequestV1** | **SubscriptionpostrequestV1** | | + +### Return type + +**SubscriptionV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const subscriptionpostrequestV1: SubscriptionpostrequestV1 = {"name":"Access request subscription","description":"Access requested to site xyz","triggerId":"idn:access-requested","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // +const result = await apiInstance.createSubscriptionV1(subscriptionpostrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-subscription-v1 +Delete a subscription +Deletes an existing subscription to a trigger. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-subscription-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Subscription ID | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // Subscription ID +const result = await apiInstance.deleteSubscriptionV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-subscriptions-v1 +List subscriptions +Gets a list of all trigger subscriptions. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-subscriptions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) +const sorters: string = triggerName; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) +const result = await apiInstance.listSubscriptionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-trigger-invocation-status-v1 +List latest invocation statuses +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-trigger-invocation-status-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = triggerId eq "idn:access-request-dynamic-approver"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) +const sorters: string = created; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) +const result = await apiInstance.listTriggerInvocationStatusV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-triggers-v1 +List triggers +Gets a list of triggers that are available in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-triggers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* | [optional] [default to undefined] +**sorters** | **string** | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "idn:access-request-post-approval"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) +const sorters: string = name; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) +const result = await apiInstance.listTriggersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-subscription-v1 +Patch a subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-subscription-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the Subscription to patch | [default to undefined] +**subscriptionpatchrequestInnerV1** | **Array<SubscriptionpatchrequestInnerV1>** | | + +### Return type + +**SubscriptionV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // ID of the Subscription to patch +const subscriptionpatchrequestInnerV1: Array<SubscriptionpatchrequestInnerV1> = ; // +const result = await apiInstance.patchSubscriptionV1(id, subscriptionpatchrequestInnerV1); +console.log(result); +``` + +[[Back to top]](#) + +## start-test-trigger-invocation-v1 +Start a test invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/start-test-trigger-invocation-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**testinvocationV1** | **TestinvocationV1** | | + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const testinvocationV1: TestinvocationV1 = {"triggerId":"idn:access-requested","input":{"identityId":"201327fda1c44704ac01181e963d463c"},"contentJson":{"workflowId":1234}}; // +const result = await apiInstance.startTestTriggerInvocationV1(testinvocationV1); +console.log(result); +``` + +[[Back to top]](#) + +## test-subscription-filter-v1 +Validate a subscription filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-subscription-filter-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**validatefilterinputdtoV1** | **ValidatefilterinputdtoV1** | | + +### Return type + +**ValidatefilteroutputdtoV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const validatefilterinputdtoV1: ValidatefilterinputdtoV1 = {"input":{"identityId":"201327fda1c44704ac01181e963d463c"},"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // +const result = await apiInstance.testSubscriptionFilterV1(validatefilterinputdtoV1); +console.log(result); +``` + +[[Back to top]](#) + +## update-subscription-v1 +Update a subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/update-subscription-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Subscription ID | [default to undefined] +**subscriptionputrequestV1** | **SubscriptionputrequestV1** | | + +### Return type + +**SubscriptionV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { TriggersV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new TriggersV1Api(configuration); +const id: string = 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde; // Subscription ID +const subscriptionputrequestV1: SubscriptionputrequestV1 = {"name":"Access request subscription","description":"Access requested to site xyz","type":"HTTP","httpConfig":{"url":"https://www.example.com","httpDispatchMode":"SYNC","httpAuthenticationType":"BASIC_AUTH","basicAuthConfig":{"userName":"user@example.com","password":"eRtg4%6yuI!"}},"enabled":true,"filter":"$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]"}; // +const result = await apiInstance.updateSubscriptionV1(id, subscriptionputrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/triggers/docs/Models/Accessitemapproverdto.md b/sdk-output/triggers/docs/Models/Accessitemapproverdto.md new file mode 100644 index 00000000..bde92a69 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessitemapproverdto.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemapproverdto-v1 +title: AccessitemapproverdtoV1 +pagination_label: AccessitemapproverdtoV1 +sidebar_label: AccessitemapproverdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemapproverdtoV1', 'v1AccessitemapproverdtoV1'] +slug: /tools/sdk/typescript/triggers/models/accessitemapproverdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemapproverdtoV1', 'v1AccessitemapproverdtoV1'] +--- + +# AccessitemapproverdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity who approved the access item request. | [default to undefined] +**id** | **(optional)** **string** | ID of identity who approved the access item request. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity who approved the access item request. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessitemrequestedfordto.md b/sdk-output/triggers/docs/Models/Accessitemrequestedfordto.md new file mode 100644 index 00000000..1c212d95 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessitemrequestedfordto.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemrequestedfordto-v1 +title: AccessitemrequestedfordtoV1 +pagination_label: AccessitemrequestedfordtoV1 +sidebar_label: AccessitemrequestedfordtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrequestedfordtoV1', 'v1AccessitemrequestedfordtoV1'] +slug: /tools/sdk/typescript/triggers/models/accessitemrequestedfordto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrequestedfordtoV1', 'v1AccessitemrequestedfordtoV1'] +--- + +# AccessitemrequestedfordtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | DTO type of identity the access item is requested for. | [default to undefined] +**id** | **(optional)** **string** | ID of identity the access item is requested for. | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity the access item is requested for. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessitemrequesterdto.md b/sdk-output/triggers/docs/Models/Accessitemrequesterdto.md new file mode 100644 index 00000000..1f38c1c1 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessitemrequesterdto.md @@ -0,0 +1,21 @@ +--- +id: v1-accessitemrequesterdto-v1 +title: AccessitemrequesterdtoV1 +pagination_label: AccessitemrequesterdtoV1 +sidebar_label: AccessitemrequesterdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessitemrequesterdtoV1', 'v1AccessitemrequesterdtoV1'] +slug: /tools/sdk/typescript/triggers/models/accessitemrequesterdto-v1 +tags: ['SDK', 'Software Development Kit', 'AccessitemrequesterdtoV1', 'v1AccessitemrequesterdtoV1'] +--- + +# AccessitemrequesterdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Access item requester\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Access item requester\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Access item owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover.md b/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover.md new file mode 100644 index 00000000..48c9f3db --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequestdynamicapprover-v1 +title: AccessrequestdynamicapproverV1 +pagination_label: AccessrequestdynamicapproverV1 +sidebar_label: AccessrequestdynamicapproverV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestdynamicapproverV1', 'v1AccessrequestdynamicapproverV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestdynamicapprover-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestdynamicapproverV1', 'v1AccessrequestdynamicapproverV1'] +--- + +# AccessrequestdynamicapproverV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestId** | **string** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [default to undefined] +**requestedFor** | **Array<AccessitemrequestedfordtoV1>** | Identities access was requested for. | [default to undefined] +**requestedItems** | **Array<AccessrequestdynamicapproverRequestedItemsInnerV1>** | The access items that are being requested. | [default to undefined] +**requestedBy** | **AccessitemrequesterdtoV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover2.md b/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover2.md new file mode 100644 index 00000000..3e0e56e8 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessrequestdynamicapprover2.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestdynamicapprover2-v1 +title: Accessrequestdynamicapprover2V1 +pagination_label: Accessrequestdynamicapprover2V1 +sidebar_label: Accessrequestdynamicapprover2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accessrequestdynamicapprover2V1', 'v1Accessrequestdynamicapprover2V1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestdynamicapprover2-v1 +tags: ['SDK', 'Software Development Kit', 'Accessrequestdynamicapprover2V1', 'v1Accessrequestdynamicapprover2V1'] +--- + +# Accessrequestdynamicapprover2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the identity to add to the approver list for the access request. | [default to undefined] +**name** | **string** | The name of the identity to add to the approver list for the access request. | [default to undefined] +**type** | **string** | The type of object being referenced. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccessrequestdynamicapproverRequestedItemsInner.md b/sdk-output/triggers/docs/Models/AccessrequestdynamicapproverRequestedItemsInner.md new file mode 100644 index 00000000..0dfe7fd7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccessrequestdynamicapproverRequestedItemsInner.md @@ -0,0 +1,24 @@ +--- +id: v1-accessrequestdynamicapprover-requested-items-inner-v1 +title: AccessrequestdynamicapproverRequestedItemsInnerV1 +pagination_label: AccessrequestdynamicapproverRequestedItemsInnerV1 +sidebar_label: AccessrequestdynamicapproverRequestedItemsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestdynamicapproverRequestedItemsInnerV1', 'v1AccessrequestdynamicapproverRequestedItemsInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestdynamicapprover-requested-items-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestdynamicapproverRequestedItemsInnerV1', 'v1AccessrequestdynamicapproverRequestedItemsInnerV1'] +--- + +# AccessrequestdynamicapproverRequestedItemsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the access item. | [default to undefined] +**name** | **string** | Human friendly name of the access item. | [default to undefined] +**description** | **(optional)** **string** | Extended description of the access item. | [default to undefined] +**type** | **string** | The type of access item being requested. | [default to undefined] +**operation** | **string** | Grant or revoke the access item | [default to undefined] +**comment** | **(optional)** **string** | A comment from the requestor on why the access is needed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessrequestpostapproval.md b/sdk-output/triggers/docs/Models/Accessrequestpostapproval.md new file mode 100644 index 00000000..9ddf9419 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessrequestpostapproval.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequestpostapproval-v1 +title: AccessrequestpostapprovalV1 +pagination_label: AccessrequestpostapprovalV1 +sidebar_label: AccessrequestpostapprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpostapprovalV1', 'v1AccessrequestpostapprovalV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpostapproval-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpostapprovalV1', 'v1AccessrequestpostapprovalV1'] +--- + +# AccessrequestpostapprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestId** | **string** | The unique ID of the access request. | [default to undefined] +**requestedFor** | **Array<AccessitemrequestedfordtoV1>** | Identities access was requested for. | [default to undefined] +**requestedItemsStatus** | **Array<AccessrequestpostapprovalRequestedItemsStatusInnerV1>** | Details on the outcome of each access item. | [default to undefined] +**requestedBy** | **AccessitemrequesterdtoV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInner.md b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInner.md new file mode 100644 index 00000000..c82cd042 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInner.md @@ -0,0 +1,26 @@ +--- +id: v1-accessrequestpostapproval-requested-items-status-inner-v1 +title: AccessrequestpostapprovalRequestedItemsStatusInnerV1 +pagination_label: AccessrequestpostapprovalRequestedItemsStatusInnerV1 +sidebar_label: AccessrequestpostapprovalRequestedItemsStatusInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpostapprovalRequestedItemsStatusInnerV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpostapproval-requested-items-status-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpostapprovalRequestedItemsStatusInnerV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerV1'] +--- + +# AccessrequestpostapprovalRequestedItemsStatusInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the access item being requested. | [default to undefined] +**name** | **string** | The human friendly name of the access item. | [default to undefined] +**description** | **(optional)** **string** | Detailed description of the access item. | [default to undefined] +**type** | **string** | The type of access item. | [default to undefined] +**operation** | **string** | The action to perform on the access item. | [default to undefined] +**comment** | **(optional)** **string** | A comment from the identity requesting the access. | [default to undefined] +**clientMetadata** | **(optional)** | Additional customer defined metadata about the access item. | [default to undefined] +**approvalInfo** | **Array<AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1>** | A list of one or more approvers for the access request. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInner.md b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 00000000..fa5c9f0d --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequestpostapproval-requested-items-status-inner-approval-info-inner-v1 +title: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 +pagination_label: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 +sidebar_label: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpostapproval-requested-items-status-inner-approval-info-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1'] +--- + +# AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approvalComment** | **(optional)** **string** | A comment left by the approver. | [default to undefined] +**approvalDecision** | **string** | The final decision of the approver. | [default to undefined] +**approverName** | **string** | The name of the approver | [default to undefined] +**approver** | **AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 00000000..29260373 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestpostapproval-requested-items-status-inner-approval-info-inner-approver-v1 +title: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 +pagination_label: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 +sidebar_label: AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpostapproval-requested-items-status-inner-approval-info-inner-approver-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1', 'v1AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1'] +--- + +# AccessrequestpostapprovalRequestedItemsStatusInnerApprovalInfoInnerApproverV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of object that is referenced | [default to undefined] +**id** | **string** | ID of identity who approved the access item request. | [default to undefined] +**name** | **string** | Human-readable display name of identity who approved the access item request. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessrequestpreapproval.md b/sdk-output/triggers/docs/Models/Accessrequestpreapproval.md new file mode 100644 index 00000000..359b184f --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessrequestpreapproval.md @@ -0,0 +1,22 @@ +--- +id: v1-accessrequestpreapproval-v1 +title: AccessrequestpreapprovalV1 +pagination_label: AccessrequestpreapprovalV1 +sidebar_label: AccessrequestpreapprovalV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpreapprovalV1', 'v1AccessrequestpreapprovalV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpreapproval-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpreapprovalV1', 'v1AccessrequestpreapprovalV1'] +--- + +# AccessrequestpreapprovalV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestId** | **string** | The unique ID of the access request. | [default to undefined] +**requestedFor** | **Array<AccessitemrequestedfordtoV1>** | Identities access was requested for. | [default to undefined] +**requestedItems** | **Array<AccessrequestpreapprovalRequestedItemsInnerV1>** | Details of the access items being requested. | [default to undefined] +**requestedBy** | **AccessitemrequesterdtoV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accessrequestpreapproval2.md b/sdk-output/triggers/docs/Models/Accessrequestpreapproval2.md new file mode 100644 index 00000000..e455586c --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accessrequestpreapproval2.md @@ -0,0 +1,21 @@ +--- +id: v1-accessrequestpreapproval2-v1 +title: Accessrequestpreapproval2V1 +pagination_label: Accessrequestpreapproval2V1 +sidebar_label: Accessrequestpreapproval2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accessrequestpreapproval2V1', 'v1Accessrequestpreapproval2V1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpreapproval2-v1 +tags: ['SDK', 'Software Development Kit', 'Accessrequestpreapproval2V1', 'v1Accessrequestpreapproval2V1'] +--- + +# Accessrequestpreapproval2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**approved** | **boolean** | Whether or not to approve the access request. | [default to undefined] +**comment** | **string** | A comment about the decision to approve or deny the request. | [default to undefined] +**approver** | **string** | The name of the entity that approved or denied the request. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccessrequestpreapprovalRequestedItemsInner.md b/sdk-output/triggers/docs/Models/AccessrequestpreapprovalRequestedItemsInner.md new file mode 100644 index 00000000..3aef0abd --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccessrequestpreapprovalRequestedItemsInner.md @@ -0,0 +1,24 @@ +--- +id: v1-accessrequestpreapproval-requested-items-inner-v1 +title: AccessrequestpreapprovalRequestedItemsInnerV1 +pagination_label: AccessrequestpreapprovalRequestedItemsInnerV1 +sidebar_label: AccessrequestpreapprovalRequestedItemsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccessrequestpreapprovalRequestedItemsInnerV1', 'v1AccessrequestpreapprovalRequestedItemsInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accessrequestpreapproval-requested-items-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccessrequestpreapprovalRequestedItemsInnerV1', 'v1AccessrequestpreapprovalRequestedItemsInnerV1'] +--- + +# AccessrequestpreapprovalRequestedItemsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the access item being requested. | [default to undefined] +**name** | **string** | The human friendly name of the access item. | [default to undefined] +**description** | **(optional)** **string** | Detailed description of the access item. | [default to undefined] +**type** | **string** | The type of access item. | [default to undefined] +**operation** | **string** | The action to perform on the access item. | [default to undefined] +**comment** | **(optional)** **string** | A comment from the identity requesting the access. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountaggregationcompleted.md b/sdk-output/triggers/docs/Models/Accountaggregationcompleted.md new file mode 100644 index 00000000..03c4710d --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountaggregationcompleted.md @@ -0,0 +1,25 @@ +--- +id: v1-accountaggregationcompleted-v1 +title: AccountaggregationcompletedV1 +pagination_label: AccountaggregationcompletedV1 +sidebar_label: AccountaggregationcompletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountaggregationcompletedV1', 'v1AccountaggregationcompletedV1'] +slug: /tools/sdk/typescript/triggers/models/accountaggregationcompleted-v1 +tags: ['SDK', 'Software Development Kit', 'AccountaggregationcompletedV1', 'v1AccountaggregationcompletedV1'] +--- + +# AccountaggregationcompletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **AccountaggregationcompletedSourceV1** | | [default to undefined] +**status** | **string** | The overall status of the aggregation. | [default to undefined] +**started** | **string** | The date and time when the account aggregation started. | [default to undefined] +**completed** | **string** | The date and time when the account aggregation finished. | [default to undefined] +**errors** | **Array<string>** | A list of errors that occurred during the aggregation. | [default to undefined] +**warnings** | **Array<string>** | A list of warnings that occurred during the aggregation. | [default to undefined] +**stats** | **AccountaggregationcompletedStatsV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountaggregationcompletedSource.md b/sdk-output/triggers/docs/Models/AccountaggregationcompletedSource.md new file mode 100644 index 00000000..7edd0d31 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountaggregationcompletedSource.md @@ -0,0 +1,21 @@ +--- +id: v1-accountaggregationcompleted-source-v1 +title: AccountaggregationcompletedSourceV1 +pagination_label: AccountaggregationcompletedSourceV1 +sidebar_label: AccountaggregationcompletedSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountaggregationcompletedSourceV1', 'v1AccountaggregationcompletedSourceV1'] +slug: /tools/sdk/typescript/triggers/models/accountaggregationcompleted-source-v1 +tags: ['SDK', 'Software Development Kit', 'AccountaggregationcompletedSourceV1', 'v1AccountaggregationcompletedSourceV1'] +--- + +# AccountaggregationcompletedSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The DTO type of the source the accounts are being aggregated from. | [default to undefined] +**id** | **string** | The ID of the source the accounts are being aggregated from. | [default to undefined] +**name** | **string** | Display name of the source the accounts are being aggregated from. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountaggregationcompletedStats.md b/sdk-output/triggers/docs/Models/AccountaggregationcompletedStats.md new file mode 100644 index 00000000..92a15a51 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountaggregationcompletedStats.md @@ -0,0 +1,23 @@ +--- +id: v1-accountaggregationcompleted-stats-v1 +title: AccountaggregationcompletedStatsV1 +pagination_label: AccountaggregationcompletedStatsV1 +sidebar_label: AccountaggregationcompletedStatsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountaggregationcompletedStatsV1', 'v1AccountaggregationcompletedStatsV1'] +slug: /tools/sdk/typescript/triggers/models/accountaggregationcompleted-stats-v1 +tags: ['SDK', 'Software Development Kit', 'AccountaggregationcompletedStatsV1', 'v1AccountaggregationcompletedStatsV1'] +--- + +# AccountaggregationcompletedStatsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **number** | The number of accounts which were scanned / iterated over. | [default to undefined] +**unchanged** | **number** | The number of accounts which existed before, but had no changes. | [default to undefined] +**changed** | **number** | The number of accounts which existed before, but had changes. | [default to undefined] +**added** | **number** | The number of accounts which are new - have not existed before. | [default to undefined] +**removed** | **number** | The number accounts which existed before, but no longer exist (thus getting removed). | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountattributeschanged.md b/sdk-output/triggers/docs/Models/Accountattributeschanged.md new file mode 100644 index 00000000..9550b4d0 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountattributeschanged.md @@ -0,0 +1,22 @@ +--- +id: v1-accountattributeschanged-v1 +title: AccountattributeschangedV1 +pagination_label: AccountattributeschangedV1 +sidebar_label: AccountattributeschangedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedV1', 'v1AccountattributeschangedV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedV1', 'v1AccountattributeschangedV1'] +--- + +# AccountattributeschangedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **AccountattributeschangedIdentityV1** | | [default to undefined] +**source** | **AccountattributeschangedSourceV1** | | [default to undefined] +**account** | **AccountattributeschangedAccountV1** | | [default to undefined] +**changes** | **Array<AccountattributeschangedChangesInnerV1>** | A list of attributes that changed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedAccount.md b/sdk-output/triggers/docs/Models/AccountattributeschangedAccount.md new file mode 100644 index 00000000..9e3d1021 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedAccount.md @@ -0,0 +1,23 @@ +--- +id: v1-accountattributeschanged-account-v1 +title: AccountattributeschangedAccountV1 +pagination_label: AccountattributeschangedAccountV1 +sidebar_label: AccountattributeschangedAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedAccountV1', 'v1AccountattributeschangedAccountV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-account-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedAccountV1', 'v1AccountattributeschangedAccountV1'] +--- + +# AccountattributeschangedAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | SailPoint generated unique identifier. | [default to undefined] +**uuid** | **string** | The source\'s unique identifier for the account. UUID is generated by the source system. | [default to undefined] +**name** | **string** | Name of the account. | [default to undefined] +**nativeIdentity** | **string** | Unique ID of the account on the source. | [default to undefined] +**type** | **string** | The type of the account | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInner.md b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInner.md new file mode 100644 index 00000000..df1d02ce --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accountattributeschanged-changes-inner-v1 +title: AccountattributeschangedChangesInnerV1 +pagination_label: AccountattributeschangedChangesInnerV1 +sidebar_label: AccountattributeschangedChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedChangesInnerV1', 'v1AccountattributeschangedChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedChangesInnerV1', 'v1AccountattributeschangedChangesInnerV1'] +--- + +# AccountattributeschangedChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **string** | The name of the attribute. | [default to undefined] +**oldValue** | **AccountattributeschangedChangesInnerOldValueV1** | | [default to undefined] +**newValue** | **AccountattributeschangedChangesInnerNewValueV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerNewValue.md b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerNewValue.md new file mode 100644 index 00000000..fe49ffcb --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerNewValue.md @@ -0,0 +1,18 @@ +--- +id: v1-accountattributeschanged-changes-inner-new-value-v1 +title: AccountattributeschangedChangesInnerNewValueV1 +pagination_label: AccountattributeschangedChangesInnerNewValueV1 +sidebar_label: AccountattributeschangedChangesInnerNewValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedChangesInnerNewValueV1', 'v1AccountattributeschangedChangesInnerNewValueV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-changes-inner-new-value-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedChangesInnerNewValueV1', 'v1AccountattributeschangedChangesInnerNewValueV1'] +--- + +# AccountattributeschangedChangesInnerNewValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerOldValue.md b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerOldValue.md new file mode 100644 index 00000000..20b8ca5d --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedChangesInnerOldValue.md @@ -0,0 +1,18 @@ +--- +id: v1-accountattributeschanged-changes-inner-old-value-v1 +title: AccountattributeschangedChangesInnerOldValueV1 +pagination_label: AccountattributeschangedChangesInnerOldValueV1 +sidebar_label: AccountattributeschangedChangesInnerOldValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedChangesInnerOldValueV1', 'v1AccountattributeschangedChangesInnerOldValueV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-changes-inner-old-value-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedChangesInnerOldValueV1', 'v1AccountattributeschangedChangesInnerOldValueV1'] +--- + +# AccountattributeschangedChangesInnerOldValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedIdentity.md b/sdk-output/triggers/docs/Models/AccountattributeschangedIdentity.md new file mode 100644 index 00000000..f94026ae --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-accountattributeschanged-identity-v1 +title: AccountattributeschangedIdentityV1 +pagination_label: AccountattributeschangedIdentityV1 +sidebar_label: AccountattributeschangedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedIdentityV1', 'v1AccountattributeschangedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedIdentityV1', 'v1AccountattributeschangedIdentityV1'] +--- + +# AccountattributeschangedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of the identity whose account attributes were updated. | [default to undefined] +**id** | **string** | ID of the identity whose account attributes were updated. | [default to undefined] +**name** | **string** | Display name of the identity whose account attributes were updated. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountattributeschangedSource.md b/sdk-output/triggers/docs/Models/AccountattributeschangedSource.md new file mode 100644 index 00000000..1a0ce05a --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountattributeschangedSource.md @@ -0,0 +1,21 @@ +--- +id: v1-accountattributeschanged-source-v1 +title: AccountattributeschangedSourceV1 +pagination_label: AccountattributeschangedSourceV1 +sidebar_label: AccountattributeschangedSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountattributeschangedSourceV1', 'v1AccountattributeschangedSourceV1'] +slug: /tools/sdk/typescript/triggers/models/accountattributeschanged-source-v1 +tags: ['SDK', 'Software Development Kit', 'AccountattributeschangedSourceV1', 'v1AccountattributeschangedSourceV1'] +--- + +# AccountattributeschangedSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the object to which this reference applies | [default to undefined] +**type** | **string** | The type of object that is referenced | [default to undefined] +**name** | **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountcorrelated.md b/sdk-output/triggers/docs/Models/Accountcorrelated.md new file mode 100644 index 00000000..91d4b1c6 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountcorrelated.md @@ -0,0 +1,23 @@ +--- +id: v1-accountcorrelated-v1 +title: AccountcorrelatedV1 +pagination_label: AccountcorrelatedV1 +sidebar_label: AccountcorrelatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcorrelatedV1', 'v1AccountcorrelatedV1'] +slug: /tools/sdk/typescript/triggers/models/accountcorrelated-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcorrelatedV1', 'v1AccountcorrelatedV1'] +--- + +# AccountcorrelatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **AccountcorrelatedIdentityV1** | | [default to undefined] +**source** | **AccountcorrelatedSourceV1** | | [default to undefined] +**account** | **AccountcorrelatedAccountV1** | | [default to undefined] +**attributes** | | The attributes associated with the account. Attributes are unique per source. | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements associated with this account. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountcorrelatedAccount.md b/sdk-output/triggers/docs/Models/AccountcorrelatedAccount.md new file mode 100644 index 00000000..b36a3e3c --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountcorrelatedAccount.md @@ -0,0 +1,23 @@ +--- +id: v1-accountcorrelated-account-v1 +title: AccountcorrelatedAccountV1 +pagination_label: AccountcorrelatedAccountV1 +sidebar_label: AccountcorrelatedAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcorrelatedAccountV1', 'v1AccountcorrelatedAccountV1'] +slug: /tools/sdk/typescript/triggers/models/accountcorrelated-account-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcorrelatedAccountV1', 'v1AccountcorrelatedAccountV1'] +--- + +# AccountcorrelatedAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The correlated account\'s DTO type. | [default to undefined] +**id** | **string** | The correlated account\'s ID. | [default to undefined] +**name** | **string** | The correlated account\'s display name. | [default to undefined] +**nativeIdentity** | **string** | Unique ID of the account on the source. | [default to undefined] +**uuid** | **(optional)** **string** | The source\'s unique identifier for the account. UUID is generated by the source system. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountcorrelatedIdentity.md b/sdk-output/triggers/docs/Models/AccountcorrelatedIdentity.md new file mode 100644 index 00000000..3d3188e8 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountcorrelatedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-accountcorrelated-identity-v1 +title: AccountcorrelatedIdentityV1 +pagination_label: AccountcorrelatedIdentityV1 +sidebar_label: AccountcorrelatedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcorrelatedIdentityV1', 'v1AccountcorrelatedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/accountcorrelated-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcorrelatedIdentityV1', 'v1AccountcorrelatedIdentityV1'] +--- + +# AccountcorrelatedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of the identity the account is correlated with. | [default to undefined] +**id** | **string** | ID of the identity the account is correlated with. | [default to undefined] +**name** | **string** | Display name of the identity the account is correlated with. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountcorrelatedSource.md b/sdk-output/triggers/docs/Models/AccountcorrelatedSource.md new file mode 100644 index 00000000..cadab60f --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountcorrelatedSource.md @@ -0,0 +1,21 @@ +--- +id: v1-accountcorrelated-source-v1 +title: AccountcorrelatedSourceV1 +pagination_label: AccountcorrelatedSourceV1 +sidebar_label: AccountcorrelatedSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcorrelatedSourceV1', 'v1AccountcorrelatedSourceV1'] +slug: /tools/sdk/typescript/triggers/models/accountcorrelated-source-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcorrelatedSourceV1', 'v1AccountcorrelatedSourceV1'] +--- + +# AccountcorrelatedSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The DTO type of the source the accounts are being correlated from. | [default to undefined] +**id** | **string** | The ID of the source the accounts are being correlated from. | [default to undefined] +**name** | **string** | Display name of the source the accounts are being correlated from. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountcreated.md b/sdk-output/triggers/docs/Models/Accountcreated.md new file mode 100644 index 00000000..f2558898 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountcreated.md @@ -0,0 +1,22 @@ +--- +id: v1-accountcreated-v1 +title: AccountcreatedV1 +pagination_label: AccountcreatedV1 +sidebar_label: AccountcreatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcreatedV1', 'v1AccountcreatedV1'] +slug: /tools/sdk/typescript/triggers/models/accountcreated-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcreatedV1', 'v1AccountcreatedV1'] +--- + +# AccountcreatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event** | **AccountcreatedEventV1** | | [default to undefined] +**source** | **AccountsourcereferenceV1** | | [default to undefined] +**account** | **Accountv2V1** | | [default to undefined] +**identity** | **Identityreference2V1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountcreatedEvent.md b/sdk-output/triggers/docs/Models/AccountcreatedEvent.md new file mode 100644 index 00000000..efc2ecb4 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountcreatedEvent.md @@ -0,0 +1,20 @@ +--- +id: v1-accountcreated-event-v1 +title: AccountcreatedEventV1 +pagination_label: AccountcreatedEventV1 +sidebar_label: AccountcreatedEventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountcreatedEventV1', 'v1AccountcreatedEventV1'] +slug: /tools/sdk/typescript/triggers/models/accountcreated-event-v1 +tags: ['SDK', 'Software Development Kit', 'AccountcreatedEventV1', 'v1AccountcreatedEventV1'] +--- + +# AccountcreatedEventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of event. | [default to undefined] +**cause** | **string** | The cause of the event. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountdeleted.md b/sdk-output/triggers/docs/Models/Accountdeleted.md new file mode 100644 index 00000000..ec8ae11a --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountdeleted.md @@ -0,0 +1,22 @@ +--- +id: v1-accountdeleted-v1 +title: AccountdeletedV1 +pagination_label: AccountdeletedV1 +sidebar_label: AccountdeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountdeletedV1', 'v1AccountdeletedV1'] +slug: /tools/sdk/typescript/triggers/models/accountdeleted-v1 +tags: ['SDK', 'Software Development Kit', 'AccountdeletedV1', 'v1AccountdeletedV1'] +--- + +# AccountdeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event** | **AccountdeletedEventV1** | | [default to undefined] +**source** | **AccountsourcereferenceV1** | | [default to undefined] +**account** | **Accountv2V1** | | [default to undefined] +**identity** | **Identityreference2V1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountdeletedEvent.md b/sdk-output/triggers/docs/Models/AccountdeletedEvent.md new file mode 100644 index 00000000..96ace80c --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountdeletedEvent.md @@ -0,0 +1,20 @@ +--- +id: v1-accountdeleted-event-v1 +title: AccountdeletedEventV1 +pagination_label: AccountdeletedEventV1 +sidebar_label: AccountdeletedEventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountdeletedEventV1', 'v1AccountdeletedEventV1'] +slug: /tools/sdk/typescript/triggers/models/accountdeleted-event-v1 +tags: ['SDK', 'Software Development Kit', 'AccountdeletedEventV1', 'v1AccountdeletedEventV1'] +--- + +# AccountdeletedEventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of event. | [default to undefined] +**cause** | **string** | The cause of the event. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountscollectedforaggregation.md b/sdk-output/triggers/docs/Models/Accountscollectedforaggregation.md new file mode 100644 index 00000000..147e5a2b --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountscollectedforaggregation.md @@ -0,0 +1,25 @@ +--- +id: v1-accountscollectedforaggregation-v1 +title: AccountscollectedforaggregationV1 +pagination_label: AccountscollectedforaggregationV1 +sidebar_label: AccountscollectedforaggregationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountscollectedforaggregationV1', 'v1AccountscollectedforaggregationV1'] +slug: /tools/sdk/typescript/triggers/models/accountscollectedforaggregation-v1 +tags: ['SDK', 'Software Development Kit', 'AccountscollectedforaggregationV1', 'v1AccountscollectedforaggregationV1'] +--- + +# AccountscollectedforaggregationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **AccountscollectedforaggregationSourceV1** | | [default to undefined] +**status** | **string** | The overall status of the collection. | [default to undefined] +**started** | **string** | The date and time when the account collection started. | [default to undefined] +**completed** | **string** | The date and time when the account collection finished. | [default to undefined] +**errors** | **Array<string>** | A list of errors that occurred during the collection. | [default to undefined] +**warnings** | **Array<string>** | A list of warnings that occurred during the collection. | [default to undefined] +**stats** | **AccountscollectedforaggregationStatsV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountscollectedforaggregationSource.md b/sdk-output/triggers/docs/Models/AccountscollectedforaggregationSource.md new file mode 100644 index 00000000..b7f6a4c7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountscollectedforaggregationSource.md @@ -0,0 +1,21 @@ +--- +id: v1-accountscollectedforaggregation-source-v1 +title: AccountscollectedforaggregationSourceV1 +pagination_label: AccountscollectedforaggregationSourceV1 +sidebar_label: AccountscollectedforaggregationSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountscollectedforaggregationSourceV1', 'v1AccountscollectedforaggregationSourceV1'] +slug: /tools/sdk/typescript/triggers/models/accountscollectedforaggregation-source-v1 +tags: ['SDK', 'Software Development Kit', 'AccountscollectedforaggregationSourceV1', 'v1AccountscollectedforaggregationSourceV1'] +--- + +# AccountscollectedforaggregationSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the object to which this reference applies | [default to undefined] +**type** | **string** | The type of object that is referenced | [default to undefined] +**name** | **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountscollectedforaggregationStats.md b/sdk-output/triggers/docs/Models/AccountscollectedforaggregationStats.md new file mode 100644 index 00000000..b2146ac9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountscollectedforaggregationStats.md @@ -0,0 +1,23 @@ +--- +id: v1-accountscollectedforaggregation-stats-v1 +title: AccountscollectedforaggregationStatsV1 +pagination_label: AccountscollectedforaggregationStatsV1 +sidebar_label: AccountscollectedforaggregationStatsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountscollectedforaggregationStatsV1', 'v1AccountscollectedforaggregationStatsV1'] +slug: /tools/sdk/typescript/triggers/models/accountscollectedforaggregation-stats-v1 +tags: ['SDK', 'Software Development Kit', 'AccountscollectedforaggregationStatsV1', 'v1AccountscollectedforaggregationStatsV1'] +--- + +# AccountscollectedforaggregationStatsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**scanned** | **number** | The number of accounts which were scanned / iterated over. | [default to undefined] +**unchanged** | **number** | The number of accounts which existed before, but had no changes. | [default to undefined] +**changed** | **number** | The number of accounts which existed before, but had changes. | [default to undefined] +**added** | **number** | The number of accounts which are new - have not existed before. | [default to undefined] +**removed** | **number** | The number accounts which existed before, but no longer exist (thus getting removed). | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountsourcereference.md b/sdk-output/triggers/docs/Models/Accountsourcereference.md new file mode 100644 index 00000000..b26a6e12 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountsourcereference.md @@ -0,0 +1,23 @@ +--- +id: v1-accountsourcereference-v1 +title: AccountsourcereferenceV1 +pagination_label: AccountsourcereferenceV1 +sidebar_label: AccountsourcereferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsourcereferenceV1', 'v1AccountsourcereferenceV1'] +slug: /tools/sdk/typescript/triggers/models/accountsourcereference-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsourcereferenceV1', 'v1AccountsourcereferenceV1'] +--- + +# AccountsourcereferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the source. | [default to undefined] +**name** | **string** | The name of the source. | [default to undefined] +**alias** | **string** | The alias of the source. | [default to undefined] +**owner** | **AccountsourcereferenceOwnerV1** | | [default to undefined] +**governanceGroup** | **AccountsourcereferenceGovernanceGroupV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountsourcereferenceGovernanceGroup.md b/sdk-output/triggers/docs/Models/AccountsourcereferenceGovernanceGroup.md new file mode 100644 index 00000000..c2e8e582 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountsourcereferenceGovernanceGroup.md @@ -0,0 +1,20 @@ +--- +id: v1-accountsourcereference-governance-group-v1 +title: AccountsourcereferenceGovernanceGroupV1 +pagination_label: AccountsourcereferenceGovernanceGroupV1 +sidebar_label: AccountsourcereferenceGovernanceGroupV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsourcereferenceGovernanceGroupV1', 'v1AccountsourcereferenceGovernanceGroupV1'] +slug: /tools/sdk/typescript/triggers/models/accountsourcereference-governance-group-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsourcereferenceGovernanceGroupV1', 'v1AccountsourcereferenceGovernanceGroupV1'] +--- + +# AccountsourcereferenceGovernanceGroupV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the governance group. | [default to undefined] +**name** | **string** | Name of the governance group. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountsourcereferenceOwner.md b/sdk-output/triggers/docs/Models/AccountsourcereferenceOwner.md new file mode 100644 index 00000000..925a5946 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountsourcereferenceOwner.md @@ -0,0 +1,20 @@ +--- +id: v1-accountsourcereference-owner-v1 +title: AccountsourcereferenceOwnerV1 +pagination_label: AccountsourcereferenceOwnerV1 +sidebar_label: AccountsourcereferenceOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountsourcereferenceOwnerV1', 'v1AccountsourcereferenceOwnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountsourcereference-owner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountsourcereferenceOwnerV1', 'v1AccountsourcereferenceOwnerV1'] +--- + +# AccountsourcereferenceOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the source owner. | [default to undefined] +**name** | **string** | Name of the source owner. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountuncorrelated.md b/sdk-output/triggers/docs/Models/Accountuncorrelated.md new file mode 100644 index 00000000..e9f5ba9e --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountuncorrelated.md @@ -0,0 +1,22 @@ +--- +id: v1-accountuncorrelated-v1 +title: AccountuncorrelatedV1 +pagination_label: AccountuncorrelatedV1 +sidebar_label: AccountuncorrelatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountuncorrelatedV1', 'v1AccountuncorrelatedV1'] +slug: /tools/sdk/typescript/triggers/models/accountuncorrelated-v1 +tags: ['SDK', 'Software Development Kit', 'AccountuncorrelatedV1', 'v1AccountuncorrelatedV1'] +--- + +# AccountuncorrelatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **AccountuncorrelatedIdentityV1** | | [default to undefined] +**source** | **AccountuncorrelatedSourceV1** | | [default to undefined] +**account** | **AccountuncorrelatedAccountV1** | | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements associated with this account. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountuncorrelatedAccount.md b/sdk-output/triggers/docs/Models/AccountuncorrelatedAccount.md new file mode 100644 index 00000000..6002b2ab --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountuncorrelatedAccount.md @@ -0,0 +1,23 @@ +--- +id: v1-accountuncorrelated-account-v1 +title: AccountuncorrelatedAccountV1 +pagination_label: AccountuncorrelatedAccountV1 +sidebar_label: AccountuncorrelatedAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountuncorrelatedAccountV1', 'v1AccountuncorrelatedAccountV1'] +slug: /tools/sdk/typescript/triggers/models/accountuncorrelated-account-v1 +tags: ['SDK', 'Software Development Kit', 'AccountuncorrelatedAccountV1', 'v1AccountuncorrelatedAccountV1'] +--- + +# AccountuncorrelatedAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Uncorrelated account\'s DTO type. | [default to undefined] +**id** | **string** | Uncorrelated account\'s ID. | [default to undefined] +**name** | **string** | Uncorrelated account\'s display name. | [default to undefined] +**nativeIdentity** | **string** | Unique ID of the account on the source. | [default to undefined] +**uuid** | **(optional)** **string** | The source\'s unique identifier for the account. UUID is generated by the source system. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountuncorrelatedIdentity.md b/sdk-output/triggers/docs/Models/AccountuncorrelatedIdentity.md new file mode 100644 index 00000000..963c054c --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountuncorrelatedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-accountuncorrelated-identity-v1 +title: AccountuncorrelatedIdentityV1 +pagination_label: AccountuncorrelatedIdentityV1 +sidebar_label: AccountuncorrelatedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountuncorrelatedIdentityV1', 'v1AccountuncorrelatedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/accountuncorrelated-identity-v1 +tags: ['SDK', 'Software Development Kit', 'AccountuncorrelatedIdentityV1', 'v1AccountuncorrelatedIdentityV1'] +--- + +# AccountuncorrelatedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of the identity the account is uncorrelated with. | [default to undefined] +**id** | **string** | ID of the identity the account is uncorrelated with. | [default to undefined] +**name** | **string** | Display name of the identity the account is uncorrelated with. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountuncorrelatedSource.md b/sdk-output/triggers/docs/Models/AccountuncorrelatedSource.md new file mode 100644 index 00000000..97aadd8a --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountuncorrelatedSource.md @@ -0,0 +1,21 @@ +--- +id: v1-accountuncorrelated-source-v1 +title: AccountuncorrelatedSourceV1 +pagination_label: AccountuncorrelatedSourceV1 +sidebar_label: AccountuncorrelatedSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountuncorrelatedSourceV1', 'v1AccountuncorrelatedSourceV1'] +slug: /tools/sdk/typescript/triggers/models/accountuncorrelated-source-v1 +tags: ['SDK', 'Software Development Kit', 'AccountuncorrelatedSourceV1', 'v1AccountuncorrelatedSourceV1'] +--- + +# AccountuncorrelatedSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The DTO type of the source the accounts are uncorrelated from. | [default to undefined] +**id** | **string** | The ID of the source the accounts are uncorrelated from. | [default to undefined] +**name** | **string** | Display name of the source the accounts are uncorrelated from. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Accountupdated.md b/sdk-output/triggers/docs/Models/Accountupdated.md new file mode 100644 index 00000000..245477c3 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountupdated.md @@ -0,0 +1,26 @@ +--- +id: v1-accountupdated-v1 +title: AccountupdatedV1 +pagination_label: AccountupdatedV1 +sidebar_label: AccountupdatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedV1', 'v1AccountupdatedV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedV1', 'v1AccountupdatedV1'] +--- + +# AccountupdatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event** | **AccountupdatedEventV1** | | [default to undefined] +**source** | **AccountsourcereferenceV1** | | [default to undefined] +**account** | **Accountv2V1** | | [default to undefined] +**identity** | **Identityreference2V1** | | [default to undefined] +**accountChangeTypes** | **Array<string>** | The types of changes that occurred to the account. | [default to undefined] +**singleValueAttributeChanges** | **Array<AccountupdatedSingleValueAttributeChangesInnerV1>** | Details about the single-value attribute changes that occurred to the account. | [default to undefined] +**multiValueAttributeChanges** | **Array<AccountupdatedMultiValueAttributeChangesInnerV1>** | Details about the multi-value attribute changes that occurred to the account. | [default to undefined] +**entitlementChanges** | **Array<AccountupdatedEntitlementChangesInnerV1>** | Details about the entitlement changes that occurred to the account. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInner.md b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInner.md new file mode 100644 index 00000000..60370afa --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accountupdated-entitlement-changes-inner-v1 +title: AccountupdatedEntitlementChangesInnerV1 +pagination_label: AccountupdatedEntitlementChangesInnerV1 +sidebar_label: AccountupdatedEntitlementChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedEntitlementChangesInnerV1', 'v1AccountupdatedEntitlementChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-entitlement-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedEntitlementChangesInnerV1', 'v1AccountupdatedEntitlementChangesInnerV1'] +--- + +# AccountupdatedEntitlementChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **string** | The name of the entitlement attribute that was changed. | [default to undefined] +**added** | **Array<AccountupdatedEntitlementChangesInnerAddedInnerV1>** | The entitlements that were added. | [default to undefined] +**removed** | **Array<AccountupdatedEntitlementChangesInnerAddedInnerV1>** | The entitlements that were removed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInner.md b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInner.md new file mode 100644 index 00000000..2c7a51ef --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInner.md @@ -0,0 +1,22 @@ +--- +id: v1-accountupdated-entitlement-changes-inner-added-inner-v1 +title: AccountupdatedEntitlementChangesInnerAddedInnerV1 +pagination_label: AccountupdatedEntitlementChangesInnerAddedInnerV1 +sidebar_label: AccountupdatedEntitlementChangesInnerAddedInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedEntitlementChangesInnerAddedInnerV1', 'v1AccountupdatedEntitlementChangesInnerAddedInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-entitlement-changes-inner-added-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedEntitlementChangesInnerAddedInnerV1', 'v1AccountupdatedEntitlementChangesInnerAddedInnerV1'] +--- + +# AccountupdatedEntitlementChangesInnerAddedInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the entitlement. | [default to undefined] +**name** | **(optional)** **string** | The name of the entitlement. | [default to undefined] +**owner** | **(optional)** **AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1** | | [default to undefined] +**value** | **(optional)** **string** | The value of the entitlement. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInnerOwner.md b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInnerOwner.md new file mode 100644 index 00000000..b802e84c --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedEntitlementChangesInnerAddedInnerOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-accountupdated-entitlement-changes-inner-added-inner-owner-v1 +title: AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 +pagination_label: AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 +sidebar_label: AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1', 'v1AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-entitlement-changes-inner-added-inner-owner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1', 'v1AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1'] +--- + +# AccountupdatedEntitlementChangesInnerAddedInnerOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The unique identifier of the owner. | [default to undefined] +**name** | **(optional)** **string** | The name of the owner. | [default to undefined] +**type** | **(optional)** **string** | The type of the owner. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedEvent.md b/sdk-output/triggers/docs/Models/AccountupdatedEvent.md new file mode 100644 index 00000000..8ef0f54f --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedEvent.md @@ -0,0 +1,20 @@ +--- +id: v1-accountupdated-event-v1 +title: AccountupdatedEventV1 +pagination_label: AccountupdatedEventV1 +sidebar_label: AccountupdatedEventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedEventV1', 'v1AccountupdatedEventV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-event-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedEventV1', 'v1AccountupdatedEventV1'] +--- + +# AccountupdatedEventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The type of event. | [default to undefined] +**cause** | **string** | The cause of the event. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInner.md b/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInner.md new file mode 100644 index 00000000..536f04a2 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accountupdated-multi-value-attribute-changes-inner-v1 +title: AccountupdatedMultiValueAttributeChangesInnerV1 +pagination_label: AccountupdatedMultiValueAttributeChangesInnerV1 +sidebar_label: AccountupdatedMultiValueAttributeChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedMultiValueAttributeChangesInnerV1', 'v1AccountupdatedMultiValueAttributeChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-multi-value-attribute-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedMultiValueAttributeChangesInnerV1', 'v1AccountupdatedMultiValueAttributeChangesInnerV1'] +--- + +# AccountupdatedMultiValueAttributeChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the attribute that was changed. | [default to undefined] +**addedValues** | **Array<AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1>** | The values that were added to the attribute. | [default to undefined] +**removedValues** | **Array<AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1>** | The values that were removed from the attribute. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInnerAddedValuesInner.md b/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInnerAddedValuesInner.md new file mode 100644 index 00000000..bfd01c7b --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedMultiValueAttributeChangesInnerAddedValuesInner.md @@ -0,0 +1,18 @@ +--- +id: v1-accountupdated-multi-value-attribute-changes-inner-added-values-inner-v1 +title: AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 +pagination_label: AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 +sidebar_label: AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1', 'v1AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-multi-value-attribute-changes-inner-added-values-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1', 'v1AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1'] +--- + +# AccountupdatedMultiValueAttributeChangesInnerAddedValuesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInner.md b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInner.md new file mode 100644 index 00000000..ab5fa54d --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-accountupdated-single-value-attribute-changes-inner-v1 +title: AccountupdatedSingleValueAttributeChangesInnerV1 +pagination_label: AccountupdatedSingleValueAttributeChangesInnerV1 +sidebar_label: AccountupdatedSingleValueAttributeChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedSingleValueAttributeChangesInnerV1', 'v1AccountupdatedSingleValueAttributeChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-single-value-attribute-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedSingleValueAttributeChangesInnerV1', 'v1AccountupdatedSingleValueAttributeChangesInnerV1'] +--- + +# AccountupdatedSingleValueAttributeChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the attribute that was changed. | [default to undefined] +**oldValue** | **AccountupdatedSingleValueAttributeChangesInnerOldValueV1** | | [default to undefined] +**newValue** | **AccountupdatedSingleValueAttributeChangesInnerNewValueV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerNewValue.md b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerNewValue.md new file mode 100644 index 00000000..dd09a034 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerNewValue.md @@ -0,0 +1,18 @@ +--- +id: v1-accountupdated-single-value-attribute-changes-inner-new-value-v1 +title: AccountupdatedSingleValueAttributeChangesInnerNewValueV1 +pagination_label: AccountupdatedSingleValueAttributeChangesInnerNewValueV1 +sidebar_label: AccountupdatedSingleValueAttributeChangesInnerNewValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedSingleValueAttributeChangesInnerNewValueV1', 'v1AccountupdatedSingleValueAttributeChangesInnerNewValueV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-single-value-attribute-changes-inner-new-value-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedSingleValueAttributeChangesInnerNewValueV1', 'v1AccountupdatedSingleValueAttributeChangesInnerNewValueV1'] +--- + +# AccountupdatedSingleValueAttributeChangesInnerNewValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerOldValue.md b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerOldValue.md new file mode 100644 index 00000000..a8fb77e1 --- /dev/null +++ b/sdk-output/triggers/docs/Models/AccountupdatedSingleValueAttributeChangesInnerOldValue.md @@ -0,0 +1,18 @@ +--- +id: v1-accountupdated-single-value-attribute-changes-inner-old-value-v1 +title: AccountupdatedSingleValueAttributeChangesInnerOldValueV1 +pagination_label: AccountupdatedSingleValueAttributeChangesInnerOldValueV1 +sidebar_label: AccountupdatedSingleValueAttributeChangesInnerOldValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AccountupdatedSingleValueAttributeChangesInnerOldValueV1', 'v1AccountupdatedSingleValueAttributeChangesInnerOldValueV1'] +slug: /tools/sdk/typescript/triggers/models/accountupdated-single-value-attribute-changes-inner-old-value-v1 +tags: ['SDK', 'Software Development Kit', 'AccountupdatedSingleValueAttributeChangesInnerOldValueV1', 'v1AccountupdatedSingleValueAttributeChangesInnerOldValueV1'] +--- + +# AccountupdatedSingleValueAttributeChangesInnerOldValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/Accountv2.md b/sdk-output/triggers/docs/Models/Accountv2.md new file mode 100644 index 00000000..66b361c8 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Accountv2.md @@ -0,0 +1,26 @@ +--- +id: v1-accountv2-v1 +title: Accountv2V1 +pagination_label: Accountv2V1 +sidebar_label: Accountv2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Accountv2V1', 'v1Accountv2V1'] +slug: /tools/sdk/typescript/triggers/models/accountv2-v1 +tags: ['SDK', 'Software Development Kit', 'Accountv2V1', 'v1Accountv2V1'] +--- + +# Accountv2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique identifier of the account. | [default to undefined] +**name** | **string** | The name of the account. | [default to undefined] +**nativeIdentity** | **string** | The unique ID of the account generated by the source system. | [default to undefined] +**uuid** | **string** | The unique ID associated with this account. | [default to undefined] +**correlated** | **boolean** | Indicates if the account is correlated to an identity. | [default to undefined] +**isMachine** | **boolean** | Indicates if the account is a machine account. | [default to undefined] +**origin** | **string** | The origin of the account. | [default to undefined] +**attributes** | | The attributes of the account. The contents of attributes depends on the account schema for the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Basicauthconfig.md b/sdk-output/triggers/docs/Models/Basicauthconfig.md new file mode 100644 index 00000000..28ef8a8b --- /dev/null +++ b/sdk-output/triggers/docs/Models/Basicauthconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-basicauthconfig-v1 +title: BasicauthconfigV1 +pagination_label: BasicauthconfigV1 +sidebar_label: BasicauthconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BasicauthconfigV1', 'v1BasicauthconfigV1'] +slug: /tools/sdk/typescript/triggers/models/basicauthconfig-v1 +tags: ['SDK', 'Software Development Kit', 'BasicauthconfigV1', 'v1BasicauthconfigV1'] +--- + +# BasicauthconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**userName** | **(optional)** **string** | The username to authenticate. | [default to undefined] +**password** | **(optional)** **string** | The password to authenticate. On response, this field is set to null as to not return secrets. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Bearertokenauthconfig.md b/sdk-output/triggers/docs/Models/Bearertokenauthconfig.md new file mode 100644 index 00000000..4029f507 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Bearertokenauthconfig.md @@ -0,0 +1,19 @@ +--- +id: v1-bearertokenauthconfig-v1 +title: BearertokenauthconfigV1 +pagination_label: BearertokenauthconfigV1 +sidebar_label: BearertokenauthconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'BearertokenauthconfigV1', 'v1BearertokenauthconfigV1'] +slug: /tools/sdk/typescript/triggers/models/bearertokenauthconfig-v1 +tags: ['SDK', 'Software Development Kit', 'BearertokenauthconfigV1', 'v1BearertokenauthconfigV1'] +--- + +# BearertokenauthconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bearerToken** | **(optional)** **string** | Bearer token | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Campaignactivated.md b/sdk-output/triggers/docs/Models/Campaignactivated.md new file mode 100644 index 00000000..ed8245eb --- /dev/null +++ b/sdk-output/triggers/docs/Models/Campaignactivated.md @@ -0,0 +1,19 @@ +--- +id: v1-campaignactivated-v1 +title: CampaignactivatedV1 +pagination_label: CampaignactivatedV1 +sidebar_label: CampaignactivatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignactivatedV1', 'v1CampaignactivatedV1'] +slug: /tools/sdk/typescript/triggers/models/campaignactivated-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignactivatedV1', 'v1CampaignactivatedV1'] +--- + +# CampaignactivatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | **CampaignactivatedCampaignV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CampaignactivatedCampaign.md b/sdk-output/triggers/docs/Models/CampaignactivatedCampaign.md new file mode 100644 index 00000000..0f2d0d3d --- /dev/null +++ b/sdk-output/triggers/docs/Models/CampaignactivatedCampaign.md @@ -0,0 +1,27 @@ +--- +id: v1-campaignactivated-campaign-v1 +title: CampaignactivatedCampaignV1 +pagination_label: CampaignactivatedCampaignV1 +sidebar_label: CampaignactivatedCampaignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignactivatedCampaignV1', 'v1CampaignactivatedCampaignV1'] +slug: /tools/sdk/typescript/triggers/models/campaignactivated-campaign-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignactivatedCampaignV1', 'v1CampaignactivatedCampaignV1'] +--- + +# CampaignactivatedCampaignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID for the campaign. | [default to undefined] +**name** | **string** | The human friendly name of the campaign. | [default to undefined] +**description** | **string** | Extended description of the campaign. | [default to undefined] +**created** | **string** | The date and time the campaign was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time the campaign was last modified. | [default to undefined] +**deadline** | **string** | The date and time the campaign is due. | [default to undefined] +**type** | **string** | The type of campaign. | [default to undefined] +**campaignOwner** | **CampaignactivatedCampaignCampaignOwnerV1** | | [default to undefined] +**status** | **string** | The current status of the campaign. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CampaignactivatedCampaignCampaignOwner.md b/sdk-output/triggers/docs/Models/CampaignactivatedCampaignCampaignOwner.md new file mode 100644 index 00000000..8fa2f8f9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/CampaignactivatedCampaignCampaignOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-campaignactivated-campaign-campaign-owner-v1 +title: CampaignactivatedCampaignCampaignOwnerV1 +pagination_label: CampaignactivatedCampaignCampaignOwnerV1 +sidebar_label: CampaignactivatedCampaignCampaignOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignactivatedCampaignCampaignOwnerV1', 'v1CampaignactivatedCampaignCampaignOwnerV1'] +slug: /tools/sdk/typescript/triggers/models/campaignactivated-campaign-campaign-owner-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignactivatedCampaignCampaignOwnerV1', 'v1CampaignactivatedCampaignCampaignOwnerV1'] +--- + +# CampaignactivatedCampaignCampaignOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the identity. | [default to undefined] +**displayName** | **string** | The human friendly name of the identity. | [default to undefined] +**email** | **string** | The primary email address of the identity. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Campaignended.md b/sdk-output/triggers/docs/Models/Campaignended.md new file mode 100644 index 00000000..86559d62 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Campaignended.md @@ -0,0 +1,19 @@ +--- +id: v1-campaignended-v1 +title: CampaignendedV1 +pagination_label: CampaignendedV1 +sidebar_label: CampaignendedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignendedV1', 'v1CampaignendedV1'] +slug: /tools/sdk/typescript/triggers/models/campaignended-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignendedV1', 'v1CampaignendedV1'] +--- + +# CampaignendedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | **CampaignendedCampaignV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CampaignendedCampaign.md b/sdk-output/triggers/docs/Models/CampaignendedCampaign.md new file mode 100644 index 00000000..ecd6ac00 --- /dev/null +++ b/sdk-output/triggers/docs/Models/CampaignendedCampaign.md @@ -0,0 +1,27 @@ +--- +id: v1-campaignended-campaign-v1 +title: CampaignendedCampaignV1 +pagination_label: CampaignendedCampaignV1 +sidebar_label: CampaignendedCampaignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignendedCampaignV1', 'v1CampaignendedCampaignV1'] +slug: /tools/sdk/typescript/triggers/models/campaignended-campaign-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignendedCampaignV1', 'v1CampaignendedCampaignV1'] +--- + +# CampaignendedCampaignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID for the campaign. | [default to undefined] +**name** | **string** | The human friendly name of the campaign. | [default to undefined] +**description** | **string** | Extended description of the campaign. | [default to undefined] +**created** | **string** | The date and time the campaign was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time the campaign was last modified. | [default to undefined] +**deadline** | **string** | The date and time the campaign is due. | [default to undefined] +**type** | **string** | The type of campaign. | [default to undefined] +**campaignOwner** | **CampaignactivatedCampaignCampaignOwnerV1** | | [default to undefined] +**status** | **string** | The current status of the campaign. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Campaigngenerated.md b/sdk-output/triggers/docs/Models/Campaigngenerated.md new file mode 100644 index 00000000..f0d98d30 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Campaigngenerated.md @@ -0,0 +1,19 @@ +--- +id: v1-campaigngenerated-v1 +title: CampaigngeneratedV1 +pagination_label: CampaigngeneratedV1 +sidebar_label: CampaigngeneratedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigngeneratedV1', 'v1CampaigngeneratedV1'] +slug: /tools/sdk/typescript/triggers/models/campaigngenerated-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigngeneratedV1', 'v1CampaigngeneratedV1'] +--- + +# CampaigngeneratedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaign** | **CampaigngeneratedCampaignV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CampaigngeneratedCampaign.md b/sdk-output/triggers/docs/Models/CampaigngeneratedCampaign.md new file mode 100644 index 00000000..a8d7860e --- /dev/null +++ b/sdk-output/triggers/docs/Models/CampaigngeneratedCampaign.md @@ -0,0 +1,27 @@ +--- +id: v1-campaigngenerated-campaign-v1 +title: CampaigngeneratedCampaignV1 +pagination_label: CampaigngeneratedCampaignV1 +sidebar_label: CampaigngeneratedCampaignV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigngeneratedCampaignV1', 'v1CampaigngeneratedCampaignV1'] +slug: /tools/sdk/typescript/triggers/models/campaigngenerated-campaign-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigngeneratedCampaignV1', 'v1CampaigngeneratedCampaignV1'] +--- + +# CampaigngeneratedCampaignV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the campaign. | [default to undefined] +**name** | **string** | Human friendly name of the campaign. | [default to undefined] +**description** | **string** | Extended description of the campaign. | [default to undefined] +**created** | **string** | The date and time the campaign was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time the campaign was last modified. | [default to undefined] +**deadline** | **(optional)** **string** | The date and time when the campaign must be finished by. | [default to undefined] +**type** | **string** | The type of campaign that was generated. | [default to undefined] +**campaignOwner** | **CampaigngeneratedCampaignCampaignOwnerV1** | | [default to undefined] +**status** | **string** | The current status of the campaign. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CampaigngeneratedCampaignCampaignOwner.md b/sdk-output/triggers/docs/Models/CampaigngeneratedCampaignCampaignOwner.md new file mode 100644 index 00000000..ba360c1d --- /dev/null +++ b/sdk-output/triggers/docs/Models/CampaigngeneratedCampaignCampaignOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-campaigngenerated-campaign-campaign-owner-v1 +title: CampaigngeneratedCampaignCampaignOwnerV1 +pagination_label: CampaigngeneratedCampaignCampaignOwnerV1 +sidebar_label: CampaigngeneratedCampaignCampaignOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaigngeneratedCampaignCampaignOwnerV1', 'v1CampaigngeneratedCampaignCampaignOwnerV1'] +slug: /tools/sdk/typescript/triggers/models/campaigngenerated-campaign-campaign-owner-v1 +tags: ['SDK', 'Software Development Kit', 'CampaigngeneratedCampaignCampaignOwnerV1', 'v1CampaigngeneratedCampaignCampaignOwnerV1'] +--- + +# CampaigngeneratedCampaignCampaignOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the identity. | [default to undefined] +**displayName** | **string** | The display name of the identity. | [default to undefined] +**email** | **string** | The primary email address of the identity. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Campaignreference.md b/sdk-output/triggers/docs/Models/Campaignreference.md new file mode 100644 index 00000000..a5843dfd --- /dev/null +++ b/sdk-output/triggers/docs/Models/Campaignreference.md @@ -0,0 +1,25 @@ +--- +id: v1-campaignreference-v1 +title: CampaignreferenceV1 +pagination_label: CampaignreferenceV1 +sidebar_label: CampaignreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +slug: /tools/sdk/typescript/triggers/models/campaignreference-v1 +tags: ['SDK', 'Software Development Kit', 'CampaignreferenceV1', 'v1CampaignreferenceV1'] +--- + +# CampaignreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the campaign. | [default to undefined] +**name** | **string** | The name of the campaign. | [default to undefined] +**type** | **string** | The type of object that is being referenced. | [default to undefined] +**campaignType** | **string** | The type of the campaign. | [default to undefined] +**description** | **string** | The description of the campaign set by the admin who created it. | [default to undefined] +**correlatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [default to undefined] +**mandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Certificationdto.md b/sdk-output/triggers/docs/Models/Certificationdto.md new file mode 100644 index 00000000..9dc0b889 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Certificationdto.md @@ -0,0 +1,31 @@ +--- +id: v1-certificationdto-v1 +title: CertificationdtoV1 +pagination_label: CertificationdtoV1 +sidebar_label: CertificationdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationdtoV1', 'v1CertificationdtoV1'] +slug: /tools/sdk/typescript/triggers/models/certificationdto-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationdtoV1', 'v1CertificationdtoV1'] +--- + +# CertificationdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**campaignRef** | **CampaignreferenceV1** | | [default to undefined] +**phase** | **CertificationphaseV1** | | [default to undefined] +**due** | **string** | The due date of the certification. | [default to undefined] +**signed** | **string** | The date the reviewer signed off on the certification. | [default to undefined] +**reviewer** | **ReviewerV1** | | [default to undefined] +**reassignment** | **(optional)** **ReassignmentV1** | | [default to undefined] +**hasErrors** | **boolean** | Indicates it the certification has any errors. | [default to undefined] +**errorMessage** | **(optional)** **string** | A message indicating what the error is. | [default to undefined] +**completed** | **boolean** | Indicates if all certification decisions have been made. | [default to undefined] +**decisionsMade** | **number** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [default to undefined] +**decisionsTotal** | **number** | The total number of approve/revoke/acknowledge decisions for the certification. | [default to undefined] +**entitiesCompleted** | **number** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [default to undefined] +**entitiesTotal** | **number** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Certificationphase.md b/sdk-output/triggers/docs/Models/Certificationphase.md new file mode 100644 index 00000000..ada32f61 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Certificationphase.md @@ -0,0 +1,23 @@ +--- +id: v1-certificationphase-v1 +title: CertificationphaseV1 +pagination_label: CertificationphaseV1 +sidebar_label: CertificationphaseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationphaseV1', 'v1CertificationphaseV1'] +slug: /tools/sdk/typescript/triggers/models/certificationphase-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationphaseV1', 'v1CertificationphaseV1'] +--- + +# CertificationphaseV1 + +## Enum + + +* `Staged` (value: `'STAGED'`) + +* `Active` (value: `'ACTIVE'`) + +* `Signed` (value: `'SIGNED'`) + + diff --git a/sdk-output/triggers/docs/Models/Certificationreference.md b/sdk-output/triggers/docs/Models/Certificationreference.md new file mode 100644 index 00000000..ebd42edb --- /dev/null +++ b/sdk-output/triggers/docs/Models/Certificationreference.md @@ -0,0 +1,22 @@ +--- +id: v1-certificationreference-v1 +title: CertificationreferenceV1 +pagination_label: CertificationreferenceV1 +sidebar_label: CertificationreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationreferenceV1', 'v1CertificationreferenceV1'] +slug: /tools/sdk/typescript/triggers/models/certificationreference-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationreferenceV1', 'v1CertificationreferenceV1'] +--- + +# CertificationreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the certification. | [default to undefined] +**name** | **(optional)** **string** | The name of the certification. | [default to undefined] +**type** | **(optional)** **string** | | [default to undefined] +**reviewer** | **(optional)** **ReviewerV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Certificationsignedoff.md b/sdk-output/triggers/docs/Models/Certificationsignedoff.md new file mode 100644 index 00000000..5e9ad1d7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Certificationsignedoff.md @@ -0,0 +1,19 @@ +--- +id: v1-certificationsignedoff-v1 +title: CertificationsignedoffV1 +pagination_label: CertificationsignedoffV1 +sidebar_label: CertificationsignedoffV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationsignedoffV1', 'v1CertificationsignedoffV1'] +slug: /tools/sdk/typescript/triggers/models/certificationsignedoff-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationsignedoffV1', 'v1CertificationsignedoffV1'] +--- + +# CertificationsignedoffV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**certification** | **CertificationsignedoffCertificationV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/CertificationsignedoffCertification.md b/sdk-output/triggers/docs/Models/CertificationsignedoffCertification.md new file mode 100644 index 00000000..3dbd0f56 --- /dev/null +++ b/sdk-output/triggers/docs/Models/CertificationsignedoffCertification.md @@ -0,0 +1,35 @@ +--- +id: v1-certificationsignedoff-certification-v1 +title: CertificationsignedoffCertificationV1 +pagination_label: CertificationsignedoffCertificationV1 +sidebar_label: CertificationsignedoffCertificationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CertificationsignedoffCertificationV1', 'v1CertificationsignedoffCertificationV1'] +slug: /tools/sdk/typescript/triggers/models/certificationsignedoff-certification-v1 +tags: ['SDK', 'Software Development Kit', 'CertificationsignedoffCertificationV1', 'v1CertificationsignedoffCertificationV1'] +--- + +# CertificationsignedoffCertificationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique ID of the certification. | [default to undefined] +**name** | **string** | The name of the certification. | [default to undefined] +**created** | **string** | The date and time the certification was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time the certification was last modified. | [default to undefined] +**campaignRef** | **CampaignreferenceV1** | | [default to undefined] +**phase** | **CertificationphaseV1** | | [default to undefined] +**due** | **string** | The due date of the certification. | [default to undefined] +**signed** | **string** | The date the reviewer signed off on the certification. | [default to undefined] +**reviewer** | **ReviewerV1** | | [default to undefined] +**reassignment** | **(optional)** **ReassignmentV1** | | [default to undefined] +**hasErrors** | **boolean** | Indicates it the certification has any errors. | [default to undefined] +**errorMessage** | **(optional)** **string** | A message indicating what the error is. | [default to undefined] +**completed** | **boolean** | Indicates if all certification decisions have been made. | [default to undefined] +**decisionsMade** | **number** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [default to undefined] +**decisionsTotal** | **number** | The total number of approve/revoke/acknowledge decisions for the certification. | [default to undefined] +**entitiesCompleted** | **number** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [default to undefined] +**entitiesTotal** | **number** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Completeinvocation.md b/sdk-output/triggers/docs/Models/Completeinvocation.md new file mode 100644 index 00000000..e634d8ad --- /dev/null +++ b/sdk-output/triggers/docs/Models/Completeinvocation.md @@ -0,0 +1,21 @@ +--- +id: v1-completeinvocation-v1 +title: CompleteinvocationV1 +pagination_label: CompleteinvocationV1 +sidebar_label: CompleteinvocationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompleteinvocationV1', 'v1CompleteinvocationV1'] +slug: /tools/sdk/typescript/triggers/models/completeinvocation-v1 +tags: ['SDK', 'Software Development Kit', 'CompleteinvocationV1', 'v1CompleteinvocationV1'] +--- + +# CompleteinvocationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**secret** | **string** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [default to undefined] +**error** | **(optional)** **string** | The error message to indicate a failed invocation or error if any. | [default to undefined] +**output** | **object** | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Completeinvocationinput.md b/sdk-output/triggers/docs/Models/Completeinvocationinput.md new file mode 100644 index 00000000..5e5c8630 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Completeinvocationinput.md @@ -0,0 +1,20 @@ +--- +id: v1-completeinvocationinput-v1 +title: CompleteinvocationinputV1 +pagination_label: CompleteinvocationinputV1 +sidebar_label: CompleteinvocationinputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CompleteinvocationinputV1', 'v1CompleteinvocationinputV1'] +slug: /tools/sdk/typescript/triggers/models/completeinvocationinput-v1 +tags: ['SDK', 'Software Development Kit', 'CompleteinvocationinputV1', 'v1CompleteinvocationinputV1'] +--- + +# CompleteinvocationinputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**localizedError** | **(optional)** **LocalizedmessageV1** | | [default to undefined] +**output** | **(optional)** **object** | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Errormessagedto.md b/sdk-output/triggers/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..30d2b268 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/triggers/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Errorresponsedto.md b/sdk-output/triggers/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..b2c40eb9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/triggers/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Eventbridgeconfig.md b/sdk-output/triggers/docs/Models/Eventbridgeconfig.md new file mode 100644 index 00000000..3071fe34 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Eventbridgeconfig.md @@ -0,0 +1,20 @@ +--- +id: v1-eventbridgeconfig-v1 +title: EventbridgeconfigV1 +pagination_label: EventbridgeconfigV1 +sidebar_label: EventbridgeconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EventbridgeconfigV1', 'v1EventbridgeconfigV1'] +slug: /tools/sdk/typescript/triggers/models/eventbridgeconfig-v1 +tags: ['SDK', 'Software Development Kit', 'EventbridgeconfigV1', 'v1EventbridgeconfigV1'] +--- + +# EventbridgeconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**awsAccount** | **string** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | [default to undefined] +**awsRegion** | **string** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Httpauthenticationtype.md b/sdk-output/triggers/docs/Models/Httpauthenticationtype.md new file mode 100644 index 00000000..273e928f --- /dev/null +++ b/sdk-output/triggers/docs/Models/Httpauthenticationtype.md @@ -0,0 +1,23 @@ +--- +id: v1-httpauthenticationtype-v1 +title: HttpauthenticationtypeV1 +pagination_label: HttpauthenticationtypeV1 +sidebar_label: HttpauthenticationtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HttpauthenticationtypeV1', 'v1HttpauthenticationtypeV1'] +slug: /tools/sdk/typescript/triggers/models/httpauthenticationtype-v1 +tags: ['SDK', 'Software Development Kit', 'HttpauthenticationtypeV1', 'v1HttpauthenticationtypeV1'] +--- + +# HttpauthenticationtypeV1 + +## Enum + + +* `NoAuth` (value: `'NO_AUTH'`) + +* `BasicAuth` (value: `'BASIC_AUTH'`) + +* `BearerToken` (value: `'BEARER_TOKEN'`) + + diff --git a/sdk-output/triggers/docs/Models/Httpconfig.md b/sdk-output/triggers/docs/Models/Httpconfig.md new file mode 100644 index 00000000..0f3cfc29 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Httpconfig.md @@ -0,0 +1,23 @@ +--- +id: v1-httpconfig-v1 +title: HttpconfigV1 +pagination_label: HttpconfigV1 +sidebar_label: HttpconfigV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HttpconfigV1', 'v1HttpconfigV1'] +slug: /tools/sdk/typescript/triggers/models/httpconfig-v1 +tags: ['SDK', 'Software Development Kit', 'HttpconfigV1', 'v1HttpconfigV1'] +--- + +# HttpconfigV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **string** | URL of the external/custom integration. | [default to undefined] +**httpDispatchMode** | **HttpdispatchmodeV1** | | [default to undefined] +**httpAuthenticationType** | **(optional)** **HttpauthenticationtypeV1** | | [default to undefined] +**basicAuthConfig** | **(optional)** **BasicauthconfigV1** | | [default to undefined] +**bearerTokenAuthConfig** | **(optional)** **BearertokenauthconfigV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Httpdispatchmode.md b/sdk-output/triggers/docs/Models/Httpdispatchmode.md new file mode 100644 index 00000000..f1ff008f --- /dev/null +++ b/sdk-output/triggers/docs/Models/Httpdispatchmode.md @@ -0,0 +1,23 @@ +--- +id: v1-httpdispatchmode-v1 +title: HttpdispatchmodeV1 +pagination_label: HttpdispatchmodeV1 +sidebar_label: HttpdispatchmodeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'HttpdispatchmodeV1', 'v1HttpdispatchmodeV1'] +slug: /tools/sdk/typescript/triggers/models/httpdispatchmode-v1 +tags: ['SDK', 'Software Development Kit', 'HttpdispatchmodeV1', 'v1HttpdispatchmodeV1'] +--- + +# HttpdispatchmodeV1 + +## Enum + + +* `Sync` (value: `'SYNC'`) + +* `Async` (value: `'ASYNC'`) + +* `Dynamic` (value: `'DYNAMIC'`) + + diff --git a/sdk-output/triggers/docs/Models/Identityattributeschanged.md b/sdk-output/triggers/docs/Models/Identityattributeschanged.md new file mode 100644 index 00000000..1268cbfc --- /dev/null +++ b/sdk-output/triggers/docs/Models/Identityattributeschanged.md @@ -0,0 +1,20 @@ +--- +id: v1-identityattributeschanged-v1 +title: IdentityattributeschangedV1 +pagination_label: IdentityattributeschangedV1 +sidebar_label: IdentityattributeschangedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedV1', 'v1IdentityattributeschangedV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedV1', 'v1IdentityattributeschangedV1'] +--- + +# IdentityattributeschangedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **IdentityattributeschangedIdentityV1** | | [default to undefined] +**changes** | **Array<IdentityattributeschangedChangesInnerV1>** | A list of one or more identity attributes that changed on the identity. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInner.md b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInner.md new file mode 100644 index 00000000..72ae59bb --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-identityattributeschanged-changes-inner-v1 +title: IdentityattributeschangedChangesInnerV1 +pagination_label: IdentityattributeschangedChangesInnerV1 +sidebar_label: IdentityattributeschangedChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedChangesInnerV1', 'v1IdentityattributeschangedChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedChangesInnerV1', 'v1IdentityattributeschangedChangesInnerV1'] +--- + +# IdentityattributeschangedChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute** | **string** | The name of the identity attribute that changed. | [default to undefined] +**oldValue** | **(optional)** **IdentityattributeschangedChangesInnerOldValueV1** | | [default to undefined] +**newValue** | **(optional)** **IdentityattributeschangedChangesInnerNewValueV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerNewValue.md b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerNewValue.md new file mode 100644 index 00000000..3fe7b189 --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerNewValue.md @@ -0,0 +1,18 @@ +--- +id: v1-identityattributeschanged-changes-inner-new-value-v1 +title: IdentityattributeschangedChangesInnerNewValueV1 +pagination_label: IdentityattributeschangedChangesInnerNewValueV1 +sidebar_label: IdentityattributeschangedChangesInnerNewValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedChangesInnerNewValueV1', 'v1IdentityattributeschangedChangesInnerNewValueV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-changes-inner-new-value-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedChangesInnerNewValueV1', 'v1IdentityattributeschangedChangesInnerNewValueV1'] +--- + +# IdentityattributeschangedChangesInnerNewValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValue.md b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValue.md new file mode 100644 index 00000000..65658c34 --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValue.md @@ -0,0 +1,18 @@ +--- +id: v1-identityattributeschanged-changes-inner-old-value-v1 +title: IdentityattributeschangedChangesInnerOldValueV1 +pagination_label: IdentityattributeschangedChangesInnerOldValueV1 +sidebar_label: IdentityattributeschangedChangesInnerOldValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedChangesInnerOldValueV1', 'v1IdentityattributeschangedChangesInnerOldValueV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-changes-inner-old-value-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedChangesInnerOldValueV1', 'v1IdentityattributeschangedChangesInnerOldValueV1'] +--- + +# IdentityattributeschangedChangesInnerOldValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValueOneOfValue.md b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 00000000..7f370441 --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentityattributeschangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,18 @@ +--- +id: v1-identityattributeschanged-changes-inner-old-value-one-of-value-v1 +title: IdentityattributeschangedChangesInnerOldValueOneOfValueV1 +pagination_label: IdentityattributeschangedChangesInnerOldValueOneOfValueV1 +sidebar_label: IdentityattributeschangedChangesInnerOldValueOneOfValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedChangesInnerOldValueOneOfValueV1', 'v1IdentityattributeschangedChangesInnerOldValueOneOfValueV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-changes-inner-old-value-one-of-value-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedChangesInnerOldValueOneOfValueV1', 'v1IdentityattributeschangedChangesInnerOldValueOneOfValueV1'] +--- + +# IdentityattributeschangedChangesInnerOldValueOneOfValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/IdentityattributeschangedIdentity.md b/sdk-output/triggers/docs/Models/IdentityattributeschangedIdentity.md new file mode 100644 index 00000000..de5f1a4b --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentityattributeschangedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-identityattributeschanged-identity-v1 +title: IdentityattributeschangedIdentityV1 +pagination_label: IdentityattributeschangedIdentityV1 +sidebar_label: IdentityattributeschangedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentityattributeschangedIdentityV1', 'v1IdentityattributeschangedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/identityattributeschanged-identity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentityattributeschangedIdentityV1', 'v1IdentityattributeschangedIdentityV1'] +--- + +# IdentityattributeschangedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of identity whose attributes changed. | [default to undefined] +**id** | **string** | ID of identity whose attributes changed. | [default to undefined] +**name** | **string** | Display name of identity whose attributes changed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Identitycreated.md b/sdk-output/triggers/docs/Models/Identitycreated.md new file mode 100644 index 00000000..90fbc03d --- /dev/null +++ b/sdk-output/triggers/docs/Models/Identitycreated.md @@ -0,0 +1,20 @@ +--- +id: v1-identitycreated-v1 +title: IdentitycreatedV1 +pagination_label: IdentitycreatedV1 +sidebar_label: IdentitycreatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycreatedV1', 'v1IdentitycreatedV1'] +slug: /tools/sdk/typescript/triggers/models/identitycreated-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycreatedV1', 'v1IdentitycreatedV1'] +--- + +# IdentitycreatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **IdentitycreatedIdentityV1** | | [default to undefined] +**attributes** | | The attributes assigned to the identity. Attributes are determined by the identity profile. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/IdentitycreatedIdentity.md b/sdk-output/triggers/docs/Models/IdentitycreatedIdentity.md new file mode 100644 index 00000000..caffbbc7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentitycreatedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-identitycreated-identity-v1 +title: IdentitycreatedIdentityV1 +pagination_label: IdentitycreatedIdentityV1 +sidebar_label: IdentitycreatedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitycreatedIdentityV1', 'v1IdentitycreatedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/identitycreated-identity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitycreatedIdentityV1', 'v1IdentitycreatedIdentityV1'] +--- + +# IdentitycreatedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Created identity\'s DTO type. | [default to undefined] +**id** | **string** | Created identity ID. | [default to undefined] +**name** | **string** | Created identity\'s display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Identitydeleted.md b/sdk-output/triggers/docs/Models/Identitydeleted.md new file mode 100644 index 00000000..b29a879d --- /dev/null +++ b/sdk-output/triggers/docs/Models/Identitydeleted.md @@ -0,0 +1,20 @@ +--- +id: v1-identitydeleted-v1 +title: IdentitydeletedV1 +pagination_label: IdentitydeletedV1 +sidebar_label: IdentitydeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitydeletedV1', 'v1IdentitydeletedV1'] +slug: /tools/sdk/typescript/triggers/models/identitydeleted-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitydeletedV1', 'v1IdentitydeletedV1'] +--- + +# IdentitydeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **IdentitydeletedIdentityV1** | | [default to undefined] +**attributes** | | The attributes assigned to the identity. Attributes are determined by the identity profile. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/IdentitydeletedIdentity.md b/sdk-output/triggers/docs/Models/IdentitydeletedIdentity.md new file mode 100644 index 00000000..ebb48538 --- /dev/null +++ b/sdk-output/triggers/docs/Models/IdentitydeletedIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-identitydeleted-identity-v1 +title: IdentitydeletedIdentityV1 +pagination_label: IdentitydeletedIdentityV1 +sidebar_label: IdentitydeletedIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'IdentitydeletedIdentityV1', 'v1IdentitydeletedIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/identitydeleted-identity-v1 +tags: ['SDK', 'Software Development Kit', 'IdentitydeletedIdentityV1', 'v1IdentitydeletedIdentityV1'] +--- + +# IdentitydeletedIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Deleted identity\'s DTO type. | [default to undefined] +**id** | **string** | Deleted identity ID. | [default to undefined] +**name** | **string** | Deleted identity\'s display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Identityreference2.md b/sdk-output/triggers/docs/Models/Identityreference2.md new file mode 100644 index 00000000..6ce35298 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Identityreference2.md @@ -0,0 +1,22 @@ +--- +id: v1-identityreference2-v1 +title: Identityreference2V1 +pagination_label: Identityreference2V1 +sidebar_label: Identityreference2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Identityreference2V1', 'v1Identityreference2V1'] +slug: /tools/sdk/typescript/triggers/models/identityreference2-v1 +tags: ['SDK', 'Software Development Kit', 'Identityreference2V1', 'v1Identityreference2V1'] +--- + +# Identityreference2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The ID of the identity that is correlated with this account. | [default to undefined] +**name** | **string** | The name of the identity that is correlated with this account. | [default to undefined] +**alias** | **string** | The alias of the identity. | [default to undefined] +**email** | **string** | The email of the identity. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Index.md b/sdk-output/triggers/docs/Models/Index.md new file mode 100644 index 00000000..95af3436 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: triggers-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: triggers-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'triggers', 'models'] +slug: /tools/sdk/typescript/triggers/models +tags: ['SDK', 'Software Development Kit', 'triggers', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/triggers/docs/Models/Invocation.md b/sdk-output/triggers/docs/Models/Invocation.md new file mode 100644 index 00000000..fdc09707 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Invocation.md @@ -0,0 +1,22 @@ +--- +id: v1-invocation-v1 +title: InvocationV1 +pagination_label: InvocationV1 +sidebar_label: InvocationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InvocationV1', 'v1InvocationV1'] +slug: /tools/sdk/typescript/triggers/models/invocation-v1 +tags: ['SDK', 'Software Development Kit', 'InvocationV1', 'v1InvocationV1'] +--- + +# InvocationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Invocation ID | [default to undefined] +**triggerId** | **(optional)** **string** | Trigger ID | [default to undefined] +**secret** | **(optional)** **string** | Unique invocation secret. | [default to undefined] +**contentJson** | **(optional)** **object** | JSON map of invocation metadata. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Invocationstatus.md b/sdk-output/triggers/docs/Models/Invocationstatus.md new file mode 100644 index 00000000..baeba0a4 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Invocationstatus.md @@ -0,0 +1,27 @@ +--- +id: v1-invocationstatus-v1 +title: InvocationstatusV1 +pagination_label: InvocationstatusV1 +sidebar_label: InvocationstatusV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InvocationstatusV1', 'v1InvocationstatusV1'] +slug: /tools/sdk/typescript/triggers/models/invocationstatus-v1 +tags: ['SDK', 'Software Development Kit', 'InvocationstatusV1', 'v1InvocationstatusV1'] +--- + +# InvocationstatusV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Invocation ID | [default to undefined] +**triggerId** | **string** | Trigger ID | [default to undefined] +**subscriptionName** | **string** | Subscription name | [default to undefined] +**subscriptionId** | **string** | Subscription ID | [default to undefined] +**type** | **InvocationstatustypeV1** | | [default to undefined] +**created** | **string** | Invocation created timestamp. ISO-8601 in UTC. | [default to undefined] +**completed** | **(optional)** **string** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [default to undefined] +**startInvocationInput** | **StartinvocationinputV1** | | [default to undefined] +**completeInvocationInput** | **(optional)** **CompleteinvocationinputV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Invocationstatustype.md b/sdk-output/triggers/docs/Models/Invocationstatustype.md new file mode 100644 index 00000000..7c41a4ad --- /dev/null +++ b/sdk-output/triggers/docs/Models/Invocationstatustype.md @@ -0,0 +1,21 @@ +--- +id: v1-invocationstatustype-v1 +title: InvocationstatustypeV1 +pagination_label: InvocationstatustypeV1 +sidebar_label: InvocationstatustypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'InvocationstatustypeV1', 'v1InvocationstatustypeV1'] +slug: /tools/sdk/typescript/triggers/models/invocationstatustype-v1 +tags: ['SDK', 'Software Development Kit', 'InvocationstatustypeV1', 'v1InvocationstatustypeV1'] +--- + +# InvocationstatustypeV1 + +## Enum + + +* `Test` (value: `'TEST'`) + +* `RealTime` (value: `'REAL_TIME'`) + + diff --git a/sdk-output/triggers/docs/Models/ListTriggersV1401Response.md b/sdk-output/triggers/docs/Models/ListTriggersV1401Response.md new file mode 100644 index 00000000..c004c62f --- /dev/null +++ b/sdk-output/triggers/docs/Models/ListTriggersV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-triggers-v1401-response-v1 +title: ListTriggersV1401ResponseV1 +pagination_label: ListTriggersV1401ResponseV1 +sidebar_label: ListTriggersV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTriggersV1401ResponseV1', 'v1ListTriggersV1401ResponseV1'] +slug: /tools/sdk/typescript/triggers/models/list-triggers-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTriggersV1401ResponseV1', 'v1ListTriggersV1401ResponseV1'] +--- + +# ListTriggersV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ListTriggersV1429Response.md b/sdk-output/triggers/docs/Models/ListTriggersV1429Response.md new file mode 100644 index 00000000..e98387e6 --- /dev/null +++ b/sdk-output/triggers/docs/Models/ListTriggersV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-triggers-v1429-response-v1 +title: ListTriggersV1429ResponseV1 +pagination_label: ListTriggersV1429ResponseV1 +sidebar_label: ListTriggersV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListTriggersV1429ResponseV1', 'v1ListTriggersV1429ResponseV1'] +slug: /tools/sdk/typescript/triggers/models/list-triggers-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListTriggersV1429ResponseV1', 'v1ListTriggersV1429ResponseV1'] +--- + +# ListTriggersV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Localeorigin.md b/sdk-output/triggers/docs/Models/Localeorigin.md new file mode 100644 index 00000000..65d676af --- /dev/null +++ b/sdk-output/triggers/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/triggers/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/triggers/docs/Models/Localizedmessage.md b/sdk-output/triggers/docs/Models/Localizedmessage.md new file mode 100644 index 00000000..e89e75e3 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Localizedmessage.md @@ -0,0 +1,20 @@ +--- +id: v1-localizedmessage-v1 +title: LocalizedmessageV1 +pagination_label: LocalizedmessageV1 +sidebar_label: LocalizedmessageV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +slug: /tools/sdk/typescript/triggers/models/localizedmessage-v1 +tags: ['SDK', 'Software Development Kit', 'LocalizedmessageV1', 'v1LocalizedmessageV1'] +--- + +# LocalizedmessageV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **string** | Message locale | [default to undefined] +**message** | **string** | Message text | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Machineidentitycreated.md b/sdk-output/triggers/docs/Models/Machineidentitycreated.md new file mode 100644 index 00000000..3729aae2 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentitycreated.md @@ -0,0 +1,20 @@ +--- +id: v1-machineidentitycreated-v1 +title: MachineidentitycreatedV1 +pagination_label: MachineidentitycreatedV1 +sidebar_label: MachineidentitycreatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentitycreatedV1', 'v1MachineidentitycreatedV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentitycreated-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentitycreatedV1', 'v1MachineidentitycreatedV1'] +--- + +# MachineidentitycreatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eventType** | **string** | Type of the event. | [default to undefined] +**machineIdentity** | **MachineidentitycreatedMachineIdentityV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentitycreatedMachineIdentity.md b/sdk-output/triggers/docs/Models/MachineidentitycreatedMachineIdentity.md new file mode 100644 index 00000000..ef796865 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentitycreatedMachineIdentity.md @@ -0,0 +1,36 @@ +--- +id: v1-machineidentitycreated-machine-identity-v1 +title: MachineidentitycreatedMachineIdentityV1 +pagination_label: MachineidentitycreatedMachineIdentityV1 +sidebar_label: MachineidentitycreatedMachineIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentitycreatedMachineIdentityV1', 'v1MachineidentitycreatedMachineIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentitycreated-machine-identity-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentitycreatedMachineIdentityV1', 'v1MachineidentitycreatedMachineIdentityV1'] +--- + +# MachineidentitycreatedMachineIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier for the machine identity. | [default to undefined] +**name** | **(optional)** **string** | Name of the machine identity. | [default to undefined] +**created** | **string** | Creation timestamp. | [default to undefined] +**modified** | **string** | Last modified timestamp. | [default to undefined] +**businessApplication** | **(optional)** **string** | Associated business application. | [default to undefined] +**description** | **(optional)** **string** | Description of the machine identity. | [default to undefined] +**attributes** | **(optional)** | The attributes assigned to the identity. | [default to undefined] +**subtype** | **string** | Subtype of the machine identity. | [default to undefined] +**owners** | **(optional)** **Array<MachineidentityownerreferenceV1>** | List of owners. | [default to undefined] +**sourceId** | **(optional)** **string** | Source identifier. | [default to undefined] +**uuid** | **(optional)** **string** | UUID of the machine identity. | [default to undefined] +**nativeIdentity** | **(optional)** **string** | Native identity value. | [default to undefined] +**manuallyEdited** | **boolean** | Indicates if manually edited. | [default to false] +**manuallyCreated** | **(optional)** **boolean** | Indicates if manually created. | [default to false] +**datasetId** | **(optional)** **string** | Dataset identifier. | [default to undefined] +**source** | **(optional)** **MachineidentitysourcereferenceV1** | | [default to undefined] +**userEntitlements** | **(optional)** **Array<MachineidentityuserentitlementsV1>** | List of user entitlements. | [default to undefined] +**existsOnSource** | **(optional)** **string** | Existence status on source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Machineidentitydeleted.md b/sdk-output/triggers/docs/Models/Machineidentitydeleted.md new file mode 100644 index 00000000..0087a41c --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentitydeleted.md @@ -0,0 +1,20 @@ +--- +id: v1-machineidentitydeleted-v1 +title: MachineidentitydeletedV1 +pagination_label: MachineidentitydeletedV1 +sidebar_label: MachineidentitydeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentitydeletedV1', 'v1MachineidentitydeletedV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentitydeleted-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentitydeletedV1', 'v1MachineidentitydeletedV1'] +--- + +# MachineidentitydeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eventType** | **string** | Type of the event. | [default to undefined] +**machineIdentity** | **MachineidentitydeletedMachineIdentityV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentitydeletedMachineIdentity.md b/sdk-output/triggers/docs/Models/MachineidentitydeletedMachineIdentity.md new file mode 100644 index 00000000..0d7bda9d --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentitydeletedMachineIdentity.md @@ -0,0 +1,36 @@ +--- +id: v1-machineidentitydeleted-machine-identity-v1 +title: MachineidentitydeletedMachineIdentityV1 +pagination_label: MachineidentitydeletedMachineIdentityV1 +sidebar_label: MachineidentitydeletedMachineIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentitydeletedMachineIdentityV1', 'v1MachineidentitydeletedMachineIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentitydeleted-machine-identity-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentitydeletedMachineIdentityV1', 'v1MachineidentitydeletedMachineIdentityV1'] +--- + +# MachineidentitydeletedMachineIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier for the machine identity. | [default to undefined] +**name** | **(optional)** **string** | Name of the machine identity. | [default to undefined] +**created** | **string** | Creation timestamp. | [default to undefined] +**modified** | **string** | Last modified timestamp. | [default to undefined] +**businessApplication** | **(optional)** **string** | Associated business application. | [default to undefined] +**description** | **(optional)** **string** | Description of the machine identity. | [default to undefined] +**attributes** | **(optional)** | The attributes assigned to the identity. | [default to undefined] +**subtype** | **string** | Subtype of the machine identity. | [default to undefined] +**owners** | **(optional)** **Array<MachineidentityownerreferenceV1>** | List of owners. | [default to undefined] +**sourceId** | **(optional)** **string** | Source identifier. | [default to undefined] +**uuid** | **(optional)** **string** | UUID of the machine identity. | [default to undefined] +**nativeIdentity** | **(optional)** **string** | Native identity value. | [default to undefined] +**manuallyEdited** | **boolean** | Indicates if manually edited. | [default to false] +**manuallyCreated** | **(optional)** **boolean** | Indicates if manually created. | [default to false] +**datasetId** | **(optional)** **string** | Dataset identifier. | [default to undefined] +**source** | **(optional)** **MachineidentitysourcereferenceV1** | | [default to undefined] +**userEntitlements** | **(optional)** **Array<MachineidentityuserentitlementsV1>** | List of user entitlements. | [default to undefined] +**existsOnSource** | **(optional)** **string** | Existence status on source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Machineidentityownerreference.md b/sdk-output/triggers/docs/Models/Machineidentityownerreference.md new file mode 100644 index 00000000..48205298 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentityownerreference.md @@ -0,0 +1,22 @@ +--- +id: v1-machineidentityownerreference-v1 +title: MachineidentityownerreferenceV1 +pagination_label: MachineidentityownerreferenceV1 +sidebar_label: MachineidentityownerreferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityownerreferenceV1', 'v1MachineidentityownerreferenceV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityownerreference-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityownerreferenceV1', 'v1MachineidentityownerreferenceV1'] +--- + +# MachineidentityownerreferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Owner\'s type. | [default to undefined] +**id** | **string** | Owner ID. | [default to undefined] +**name** | **string** | Owner\'s display name. | [default to undefined] +**isPrimary** | **(optional)** **boolean** | Indicates if this owner is the primary owner. | [default to false] + diff --git a/sdk-output/triggers/docs/Models/Machineidentitysourcereference.md b/sdk-output/triggers/docs/Models/Machineidentitysourcereference.md new file mode 100644 index 00000000..efddf163 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentitysourcereference.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentitysourcereference-v1 +title: MachineidentitysourcereferenceV1 +pagination_label: MachineidentitysourcereferenceV1 +sidebar_label: MachineidentitysourcereferenceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentitysourcereferenceV1', 'v1MachineidentitysourcereferenceV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentitysourcereference-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentitysourcereferenceV1', 'v1MachineidentitysourcereferenceV1'] +--- + +# MachineidentitysourcereferenceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Source Type. | [default to undefined] +**id** | **string** | Unique identifier. | [default to undefined] +**name** | **string** | Display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Machineidentityupdated.md b/sdk-output/triggers/docs/Models/Machineidentityupdated.md new file mode 100644 index 00000000..ffa5bc43 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentityupdated.md @@ -0,0 +1,24 @@ +--- +id: v1-machineidentityupdated-v1 +title: MachineidentityupdatedV1 +pagination_label: MachineidentityupdatedV1 +sidebar_label: MachineidentityupdatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedV1', 'v1MachineidentityupdatedV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedV1', 'v1MachineidentityupdatedV1'] +--- + +# MachineidentityupdatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**eventType** | **string** | Type of the event. | [default to undefined] +**machineIdentity** | **MachineidentityupdatedMachineIdentityV1** | | [default to undefined] +**machineIdentityChangeTypes** | **Array<string>** | Types of changes that occurred to the machine identity. | [default to undefined] +**userEntitlementChanges** | **MachineidentityupdatedUserEntitlementChangesV1** | | [default to undefined] +**ownerChanges** | **MachineidentityupdatedOwnerChangesV1** | | [default to undefined] +**singleValueAttributeChanges** | **Array<MachineidentityupdatedSingleValueAttributeChangesInnerV1>** | Details about the single-value attribute changes that occurred. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedMachineIdentity.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedMachineIdentity.md new file mode 100644 index 00000000..87a65980 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedMachineIdentity.md @@ -0,0 +1,36 @@ +--- +id: v1-machineidentityupdated-machine-identity-v1 +title: MachineidentityupdatedMachineIdentityV1 +pagination_label: MachineidentityupdatedMachineIdentityV1 +sidebar_label: MachineidentityupdatedMachineIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedMachineIdentityV1', 'v1MachineidentityupdatedMachineIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-machine-identity-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedMachineIdentityV1', 'v1MachineidentityupdatedMachineIdentityV1'] +--- + +# MachineidentityupdatedMachineIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier for the machine identity. | [default to undefined] +**name** | **(optional)** **string** | Name of the machine identity. | [default to undefined] +**created** | **string** | Creation timestamp. | [default to undefined] +**modified** | **string** | Last modified timestamp. | [default to undefined] +**businessApplication** | **(optional)** **string** | Associated business application. | [default to undefined] +**description** | **(optional)** **string** | Description of the machine identity. | [default to undefined] +**attributes** | **(optional)** | The attributes assigned to the identity. | [default to undefined] +**subtype** | **string** | Subtype of the machine identity. | [default to undefined] +**owners** | **(optional)** **Array<MachineidentityownerreferenceV1>** | List of owners. | [default to undefined] +**sourceId** | **(optional)** **string** | Source identifier. | [default to undefined] +**uuid** | **(optional)** **string** | UUID of the machine identity. | [default to undefined] +**nativeIdentity** | **(optional)** **string** | Native identity value. | [default to undefined] +**manuallyEdited** | **boolean** | Indicates if manually edited. | [default to false] +**manuallyCreated** | **(optional)** **boolean** | Indicates if manually created. | [default to false] +**datasetId** | **(optional)** **string** | Dataset identifier. | [default to undefined] +**source** | **(optional)** **MachineidentitysourcereferenceV1** | | [default to undefined] +**userEntitlements** | **(optional)** **Array<MachineidentityuserentitlementsV1>** | List of user entitlements. | [default to undefined] +**existsOnSource** | **(optional)** **string** | Existence status on source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedOwnerChanges.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedOwnerChanges.md new file mode 100644 index 00000000..d1938946 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedOwnerChanges.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityupdated-owner-changes-v1 +title: MachineidentityupdatedOwnerChangesV1 +pagination_label: MachineidentityupdatedOwnerChangesV1 +sidebar_label: MachineidentityupdatedOwnerChangesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedOwnerChangesV1', 'v1MachineidentityupdatedOwnerChangesV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-owner-changes-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedOwnerChangesV1', 'v1MachineidentityupdatedOwnerChangesV1'] +--- + +# MachineidentityupdatedOwnerChangesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **(optional)** **string** | Name of the attribute that changed. | [default to undefined] +**added** | **(optional)** **Array<MachineidentityownerreferenceV1>** | Owners that were added. | [default to undefined] +**removed** | **(optional)** **Array<MachineidentityownerreferenceV1>** | Owners that were removed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInner.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInner.md new file mode 100644 index 00000000..cd4b5730 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInner.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityupdated-single-value-attribute-changes-inner-v1 +title: MachineidentityupdatedSingleValueAttributeChangesInnerV1 +pagination_label: MachineidentityupdatedSingleValueAttributeChangesInnerV1 +sidebar_label: MachineidentityupdatedSingleValueAttributeChangesInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedSingleValueAttributeChangesInnerV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-single-value-attribute-changes-inner-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedSingleValueAttributeChangesInnerV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerV1'] +--- + +# MachineidentityupdatedSingleValueAttributeChangesInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the attribute that was changed. | [default to undefined] +**oldValue** | **MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1** | | [default to undefined] +**newValue** | **MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerNewValue.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerNewValue.md new file mode 100644 index 00000000..8376ec06 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerNewValue.md @@ -0,0 +1,18 @@ +--- +id: v1-machineidentityupdated-single-value-attribute-changes-inner-new-value-v1 +title: MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 +pagination_label: MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 +sidebar_label: MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-single-value-attribute-changes-inner-new-value-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1'] +--- + +# MachineidentityupdatedSingleValueAttributeChangesInnerNewValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerOldValue.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerOldValue.md new file mode 100644 index 00000000..8859662f --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedSingleValueAttributeChangesInnerOldValue.md @@ -0,0 +1,18 @@ +--- +id: v1-machineidentityupdated-single-value-attribute-changes-inner-old-value-v1 +title: MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 +pagination_label: MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 +sidebar_label: MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-single-value-attribute-changes-inner-old-value-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1', 'v1MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1'] +--- + +# MachineidentityupdatedSingleValueAttributeChangesInnerOldValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/MachineidentityupdatedUserEntitlementChanges.md b/sdk-output/triggers/docs/Models/MachineidentityupdatedUserEntitlementChanges.md new file mode 100644 index 00000000..55bcafb7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/MachineidentityupdatedUserEntitlementChanges.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityupdated-user-entitlement-changes-v1 +title: MachineidentityupdatedUserEntitlementChangesV1 +pagination_label: MachineidentityupdatedUserEntitlementChangesV1 +sidebar_label: MachineidentityupdatedUserEntitlementChangesV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityupdatedUserEntitlementChangesV1', 'v1MachineidentityupdatedUserEntitlementChangesV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityupdated-user-entitlement-changes-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityupdatedUserEntitlementChangesV1', 'v1MachineidentityupdatedUserEntitlementChangesV1'] +--- + +# MachineidentityupdatedUserEntitlementChangesV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **(optional)** **string** | Name of the attribute that changed. | [default to undefined] +**added** | **(optional)** **Array<MachineidentityuserentitlementsV1>** | User entitlements that were added. | [default to undefined] +**removed** | **(optional)** **Array<MachineidentityuserentitlementsV1>** | User entitlements that were removed. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Machineidentityuserentitlements.md b/sdk-output/triggers/docs/Models/Machineidentityuserentitlements.md new file mode 100644 index 00000000..a9620a24 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Machineidentityuserentitlements.md @@ -0,0 +1,21 @@ +--- +id: v1-machineidentityuserentitlements-v1 +title: MachineidentityuserentitlementsV1 +pagination_label: MachineidentityuserentitlementsV1 +sidebar_label: MachineidentityuserentitlementsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'MachineidentityuserentitlementsV1', 'v1MachineidentityuserentitlementsV1'] +slug: /tools/sdk/typescript/triggers/models/machineidentityuserentitlements-v1 +tags: ['SDK', 'Software Development Kit', 'MachineidentityuserentitlementsV1', 'v1MachineidentityuserentitlementsV1'] +--- + +# MachineidentityuserentitlementsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entitlementId** | **string** | Entitlement identifier. | [default to undefined] +**displayName** | **string** | Display name of the entitlement. | [default to undefined] +**source** | **MachineidentitysourcereferenceV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Provisioningcompleted.md b/sdk-output/triggers/docs/Models/Provisioningcompleted.md new file mode 100644 index 00000000..d502cf56 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Provisioningcompleted.md @@ -0,0 +1,26 @@ +--- +id: v1-provisioningcompleted-v1 +title: ProvisioningcompletedV1 +pagination_label: ProvisioningcompletedV1 +sidebar_label: ProvisioningcompletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedV1', 'v1ProvisioningcompletedV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedV1', 'v1ProvisioningcompletedV1'] +--- + +# ProvisioningcompletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [default to undefined] +**sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [default to undefined] +**action** | **(optional)** **string** | Origin of where the provisioning request came from. | [default to undefined] +**errors** | **(optional)** **Array<string>** | A list of any accumulated error messages that occurred during provisioning. | [default to undefined] +**warnings** | **(optional)** **Array<string>** | A list of any accumulated warning messages that occurred during provisioning. | [default to undefined] +**recipient** | **ProvisioningcompletedRecipientV1** | | [default to undefined] +**requester** | **(optional)** **ProvisioningcompletedRequesterV1** | | [default to undefined] +**accountRequests** | **Array<ProvisioningcompletedAccountRequestsInnerV1>** | A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInner.md b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInner.md new file mode 100644 index 00000000..1582fb9c --- /dev/null +++ b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInner.md @@ -0,0 +1,25 @@ +--- +id: v1-provisioningcompleted-account-requests-inner-v1 +title: ProvisioningcompletedAccountRequestsInnerV1 +pagination_label: ProvisioningcompletedAccountRequestsInnerV1 +sidebar_label: ProvisioningcompletedAccountRequestsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedAccountRequestsInnerV1', 'v1ProvisioningcompletedAccountRequestsInnerV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-account-requests-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedAccountRequestsInnerV1', 'v1ProvisioningcompletedAccountRequestsInnerV1'] +--- + +# ProvisioningcompletedAccountRequestsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | **ProvisioningcompletedAccountRequestsInnerSourceV1** | | [default to undefined] +**accountId** | **(optional)** **string** | The unique idenfier of the account being provisioned. | [default to undefined] +**accountOperation** | **string** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [default to undefined] +**provisioningResult** | **string** | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [default to undefined] +**provisioningTarget** | **string** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [default to undefined] +**ticketId** | **(optional)** **string** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [default to undefined] +**attributeRequests** | **(optional)** **Array<ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1>** | A list of attributes as part of the provisioning transaction. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerAttributeRequestsInner.md b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 00000000..61f0fc11 --- /dev/null +++ b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,21 @@ +--- +id: v1-provisioningcompleted-account-requests-inner-attribute-requests-inner-v1 +title: ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 +pagination_label: ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 +sidebar_label: ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1', 'v1ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-account-requests-inner-attribute-requests-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1', 'v1ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1'] +--- + +# ProvisioningcompletedAccountRequestsInnerAttributeRequestsInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributeName** | **string** | The name of the attribute being provisioned. | [default to undefined] +**attributeValue** | **(optional)** **string** | The value of the attribute being provisioned. | [default to undefined] +**operation** | **string** | The operation to handle the attribute. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerSource.md b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerSource.md new file mode 100644 index 00000000..08abeaec --- /dev/null +++ b/sdk-output/triggers/docs/Models/ProvisioningcompletedAccountRequestsInnerSource.md @@ -0,0 +1,21 @@ +--- +id: v1-provisioningcompleted-account-requests-inner-source-v1 +title: ProvisioningcompletedAccountRequestsInnerSourceV1 +pagination_label: ProvisioningcompletedAccountRequestsInnerSourceV1 +sidebar_label: ProvisioningcompletedAccountRequestsInnerSourceV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedAccountRequestsInnerSourceV1', 'v1ProvisioningcompletedAccountRequestsInnerSourceV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-account-requests-inner-source-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedAccountRequestsInnerSourceV1', 'v1ProvisioningcompletedAccountRequestsInnerSourceV1'] +--- + +# ProvisioningcompletedAccountRequestsInnerSourceV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | ID of the object to which this reference applies | [default to undefined] +**type** | **string** | The type of object that is referenced | [default to undefined] +**name** | **string** | Human-readable display name of the object to which this reference applies | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ProvisioningcompletedRecipient.md b/sdk-output/triggers/docs/Models/ProvisioningcompletedRecipient.md new file mode 100644 index 00000000..a78bf1d9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/ProvisioningcompletedRecipient.md @@ -0,0 +1,21 @@ +--- +id: v1-provisioningcompleted-recipient-v1 +title: ProvisioningcompletedRecipientV1 +pagination_label: ProvisioningcompletedRecipientV1 +sidebar_label: ProvisioningcompletedRecipientV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedRecipientV1', 'v1ProvisioningcompletedRecipientV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-recipient-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedRecipientV1', 'v1ProvisioningcompletedRecipientV1'] +--- + +# ProvisioningcompletedRecipientV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Provisioning recipient DTO type. | [default to undefined] +**id** | **string** | Provisioning recipient\'s identity ID. | [default to undefined] +**name** | **string** | Provisioning recipient\'s display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/ProvisioningcompletedRequester.md b/sdk-output/triggers/docs/Models/ProvisioningcompletedRequester.md new file mode 100644 index 00000000..5ed3bbb7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/ProvisioningcompletedRequester.md @@ -0,0 +1,21 @@ +--- +id: v1-provisioningcompleted-requester-v1 +title: ProvisioningcompletedRequesterV1 +pagination_label: ProvisioningcompletedRequesterV1 +sidebar_label: ProvisioningcompletedRequesterV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ProvisioningcompletedRequesterV1', 'v1ProvisioningcompletedRequesterV1'] +slug: /tools/sdk/typescript/triggers/models/provisioningcompleted-requester-v1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningcompletedRequesterV1', 'v1ProvisioningcompletedRequesterV1'] +--- + +# ProvisioningcompletedRequesterV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | Provisioning requester\'s DTO type. | [default to undefined] +**id** | **string** | Provisioning requester\'s identity ID. | [default to undefined] +**name** | **string** | Provisioning owner\'s human-readable display name. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/README.md b/sdk-output/triggers/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/triggers/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/triggers/docs/Models/Reassignment.md b/sdk-output/triggers/docs/Models/Reassignment.md new file mode 100644 index 00000000..4b1f1881 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Reassignment.md @@ -0,0 +1,20 @@ +--- +id: v1-reassignment-v1 +title: ReassignmentV1 +pagination_label: ReassignmentV1 +sidebar_label: ReassignmentV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmentV1', 'v1ReassignmentV1'] +slug: /tools/sdk/typescript/triggers/models/reassignment-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmentV1', 'v1ReassignmentV1'] +--- + +# ReassignmentV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**from** | **(optional)** **CertificationreferenceV1** | | [default to undefined] +**comment** | **(optional)** **string** | The comment entered when the Certification was reassigned | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Reviewer.md b/sdk-output/triggers/docs/Models/Reviewer.md new file mode 100644 index 00000000..95c288e6 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Reviewer.md @@ -0,0 +1,24 @@ +--- +id: v1-reviewer-v1 +title: ReviewerV1 +pagination_label: ReviewerV1 +sidebar_label: ReviewerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReviewerV1', 'v1ReviewerV1'] +slug: /tools/sdk/typescript/triggers/models/reviewer-v1 +tags: ['SDK', 'Software Development Kit', 'ReviewerV1', 'v1ReviewerV1'] +--- + +# ReviewerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The id of the reviewer. | [default to undefined] +**name** | **(optional)** **string** | The name of the reviewer. | [default to undefined] +**email** | **(optional)** **string** | The email of the reviewing identity. This is only applicable to reviewers of the `IDENTITY` type. | [default to undefined] +**type** | **(optional)** **string** | The type of the reviewing identity. | [default to undefined] +**created** | **(optional)** **string** | The created date of the reviewing identity. | [default to undefined] +**modified** | **(optional)** **string** | The modified date of the reviewing identity. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Savedsearchcomplete.md b/sdk-output/triggers/docs/Models/Savedsearchcomplete.md new file mode 100644 index 00000000..3d86820f --- /dev/null +++ b/sdk-output/triggers/docs/Models/Savedsearchcomplete.md @@ -0,0 +1,25 @@ +--- +id: v1-savedsearchcomplete-v1 +title: SavedsearchcompleteV1 +pagination_label: SavedsearchcompleteV1 +sidebar_label: SavedsearchcompleteV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchcompleteV1', 'v1SavedsearchcompleteV1'] +slug: /tools/sdk/typescript/triggers/models/savedsearchcomplete-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchcompleteV1', 'v1SavedsearchcompleteV1'] +--- + +# SavedsearchcompleteV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fileName** | **string** | A name for the report file. | [default to undefined] +**ownerEmail** | **string** | The email address of the identity that owns the saved search. | [default to undefined] +**ownerName** | **string** | The name of the identity that owns the saved search. | [default to undefined] +**query** | **string** | The search query that was used to generate the report. | [default to undefined] +**searchName** | **string** | The name of the saved search. | [default to undefined] +**searchResults** | **SavedsearchcompleteSearchResultsV1** | | [default to undefined] +**signedS3Url** | **string** | The Amazon S3 URL to download the report from. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResults.md b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResults.md new file mode 100644 index 00000000..add6dbd9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResults.md @@ -0,0 +1,21 @@ +--- +id: v1-savedsearchcomplete-search-results-v1 +title: SavedsearchcompleteSearchResultsV1 +pagination_label: SavedsearchcompleteSearchResultsV1 +sidebar_label: SavedsearchcompleteSearchResultsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchcompleteSearchResultsV1', 'v1SavedsearchcompleteSearchResultsV1'] +slug: /tools/sdk/typescript/triggers/models/savedsearchcomplete-search-results-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchcompleteSearchResultsV1', 'v1SavedsearchcompleteSearchResultsV1'] +--- + +# SavedsearchcompleteSearchResultsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | **(optional)** **SavedsearchcompleteSearchResultsAccountV1** | | [default to undefined] +**Entitlement** | **(optional)** **SavedsearchcompleteSearchResultsEntitlementV1** | | [default to undefined] +**Identity** | **(optional)** **SavedsearchcompleteSearchResultsIdentityV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsAccount.md b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsAccount.md new file mode 100644 index 00000000..ff650272 --- /dev/null +++ b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsAccount.md @@ -0,0 +1,21 @@ +--- +id: v1-savedsearchcomplete-search-results-account-v1 +title: SavedsearchcompleteSearchResultsAccountV1 +pagination_label: SavedsearchcompleteSearchResultsAccountV1 +sidebar_label: SavedsearchcompleteSearchResultsAccountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchcompleteSearchResultsAccountV1', 'v1SavedsearchcompleteSearchResultsAccountV1'] +slug: /tools/sdk/typescript/triggers/models/savedsearchcomplete-search-results-account-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchcompleteSearchResultsAccountV1', 'v1SavedsearchcompleteSearchResultsAccountV1'] +--- + +# SavedsearchcompleteSearchResultsAccountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **string** | The number of rows in the table. | [default to undefined] +**noun** | **string** | The type of object represented in the table. | [default to undefined] +**preview** | **Array<Array<string>>** | A sample of the data in the table. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsEntitlement.md b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsEntitlement.md new file mode 100644 index 00000000..22cb3f16 --- /dev/null +++ b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsEntitlement.md @@ -0,0 +1,21 @@ +--- +id: v1-savedsearchcomplete-search-results-entitlement-v1 +title: SavedsearchcompleteSearchResultsEntitlementV1 +pagination_label: SavedsearchcompleteSearchResultsEntitlementV1 +sidebar_label: SavedsearchcompleteSearchResultsEntitlementV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchcompleteSearchResultsEntitlementV1', 'v1SavedsearchcompleteSearchResultsEntitlementV1'] +slug: /tools/sdk/typescript/triggers/models/savedsearchcomplete-search-results-entitlement-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchcompleteSearchResultsEntitlementV1', 'v1SavedsearchcompleteSearchResultsEntitlementV1'] +--- + +# SavedsearchcompleteSearchResultsEntitlementV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **string** | The number of rows in the table. | [default to undefined] +**noun** | **string** | The type of object represented in the table. | [default to undefined] +**preview** | **Array<Array<string>>** | A sample of the data in the table. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsIdentity.md b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsIdentity.md new file mode 100644 index 00000000..5b4e6c6c --- /dev/null +++ b/sdk-output/triggers/docs/Models/SavedsearchcompleteSearchResultsIdentity.md @@ -0,0 +1,21 @@ +--- +id: v1-savedsearchcomplete-search-results-identity-v1 +title: SavedsearchcompleteSearchResultsIdentityV1 +pagination_label: SavedsearchcompleteSearchResultsIdentityV1 +sidebar_label: SavedsearchcompleteSearchResultsIdentityV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SavedsearchcompleteSearchResultsIdentityV1', 'v1SavedsearchcompleteSearchResultsIdentityV1'] +slug: /tools/sdk/typescript/triggers/models/savedsearchcomplete-search-results-identity-v1 +tags: ['SDK', 'Software Development Kit', 'SavedsearchcompleteSearchResultsIdentityV1', 'v1SavedsearchcompleteSearchResultsIdentityV1'] +--- + +# SavedsearchcompleteSearchResultsIdentityV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **string** | The number of rows in the table. | [default to undefined] +**noun** | **string** | The type of object represented in the table. | [default to undefined] +**preview** | **Array<Array<string>>** | A sample of the data in the table. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourceaccountcreated.md b/sdk-output/triggers/docs/Models/Sourceaccountcreated.md new file mode 100644 index 00000000..bb292faf --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourceaccountcreated.md @@ -0,0 +1,26 @@ +--- +id: v1-sourceaccountcreated-v1 +title: SourceaccountcreatedV1 +pagination_label: SourceaccountcreatedV1 +sidebar_label: SourceaccountcreatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceaccountcreatedV1', 'v1SourceaccountcreatedV1'] +slug: /tools/sdk/typescript/triggers/models/sourceaccountcreated-v1 +tags: ['SDK', 'Software Development Kit', 'SourceaccountcreatedV1', 'v1SourceaccountcreatedV1'] +--- + +# SourceaccountcreatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **(optional)** **string** | Source unique identifier for the identity. UUID is generated by the source system. | [default to undefined] +**id** | **string** | SailPoint generated unique identifier. | [default to undefined] +**nativeIdentifier** | **string** | Unique ID of the account on the source. | [default to undefined] +**sourceId** | **string** | The ID of the source. | [default to undefined] +**sourceName** | **string** | The name of the source. | [default to undefined] +**identityId** | **string** | The ID of the identity that is correlated with this account. | [default to undefined] +**identityName** | **string** | The name of the identity that is correlated with this account. | [default to undefined] +**attributes** | | The attributes of the account. The contents of attributes depends on the account schema for the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourceaccountdeleted.md b/sdk-output/triggers/docs/Models/Sourceaccountdeleted.md new file mode 100644 index 00000000..c674ad34 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourceaccountdeleted.md @@ -0,0 +1,26 @@ +--- +id: v1-sourceaccountdeleted-v1 +title: SourceaccountdeletedV1 +pagination_label: SourceaccountdeletedV1 +sidebar_label: SourceaccountdeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceaccountdeletedV1', 'v1SourceaccountdeletedV1'] +slug: /tools/sdk/typescript/triggers/models/sourceaccountdeleted-v1 +tags: ['SDK', 'Software Development Kit', 'SourceaccountdeletedV1', 'v1SourceaccountdeletedV1'] +--- + +# SourceaccountdeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **(optional)** **string** | Source unique identifier for the identity. UUID is generated by the source system. | [default to undefined] +**id** | **string** | SailPoint generated unique identifier. | [default to undefined] +**nativeIdentifier** | **string** | Unique ID of the account on the source. | [default to undefined] +**sourceId** | **string** | The ID of the source. | [default to undefined] +**sourceName** | **string** | The name of the source. | [default to undefined] +**identityId** | **string** | The ID of the identity that is correlated with this account. | [default to undefined] +**identityName** | **string** | The name of the identity that is correlated with this account. | [default to undefined] +**attributes** | | The attributes of the account. The contents of attributes depends on the account schema for the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourceaccountupdated.md b/sdk-output/triggers/docs/Models/Sourceaccountupdated.md new file mode 100644 index 00000000..fd560237 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourceaccountupdated.md @@ -0,0 +1,26 @@ +--- +id: v1-sourceaccountupdated-v1 +title: SourceaccountupdatedV1 +pagination_label: SourceaccountupdatedV1 +sidebar_label: SourceaccountupdatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceaccountupdatedV1', 'v1SourceaccountupdatedV1'] +slug: /tools/sdk/typescript/triggers/models/sourceaccountupdated-v1 +tags: ['SDK', 'Software Development Kit', 'SourceaccountupdatedV1', 'v1SourceaccountupdatedV1'] +--- + +# SourceaccountupdatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **(optional)** **string** | Source unique identifier for the identity. UUID is generated by the source system. | [default to undefined] +**id** | **string** | SailPoint generated unique identifier. | [default to undefined] +**nativeIdentifier** | **string** | Unique ID of the account on the source. | [default to undefined] +**sourceId** | **string** | The ID of the source. | [default to undefined] +**sourceName** | **string** | The name of the source. | [default to undefined] +**identityId** | **string** | The ID of the identity that is correlated with this account. | [default to undefined] +**identityName** | **string** | The name of the identity that is correlated with this account. | [default to undefined] +**attributes** | | The attributes of the account. The contents of attributes depends on the account schema for the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourcecreated.md b/sdk-output/triggers/docs/Models/Sourcecreated.md new file mode 100644 index 00000000..3311c434 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourcecreated.md @@ -0,0 +1,24 @@ +--- +id: v1-sourcecreated-v1 +title: SourcecreatedV1 +pagination_label: SourcecreatedV1 +sidebar_label: SourcecreatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcecreatedV1', 'v1SourcecreatedV1'] +slug: /tools/sdk/typescript/triggers/models/sourcecreated-v1 +tags: ['SDK', 'Software Development Kit', 'SourcecreatedV1', 'v1SourcecreatedV1'] +--- + +# SourcecreatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the source. | [default to undefined] +**name** | **string** | Human friendly name of the source. | [default to undefined] +**type** | **string** | The connection type. | [default to undefined] +**created** | **string** | The date and time the source was created. | [default to undefined] +**connector** | **string** | The connector type used to connect to the source. | [default to undefined] +**actor** | **SourcecreatedActorV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SourcecreatedActor.md b/sdk-output/triggers/docs/Models/SourcecreatedActor.md new file mode 100644 index 00000000..ae45713b --- /dev/null +++ b/sdk-output/triggers/docs/Models/SourcecreatedActor.md @@ -0,0 +1,21 @@ +--- +id: v1-sourcecreated-actor-v1 +title: SourcecreatedActorV1 +pagination_label: SourcecreatedActorV1 +sidebar_label: SourcecreatedActorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcecreatedActorV1', 'v1SourcecreatedActorV1'] +slug: /tools/sdk/typescript/triggers/models/sourcecreated-actor-v1 +tags: ['SDK', 'Software Development Kit', 'SourcecreatedActorV1', 'v1SourcecreatedActorV1'] +--- + +# SourcecreatedActorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of identity who created the source. | [default to undefined] +**id** | **string** | ID of identity who created the source. | [default to undefined] +**name** | **string** | Display name of identity who created the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourcedeleted.md b/sdk-output/triggers/docs/Models/Sourcedeleted.md new file mode 100644 index 00000000..89736d54 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourcedeleted.md @@ -0,0 +1,24 @@ +--- +id: v1-sourcedeleted-v1 +title: SourcedeletedV1 +pagination_label: SourcedeletedV1 +sidebar_label: SourcedeletedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcedeletedV1', 'v1SourcedeletedV1'] +slug: /tools/sdk/typescript/triggers/models/sourcedeleted-v1 +tags: ['SDK', 'Software Development Kit', 'SourcedeletedV1', 'v1SourcedeletedV1'] +--- + +# SourcedeletedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the source. | [default to undefined] +**name** | **string** | Human friendly name of the source. | [default to undefined] +**type** | **string** | The connection type. | [default to undefined] +**deleted** | **string** | The date and time the source was deleted. | [default to undefined] +**connector** | **string** | The connector type used to connect to the source. | [default to undefined] +**actor** | **SourcedeletedActorV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SourcedeletedActor.md b/sdk-output/triggers/docs/Models/SourcedeletedActor.md new file mode 100644 index 00000000..418be89e --- /dev/null +++ b/sdk-output/triggers/docs/Models/SourcedeletedActor.md @@ -0,0 +1,21 @@ +--- +id: v1-sourcedeleted-actor-v1 +title: SourcedeletedActorV1 +pagination_label: SourcedeletedActorV1 +sidebar_label: SourcedeletedActorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourcedeletedActorV1', 'v1SourcedeletedActorV1'] +slug: /tools/sdk/typescript/triggers/models/sourcedeleted-actor-v1 +tags: ['SDK', 'Software Development Kit', 'SourcedeletedActorV1', 'v1SourcedeletedActorV1'] +--- + +# SourcedeletedActorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of identity who deleted the source. | [default to undefined] +**id** | **string** | ID of identity who deleted the source. | [default to undefined] +**name** | **string** | Display name of identity who deleted the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Sourceupdated.md b/sdk-output/triggers/docs/Models/Sourceupdated.md new file mode 100644 index 00000000..e5b7f1c0 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Sourceupdated.md @@ -0,0 +1,24 @@ +--- +id: v1-sourceupdated-v1 +title: SourceupdatedV1 +pagination_label: SourceupdatedV1 +sidebar_label: SourceupdatedV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceupdatedV1', 'v1SourceupdatedV1'] +slug: /tools/sdk/typescript/triggers/models/sourceupdated-v1 +tags: ['SDK', 'Software Development Kit', 'SourceupdatedV1', 'v1SourceupdatedV1'] +--- + +# SourceupdatedV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the source. | [default to undefined] +**name** | **string** | The user friendly name of the source. | [default to undefined] +**type** | **string** | The connection type of the source. | [default to undefined] +**modified** | **string** | The date and time the source was modified. | [default to undefined] +**connector** | **string** | The connector type used to connect to the source. | [default to undefined] +**actor** | **SourceupdatedActorV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SourceupdatedActor.md b/sdk-output/triggers/docs/Models/SourceupdatedActor.md new file mode 100644 index 00000000..9f486cb9 --- /dev/null +++ b/sdk-output/triggers/docs/Models/SourceupdatedActor.md @@ -0,0 +1,21 @@ +--- +id: v1-sourceupdated-actor-v1 +title: SourceupdatedActorV1 +pagination_label: SourceupdatedActorV1 +sidebar_label: SourceupdatedActorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SourceupdatedActorV1', 'v1SourceupdatedActorV1'] +slug: /tools/sdk/typescript/triggers/models/sourceupdated-actor-v1 +tags: ['SDK', 'Software Development Kit', 'SourceupdatedActorV1', 'v1SourceupdatedActorV1'] +--- + +# SourceupdatedActorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | DTO type of identity who updated the source. | [default to undefined] +**id** | **(optional)** **string** | ID of identity who updated the source. | [default to undefined] +**name** | **string** | Display name of identity who updated the source. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Startinvocationinput.md b/sdk-output/triggers/docs/Models/Startinvocationinput.md new file mode 100644 index 00000000..c1bebe9d --- /dev/null +++ b/sdk-output/triggers/docs/Models/Startinvocationinput.md @@ -0,0 +1,21 @@ +--- +id: v1-startinvocationinput-v1 +title: StartinvocationinputV1 +pagination_label: StartinvocationinputV1 +sidebar_label: StartinvocationinputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'StartinvocationinputV1', 'v1StartinvocationinputV1'] +slug: /tools/sdk/typescript/triggers/models/startinvocationinput-v1 +tags: ['SDK', 'Software Development Kit', 'StartinvocationinputV1', 'v1StartinvocationinputV1'] +--- + +# StartinvocationinputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**triggerId** | **(optional)** **string** | Trigger ID | [default to undefined] +**input** | **(optional)** **object** | Trigger input payload. Its schema is defined in the trigger definition. | [default to undefined] +**contentJson** | **(optional)** **object** | JSON map of invocation metadata | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Subscription.md b/sdk-output/triggers/docs/Models/Subscription.md new file mode 100644 index 00000000..822217a7 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Subscription.md @@ -0,0 +1,29 @@ +--- +id: v1-subscription-v1 +title: SubscriptionV1 +pagination_label: SubscriptionV1 +sidebar_label: SubscriptionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionV1', 'v1SubscriptionV1'] +slug: /tools/sdk/typescript/triggers/models/subscription-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionV1', 'v1SubscriptionV1'] +--- + +# SubscriptionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Subscription ID. | [default to undefined] +**name** | **string** | Subscription name. | [default to undefined] +**description** | **(optional)** **string** | Subscription description. | [default to undefined] +**triggerId** | **string** | ID of trigger subscribed to. | [default to undefined] +**triggerName** | **string** | Trigger name of trigger subscribed to. | [default to undefined] +**type** | **SubscriptiontypeV1** | | [default to undefined] +**responseDeadline** | **(optional)** **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [default to 'PT1H'] +**httpConfig** | **(optional)** **HttpconfigV1** | | [default to undefined] +**eventBridgeConfig** | **(optional)** **EventbridgeconfigV1** | | [default to undefined] +**enabled** | **boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**filter** | **(optional)** **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInner.md b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInner.md new file mode 100644 index 00000000..97490b68 --- /dev/null +++ b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInner.md @@ -0,0 +1,21 @@ +--- +id: v1-subscriptionpatchrequest-inner-v1 +title: SubscriptionpatchrequestInnerV1 +pagination_label: SubscriptionpatchrequestInnerV1 +sidebar_label: SubscriptionpatchrequestInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionpatchrequestInnerV1', 'v1SubscriptionpatchrequestInnerV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptionpatchrequest-inner-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionpatchrequestInnerV1', 'v1SubscriptionpatchrequestInnerV1'] +--- + +# SubscriptionpatchrequestInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **SubscriptionpatchrequestInnerValueV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValue.md b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValue.md new file mode 100644 index 00000000..9018f93a --- /dev/null +++ b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValue.md @@ -0,0 +1,18 @@ +--- +id: v1-subscriptionpatchrequest-inner-value-v1 +title: SubscriptionpatchrequestInnerValueV1 +pagination_label: SubscriptionpatchrequestInnerValueV1 +sidebar_label: SubscriptionpatchrequestInnerValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionpatchrequestInnerValueV1', 'v1SubscriptionpatchrequestInnerValueV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptionpatchrequest-inner-value-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionpatchrequestInnerValueV1', 'v1SubscriptionpatchrequestInnerValueV1'] +--- + +# SubscriptionpatchrequestInnerValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValueAnyOfInner.md b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValueAnyOfInner.md new file mode 100644 index 00000000..9d1561ee --- /dev/null +++ b/sdk-output/triggers/docs/Models/SubscriptionpatchrequestInnerValueAnyOfInner.md @@ -0,0 +1,18 @@ +--- +id: v1-subscriptionpatchrequest-inner-value-any-of-inner-v1 +title: SubscriptionpatchrequestInnerValueAnyOfInnerV1 +pagination_label: SubscriptionpatchrequestInnerValueAnyOfInnerV1 +sidebar_label: SubscriptionpatchrequestInnerValueAnyOfInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionpatchrequestInnerValueAnyOfInnerV1', 'v1SubscriptionpatchrequestInnerValueAnyOfInnerV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptionpatchrequest-inner-value-any-of-inner-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionpatchrequestInnerValueAnyOfInnerV1', 'v1SubscriptionpatchrequestInnerValueAnyOfInnerV1'] +--- + +# SubscriptionpatchrequestInnerValueAnyOfInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/triggers/docs/Models/Subscriptionpostrequest.md b/sdk-output/triggers/docs/Models/Subscriptionpostrequest.md new file mode 100644 index 00000000..698e9e72 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Subscriptionpostrequest.md @@ -0,0 +1,27 @@ +--- +id: v1-subscriptionpostrequest-v1 +title: SubscriptionpostrequestV1 +pagination_label: SubscriptionpostrequestV1 +sidebar_label: SubscriptionpostrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionpostrequestV1', 'v1SubscriptionpostrequestV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptionpostrequest-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionpostrequestV1', 'v1SubscriptionpostrequestV1'] +--- + +# SubscriptionpostrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | Subscription name. | [default to undefined] +**description** | **(optional)** **string** | Subscription description. | [default to undefined] +**triggerId** | **string** | ID of trigger subscribed to. | [default to undefined] +**type** | **SubscriptiontypeV1** | | [default to undefined] +**responseDeadline** | **(optional)** **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [default to 'PT1H'] +**httpConfig** | **(optional)** **HttpconfigV1** | | [default to undefined] +**eventBridgeConfig** | **(optional)** **EventbridgeconfigV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**filter** | **(optional)** **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Subscriptionputrequest.md b/sdk-output/triggers/docs/Models/Subscriptionputrequest.md new file mode 100644 index 00000000..01c6bc5b --- /dev/null +++ b/sdk-output/triggers/docs/Models/Subscriptionputrequest.md @@ -0,0 +1,26 @@ +--- +id: v1-subscriptionputrequest-v1 +title: SubscriptionputrequestV1 +pagination_label: SubscriptionputrequestV1 +sidebar_label: SubscriptionputrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptionputrequestV1', 'v1SubscriptionputrequestV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptionputrequest-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptionputrequestV1', 'v1SubscriptionputrequestV1'] +--- + +# SubscriptionputrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Subscription name. | [default to undefined] +**description** | **(optional)** **string** | Subscription description. | [default to undefined] +**type** | **(optional)** **SubscriptiontypeV1** | | [default to undefined] +**responseDeadline** | **(optional)** **string** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [default to 'PT1H'] +**httpConfig** | **(optional)** **HttpconfigV1** | | [default to undefined] +**eventBridgeConfig** | **(optional)** **EventbridgeconfigV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [default to true] +**filter** | **(optional)** **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Subscriptiontype.md b/sdk-output/triggers/docs/Models/Subscriptiontype.md new file mode 100644 index 00000000..93d1a015 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Subscriptiontype.md @@ -0,0 +1,27 @@ +--- +id: v1-subscriptiontype-v1 +title: SubscriptiontypeV1 +pagination_label: SubscriptiontypeV1 +sidebar_label: SubscriptiontypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SubscriptiontypeV1', 'v1SubscriptiontypeV1'] +slug: /tools/sdk/typescript/triggers/models/subscriptiontype-v1 +tags: ['SDK', 'Software Development Kit', 'SubscriptiontypeV1', 'v1SubscriptiontypeV1'] +--- + +# SubscriptiontypeV1 + +## Enum + + +* `Http` (value: `'HTTP'`) + +* `Eventbridge` (value: `'EVENTBRIDGE'`) + +* `Inline` (value: `'INLINE'`) + +* `Script` (value: `'SCRIPT'`) + +* `Workflow` (value: `'WORKFLOW'`) + + diff --git a/sdk-output/triggers/docs/Models/Testinvocation.md b/sdk-output/triggers/docs/Models/Testinvocation.md new file mode 100644 index 00000000..73fc2c02 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Testinvocation.md @@ -0,0 +1,22 @@ +--- +id: v1-testinvocation-v1 +title: TestinvocationV1 +pagination_label: TestinvocationV1 +sidebar_label: TestinvocationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestinvocationV1', 'v1TestinvocationV1'] +slug: /tools/sdk/typescript/triggers/models/testinvocation-v1 +tags: ['SDK', 'Software Development Kit', 'TestinvocationV1', 'v1TestinvocationV1'] +--- + +# TestinvocationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**triggerId** | **string** | Trigger ID | [default to undefined] +**input** | **(optional)** **object** | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [default to undefined] +**contentJson** | **object** | JSON map of invocation metadata. | [default to undefined] +**subscriptionIds** | **(optional)** **Array<string>** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Trigger.md b/sdk-output/triggers/docs/Models/Trigger.md new file mode 100644 index 00000000..d0255e37 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Trigger.md @@ -0,0 +1,26 @@ +--- +id: v1-trigger-v1 +title: TriggerV1 +pagination_label: TriggerV1 +sidebar_label: TriggerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TriggerV1', 'v1TriggerV1'] +slug: /tools/sdk/typescript/triggers/models/trigger-v1 +tags: ['SDK', 'Software Development Kit', 'TriggerV1', 'v1TriggerV1'] +--- + +# TriggerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier of the trigger. | [default to undefined] +**name** | **string** | Trigger Name. | [default to undefined] +**type** | **TriggertypeV1** | | [default to undefined] +**description** | **(optional)** **string** | Trigger Description. | [default to undefined] +**inputSchema** | **string** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [default to undefined] +**exampleInput** | **TriggerExampleInputV1** | | [default to undefined] +**outputSchema** | **(optional)** **string** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [default to undefined] +**exampleOutput** | **(optional)** **TriggerExampleOutputV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/TriggerExampleInput.md b/sdk-output/triggers/docs/Models/TriggerExampleInput.md new file mode 100644 index 00000000..f4ee1ca3 --- /dev/null +++ b/sdk-output/triggers/docs/Models/TriggerExampleInput.md @@ -0,0 +1,77 @@ +--- +id: v1-trigger-example-input-v1 +title: TriggerExampleInputV1 +pagination_label: TriggerExampleInputV1 +sidebar_label: TriggerExampleInputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TriggerExampleInputV1', 'v1TriggerExampleInputV1'] +slug: /tools/sdk/typescript/triggers/models/trigger-example-input-v1 +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInputV1', 'v1TriggerExampleInputV1'] +--- + +# TriggerExampleInputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accessRequestId** | **string** | The unique ID of the access request. | [default to undefined] +**requestedFor** | **Array<AccessitemrequestedfordtoV1>** | Identities access was requested for. | [default to undefined] +**requestedItems** | **Array<AccessrequestpreapprovalRequestedItemsInnerV1>** | Details of the access items being requested. | [default to undefined] +**requestedBy** | **AccessitemrequesterdtoV1** | | [default to undefined] +**requestedItemsStatus** | **Array<AccessrequestpostapprovalRequestedItemsStatusInnerV1>** | Details on the outcome of each access item. | [default to undefined] +**source** | **AccountsourcereferenceV1** | | [default to undefined] +**status** | **string** | The overall status of the collection. | [default to undefined] +**started** | **string** | The date and time when the account collection started. | [default to undefined] +**completed** | **string** | The date and time when the account collection finished. | [default to undefined] +**errors** | **Array<string>** | A list of any accumulated error messages that occurred during provisioning. | [default to undefined] +**warnings** | **Array<string>** | A list of any accumulated warning messages that occurred during provisioning. | [default to undefined] +**stats** | **AccountscollectedforaggregationStatsV1** | | [default to undefined] +**identity** | **IdentitydeletedIdentityV1** | | [default to undefined] +**account** | **Accountv2V1** | | [default to undefined] +**changes** | **Array<IdentityattributeschangedChangesInnerV1>** | A list of one or more identity attributes that changed on the identity. | [default to undefined] +**attributes** | | The attributes of the account. The contents of attributes depends on the account schema for the source. | [default to undefined] +**entitlementCount** | **(optional)** **number** | The number of entitlements associated with this account. | [default to undefined] +**event** | **AccountupdatedEventV1** | | [default to undefined] +**accountChangeTypes** | **Array<string>** | The types of changes that occurred to the account. | [default to undefined] +**singleValueAttributeChanges** | **Array<MachineidentityupdatedSingleValueAttributeChangesInnerV1>** | Details about the single-value attribute changes that occurred. | [default to undefined] +**multiValueAttributeChanges** | **Array<AccountupdatedMultiValueAttributeChangesInnerV1>** | Details about the multi-value attribute changes that occurred to the account. | [default to undefined] +**entitlementChanges** | **Array<AccountupdatedEntitlementChangesInnerV1>** | Details about the entitlement changes that occurred to the account. | [default to undefined] +**campaign** | **CampaigngeneratedCampaignV1** | | [default to undefined] +**certification** | **CertificationsignedoffCertificationV1** | | [default to undefined] +**eventType** | **string** | Type of the event. | [default to undefined] +**machineIdentity** | **MachineidentitydeletedMachineIdentityV1** | | [default to undefined] +**machineIdentityChangeTypes** | **Array<string>** | Types of changes that occurred to the machine identity. | [default to undefined] +**userEntitlementChanges** | **MachineidentityupdatedUserEntitlementChangesV1** | | [default to undefined] +**ownerChanges** | **MachineidentityupdatedOwnerChangesV1** | | [default to undefined] +**trackingNumber** | **string** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [default to undefined] +**sources** | **string** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [default to undefined] +**action** | **(optional)** **string** | Origin of where the provisioning request came from. | [default to undefined] +**recipient** | **ProvisioningcompletedRecipientV1** | | [default to undefined] +**requester** | **(optional)** **ProvisioningcompletedRequesterV1** | | [default to undefined] +**accountRequests** | **Array<ProvisioningcompletedAccountRequestsInnerV1>** | A list of provisioning instructions to be executed on a per-account basis. The order in which operations are executed may not always be predictable. | [default to undefined] +**fileName** | **string** | A name for the report file. | [default to undefined] +**ownerEmail** | **string** | The email address of the identity that owns the saved search. | [default to undefined] +**ownerName** | **string** | The name of the identity that owns the saved search. | [default to undefined] +**query** | **string** | The search query that was used to generate the report. | [default to undefined] +**searchName** | **string** | The name of the saved search. | [default to undefined] +**searchResults** | **SavedsearchcompleteSearchResultsV1** | | [default to undefined] +**signedS3Url** | **string** | The Amazon S3 URL to download the report from. | [default to undefined] +**uuid** | **(optional)** **string** | Source unique identifier for the identity. UUID is generated by the source system. | [default to undefined] +**id** | **string** | The unique ID of the source. | [default to undefined] +**nativeIdentifier** | **string** | Unique ID of the account on the source. | [default to undefined] +**sourceId** | **string** | The ID of the source. | [default to undefined] +**sourceName** | **string** | The name of the source. | [default to undefined] +**identityId** | **string** | The ID of the identity that is correlated with this account. | [default to undefined] +**identityName** | **string** | The name of the identity that is correlated with this account. | [default to undefined] +**name** | **string** | The user friendly name of the source. | [default to undefined] +**type** | **string** | The connection type of the source. | [default to undefined] +**created** | **string** | The date and time the status change occurred. | [default to undefined] +**connector** | **string** | The connector type used to connect to the source. | [default to undefined] +**actor** | **SourceupdatedActorV1** | | [default to undefined] +**deleted** | **string** | The date and time the source was deleted. | [default to undefined] +**modified** | **string** | The date and time the source was modified. | [default to undefined] +**application** | **VaclusterstatuschangeeventApplicationV1** | | [default to undefined] +**healthCheckResult** | **VaclusterstatuschangeeventHealthCheckResultV1** | | [default to undefined] +**previousHealthCheckResult** | **VaclusterstatuschangeeventPreviousHealthCheckResultV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/TriggerExampleOutput.md b/sdk-output/triggers/docs/Models/TriggerExampleOutput.md new file mode 100644 index 00000000..132e5fab --- /dev/null +++ b/sdk-output/triggers/docs/Models/TriggerExampleOutput.md @@ -0,0 +1,24 @@ +--- +id: v1-trigger-example-output-v1 +title: TriggerExampleOutputV1 +pagination_label: TriggerExampleOutputV1 +sidebar_label: TriggerExampleOutputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TriggerExampleOutputV1', 'v1TriggerExampleOutputV1'] +slug: /tools/sdk/typescript/triggers/models/trigger-example-output-v1 +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutputV1', 'v1TriggerExampleOutputV1'] +--- + +# TriggerExampleOutputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The unique ID of the identity to add to the approver list for the access request. | [default to undefined] +**name** | **string** | The name of the identity to add to the approver list for the access request. | [default to undefined] +**type** | **string** | The type of object being referenced. | [default to undefined] +**approved** | **boolean** | Whether or not to approve the access request. | [default to undefined] +**comment** | **string** | A comment about the decision to approve or deny the request. | [default to undefined] +**approver** | **string** | The name of the entity that approved or denied the request. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Triggertype.md b/sdk-output/triggers/docs/Models/Triggertype.md new file mode 100644 index 00000000..c679bbba --- /dev/null +++ b/sdk-output/triggers/docs/Models/Triggertype.md @@ -0,0 +1,21 @@ +--- +id: v1-triggertype-v1 +title: TriggertypeV1 +pagination_label: TriggertypeV1 +sidebar_label: TriggertypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TriggertypeV1', 'v1TriggertypeV1'] +slug: /tools/sdk/typescript/triggers/models/triggertype-v1 +tags: ['SDK', 'Software Development Kit', 'TriggertypeV1', 'v1TriggertypeV1'] +--- + +# TriggertypeV1 + +## Enum + + +* `RequestResponse` (value: `'REQUEST_RESPONSE'`) + +* `FireAndForget` (value: `'FIRE_AND_FORGET'`) + + diff --git a/sdk-output/triggers/docs/Models/Vaclusterstatuschangeevent.md b/sdk-output/triggers/docs/Models/Vaclusterstatuschangeevent.md new file mode 100644 index 00000000..0ad2117b --- /dev/null +++ b/sdk-output/triggers/docs/Models/Vaclusterstatuschangeevent.md @@ -0,0 +1,23 @@ +--- +id: v1-vaclusterstatuschangeevent-v1 +title: VaclusterstatuschangeeventV1 +pagination_label: VaclusterstatuschangeeventV1 +sidebar_label: VaclusterstatuschangeeventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VaclusterstatuschangeeventV1', 'v1VaclusterstatuschangeeventV1'] +slug: /tools/sdk/typescript/triggers/models/vaclusterstatuschangeevent-v1 +tags: ['SDK', 'Software Development Kit', 'VaclusterstatuschangeeventV1', 'v1VaclusterstatuschangeeventV1'] +--- + +# VaclusterstatuschangeeventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **string** | The date and time the status change occurred. | [default to undefined] +**type** | **string** | The type of the object that initiated this event. | [default to undefined] +**application** | **VaclusterstatuschangeeventApplicationV1** | | [default to undefined] +**healthCheckResult** | **VaclusterstatuschangeeventHealthCheckResultV1** | | [default to undefined] +**previousHealthCheckResult** | **VaclusterstatuschangeeventPreviousHealthCheckResultV1** | | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventApplication.md b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventApplication.md new file mode 100644 index 00000000..4f62ec88 --- /dev/null +++ b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventApplication.md @@ -0,0 +1,21 @@ +--- +id: v1-vaclusterstatuschangeevent-application-v1 +title: VaclusterstatuschangeeventApplicationV1 +pagination_label: VaclusterstatuschangeeventApplicationV1 +sidebar_label: VaclusterstatuschangeeventApplicationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VaclusterstatuschangeeventApplicationV1', 'v1VaclusterstatuschangeeventApplicationV1'] +slug: /tools/sdk/typescript/triggers/models/vaclusterstatuschangeevent-application-v1 +tags: ['SDK', 'Software Development Kit', 'VaclusterstatuschangeeventApplicationV1', 'v1VaclusterstatuschangeeventApplicationV1'] +--- + +# VaclusterstatuschangeeventApplicationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | The GUID of the application | [default to undefined] +**name** | **string** | The name of the application | [default to undefined] +**attributes** | | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventHealthCheckResult.md b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventHealthCheckResult.md new file mode 100644 index 00000000..7644c600 --- /dev/null +++ b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventHealthCheckResult.md @@ -0,0 +1,21 @@ +--- +id: v1-vaclusterstatuschangeevent-health-check-result-v1 +title: VaclusterstatuschangeeventHealthCheckResultV1 +pagination_label: VaclusterstatuschangeeventHealthCheckResultV1 +sidebar_label: VaclusterstatuschangeeventHealthCheckResultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VaclusterstatuschangeeventHealthCheckResultV1', 'v1VaclusterstatuschangeeventHealthCheckResultV1'] +slug: /tools/sdk/typescript/triggers/models/vaclusterstatuschangeevent-health-check-result-v1 +tags: ['SDK', 'Software Development Kit', 'VaclusterstatuschangeeventHealthCheckResultV1', 'v1VaclusterstatuschangeeventHealthCheckResultV1'] +--- + +# VaclusterstatuschangeeventHealthCheckResultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Detailed message of the result of the health check. | [default to undefined] +**resultType** | **string** | The type of the health check result. | [default to undefined] +**status** | **string** | The status of the health check. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventPreviousHealthCheckResult.md b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventPreviousHealthCheckResult.md new file mode 100644 index 00000000..b1f88b37 --- /dev/null +++ b/sdk-output/triggers/docs/Models/VaclusterstatuschangeeventPreviousHealthCheckResult.md @@ -0,0 +1,21 @@ +--- +id: v1-vaclusterstatuschangeevent-previous-health-check-result-v1 +title: VaclusterstatuschangeeventPreviousHealthCheckResultV1 +pagination_label: VaclusterstatuschangeeventPreviousHealthCheckResultV1 +sidebar_label: VaclusterstatuschangeeventPreviousHealthCheckResultV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'VaclusterstatuschangeeventPreviousHealthCheckResultV1', 'v1VaclusterstatuschangeeventPreviousHealthCheckResultV1'] +slug: /tools/sdk/typescript/triggers/models/vaclusterstatuschangeevent-previous-health-check-result-v1 +tags: ['SDK', 'Software Development Kit', 'VaclusterstatuschangeeventPreviousHealthCheckResultV1', 'v1VaclusterstatuschangeeventPreviousHealthCheckResultV1'] +--- + +# VaclusterstatuschangeeventPreviousHealthCheckResultV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **string** | Detailed message of the result of the health check. | [default to undefined] +**resultType** | **string** | The type of the health check result. | [default to undefined] +**status** | **string** | The status of the health check. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Validatefilterinputdto.md b/sdk-output/triggers/docs/Models/Validatefilterinputdto.md new file mode 100644 index 00000000..08b114ad --- /dev/null +++ b/sdk-output/triggers/docs/Models/Validatefilterinputdto.md @@ -0,0 +1,20 @@ +--- +id: v1-validatefilterinputdto-v1 +title: ValidatefilterinputdtoV1 +pagination_label: ValidatefilterinputdtoV1 +sidebar_label: ValidatefilterinputdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ValidatefilterinputdtoV1', 'v1ValidatefilterinputdtoV1'] +slug: /tools/sdk/typescript/triggers/models/validatefilterinputdto-v1 +tags: ['SDK', 'Software Development Kit', 'ValidatefilterinputdtoV1', 'v1ValidatefilterinputdtoV1'] +--- + +# ValidatefilterinputdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | Mock input to evaluate filter expression against. | [default to undefined] +**filter** | **string** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [default to undefined] + diff --git a/sdk-output/triggers/docs/Models/Validatefilteroutputdto.md b/sdk-output/triggers/docs/Models/Validatefilteroutputdto.md new file mode 100644 index 00000000..0ad2dd08 --- /dev/null +++ b/sdk-output/triggers/docs/Models/Validatefilteroutputdto.md @@ -0,0 +1,21 @@ +--- +id: v1-validatefilteroutputdto-v1 +title: ValidatefilteroutputdtoV1 +pagination_label: ValidatefilteroutputdtoV1 +sidebar_label: ValidatefilteroutputdtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ValidatefilteroutputdtoV1', 'v1ValidatefilteroutputdtoV1'] +slug: /tools/sdk/typescript/triggers/models/validatefilteroutputdto-v1 +tags: ['SDK', 'Software Development Kit', 'ValidatefilteroutputdtoV1', 'v1ValidatefilteroutputdtoV1'] +--- + +# ValidatefilteroutputdtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**isValid** | **(optional)** **boolean** | When this field is true, the filter expression is valid against the input. | [default to false] +**isValidJSONPath** | **(optional)** **boolean** | When this field is true, the filter expression is using a valid JSON path. | [default to false] +**isPathExist** | **(optional)** **boolean** | When this field is true, the filter expression is using an existing path. | [default to false] + diff --git a/sdk-output/ui_metadata/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/ui_metadata/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..661072bf --- /dev/null +++ b/sdk-output/ui_metadata/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,31 @@ +- path: /ui-metadata/v1/tenant + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/ui_metadata/methods/ui-metadata#get-tenant-ui-metadata-v1 + source: | + import { UIMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new UIMetadataV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getTenantUiMetadataV1(); + console.log(result); +- path: /ui-metadata/v1/tenant + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/ui_metadata/methods/ui-metadata#set-tenant-ui-metadata-v1 + source: | + import { UIMetadataV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new UIMetadataV1Api(configuration); + const tenantuimetadataitemupdaterequestV1: TenantuimetadataitemupdaterequestV1 = ; // TenantuimetadataitemupdaterequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.setTenantUiMetadataV1(tenantuimetadataitemupdaterequestV1); + console.log(result); diff --git a/sdk-output/ui_metadata/docs/Methods/Index.md b/sdk-output/ui_metadata/docs/Methods/Index.md new file mode 100644 index 00000000..fbae37c6 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: ui_metadata-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: ui_metadata-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'ui_metadata', 'methods'] +slug: /tools/sdk/typescript/ui_metadata/methods +tags: ['SDK', 'Software Development Kit', 'ui_metadata', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/ui_metadata/docs/Methods/UIMetadataV1Api.md b/sdk-output/ui_metadata/docs/Methods/UIMetadataV1Api.md new file mode 100644 index 00000000..e6ee82cc --- /dev/null +++ b/sdk-output/ui_metadata/docs/Methods/UIMetadataV1Api.md @@ -0,0 +1,106 @@ +--- +id: v1-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'UIMetadata', 'v1UIMetadata'] +slug: /tools/sdk/typescript/ui_metadata/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'v1UIMetadata'] +--- + +# UIMetadataV1Api + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get-tenant-ui-metadata-v1**](#get-tenant-ui-metadata-v1) | **GET** `/ui-metadata/v1/tenant` | Get a tenant ui metadata +[**set-tenant-ui-metadata-v1**](#set-tenant-ui-metadata-v1) | **PUT** `/ui-metadata/v1/tenant` | Update tenant ui metadata + + +## get-tenant-ui-metadata-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get a tenant ui metadata +This API endpoint retrieves UI metadata configured for your tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tenant-ui-metadata-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TenantuimetadataitemresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { UIMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new UIMetadataV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getTenantUiMetadataV1(); +console.log(result); +``` + +[[Back to top]](#) + +## set-tenant-ui-metadata-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update tenant ui metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/set-tenant-ui-metadata-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**tenantuimetadataitemupdaterequestV1** | **TenantuimetadataitemupdaterequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TenantuimetadataitemresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { UIMetadataV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new UIMetadataV1Api(configuration); +const tenantuimetadataitemupdaterequestV1: TenantuimetadataitemupdaterequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.setTenantUiMetadataV1(tenantuimetadataitemupdaterequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/ui_metadata/docs/Models/Errormessagedto.md b/sdk-output/ui_metadata/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..c7f44fd9 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/ui_metadata/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/ui_metadata/docs/Models/Errorresponsedto.md b/sdk-output/ui_metadata/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..7207f49b --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/ui_metadata/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1401Response.md b/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1401Response.md new file mode 100644 index 00000000..0abc2133 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-ui-metadata-v1401-response-v1 +title: GetTenantUiMetadataV1401ResponseV1 +pagination_label: GetTenantUiMetadataV1401ResponseV1 +sidebar_label: GetTenantUiMetadataV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantUiMetadataV1401ResponseV1', 'v1GetTenantUiMetadataV1401ResponseV1'] +slug: /tools/sdk/typescript/ui_metadata/models/get-tenant-ui-metadata-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantUiMetadataV1401ResponseV1', 'v1GetTenantUiMetadataV1401ResponseV1'] +--- + +# GetTenantUiMetadataV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1429Response.md b/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1429Response.md new file mode 100644 index 00000000..6a764628 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/GetTenantUiMetadataV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-tenant-ui-metadata-v1429-response-v1 +title: GetTenantUiMetadataV1429ResponseV1 +pagination_label: GetTenantUiMetadataV1429ResponseV1 +sidebar_label: GetTenantUiMetadataV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetTenantUiMetadataV1429ResponseV1', 'v1GetTenantUiMetadataV1429ResponseV1'] +slug: /tools/sdk/typescript/ui_metadata/models/get-tenant-ui-metadata-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetTenantUiMetadataV1429ResponseV1', 'v1GetTenantUiMetadataV1429ResponseV1'] +--- + +# GetTenantUiMetadataV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/ui_metadata/docs/Models/Index.md b/sdk-output/ui_metadata/docs/Models/Index.md new file mode 100644 index 00000000..8374ffb4 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: ui_metadata-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: ui_metadata-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'ui_metadata', 'models'] +slug: /tools/sdk/typescript/ui_metadata/models +tags: ['SDK', 'Software Development Kit', 'ui_metadata', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/ui_metadata/docs/Models/Localeorigin.md b/sdk-output/ui_metadata/docs/Models/Localeorigin.md new file mode 100644 index 00000000..c1ff68ec --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/ui_metadata/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/ui_metadata/docs/Models/README.md b/sdk-output/ui_metadata/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemresponse.md b/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemresponse.md new file mode 100644 index 00000000..868a0c58 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemresponse.md @@ -0,0 +1,21 @@ +--- +id: v1-tenantuimetadataitemresponse-v1 +title: TenantuimetadataitemresponseV1 +pagination_label: TenantuimetadataitemresponseV1 +sidebar_label: TenantuimetadataitemresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantuimetadataitemresponseV1', 'v1TenantuimetadataitemresponseV1'] +slug: /tools/sdk/typescript/ui_metadata/models/tenantuimetadataitemresponse-v1 +tags: ['SDK', 'Software Development Kit', 'TenantuimetadataitemresponseV1', 'v1TenantuimetadataitemresponseV1'] +--- + +# TenantuimetadataitemresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframeWhiteList** | **(optional)** **string** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [default to undefined] +**usernameLabel** | **(optional)** **string** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [default to undefined] +**usernameEmptyText** | **(optional)** **string** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [default to undefined] + diff --git a/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemupdaterequest.md b/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemupdaterequest.md new file mode 100644 index 00000000..cafffba3 --- /dev/null +++ b/sdk-output/ui_metadata/docs/Models/Tenantuimetadataitemupdaterequest.md @@ -0,0 +1,21 @@ +--- +id: v1-tenantuimetadataitemupdaterequest-v1 +title: TenantuimetadataitemupdaterequestV1 +pagination_label: TenantuimetadataitemupdaterequestV1 +sidebar_label: TenantuimetadataitemupdaterequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantuimetadataitemupdaterequestV1', 'v1TenantuimetadataitemupdaterequestV1'] +slug: /tools/sdk/typescript/ui_metadata/models/tenantuimetadataitemupdaterequest-v1 +tags: ['SDK', 'Software Development Kit', 'TenantuimetadataitemupdaterequestV1', 'v1TenantuimetadataitemupdaterequestV1'] +--- + +# TenantuimetadataitemupdaterequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iframeWhiteList** | **(optional)** **string** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use \"null\". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [default to undefined] +**usernameLabel** | **(optional)** **string** | Descriptor for the username input field. If you would like to reset the value use \"null\". | [default to undefined] +**usernameEmptyText** | **(optional)** **string** | Placeholder text displayed in the username input field. If you would like to reset the value use \"null\". | [default to undefined] + diff --git a/sdk-output/work_items/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/work_items/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..2a2d86b8 --- /dev/null +++ b/sdk-output/work_items/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,206 @@ +- path: /work-items/v1/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#approve-approval-item-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const approvalItemId: string = '1211bcaa32112bcef6122adb21cef1ac'; // string | The ID of the approval item. (default to undefined) + const result = await apiInstance.approveApprovalItemV1(id, approvalItemId); + console.log(result); +- path: /work-items/v1/bulk-approve/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#approve-approval-items-in-bulk-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const result = await apiInstance.approveApprovalItemsInBulkV1(id); + console.log(result); +- path: /work-items/v1/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#complete-work-item-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const body: string = body_example; // string | Body is the request payload to create form definition request (optional) + const result = await apiInstance.completeWorkItemV1(id); + console.log(result); +- path: /work-items/v1/{id}/forward + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#forward-work-item-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const workitemforwardV1: WorkitemforwardV1 = ; // WorkitemforwardV1 | + const result = await apiInstance.forwardWorkItemV1(id, workitemforwardV1); + console.log(result); +- path: /work-items/v1/completed + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#get-completed-work-items-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const ownerId: string = '1211bcaa32112bcef6122adb21cef1ac'; // string | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const result = await apiInstance.getCompletedWorkItemsV1(); + console.log(result); +- path: /work-items/v1/completed/count + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#get-count-completed-work-items-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const ownerId: string = 'ownerId_example'; // string | ID of the work item owner. (optional) (default to undefined) + const result = await apiInstance.getCountCompletedWorkItemsV1(); + console.log(result); +- path: /work-items/v1/count + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#get-count-work-items-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const ownerId: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | ID of the work item owner. (optional) (default to undefined) + const result = await apiInstance.getCountWorkItemsV1(); + console.log(result); +- path: /work-items/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#get-work-item-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = '2c9180835d191a86015d28455b4a2329'; // string | ID of the work item. (default to undefined) + const result = await apiInstance.getWorkItemV1(id); + console.log(result); +- path: /work-items/v1/summary + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#get-work-items-summary-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const ownerId: string = '1211bcaa32112bcef6122adb21cef1ac'; // string | ID of the work item owner. (optional) (default to undefined) + const result = await apiInstance.getWorkItemsSummaryV1(); + console.log(result); +- path: /work-items/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#list-work-items-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const count: boolean = true; // boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) + const ownerId: string = '1211bcaa32112bcef6122adb21cef1ac'; // string | ID of the work item owner. (optional) (default to undefined) + const result = await apiInstance.listWorkItemsV1(); + console.log(result); +- path: /work-items/v1/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#reject-approval-item-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const approvalItemId: string = '1211bcaa32112bcef6122adb21cef1ac'; // string | The ID of the approval item. (default to undefined) + const result = await apiInstance.rejectApprovalItemV1(id, approvalItemId); + console.log(result); +- path: /work-items/v1/bulk-reject/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#reject-approval-items-in-bulk-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const result = await apiInstance.rejectApprovalItemsInBulkV1(id); + console.log(result); +- path: /work-items/v1/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_items/methods/work-items#submit-account-selection-v1 + source: | + import { WorkItemsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkItemsV1Api(configuration); + const id: string = 'ef38f94347e94562b5bb8424a56397d8'; // string | The ID of the work item (default to undefined) + const requestBody: { [key: string]: any; } = {"fieldName":"fieldValue"}; // { [key: string]: any; } | Account Selection Data map, keyed on fieldName + const result = await apiInstance.submitAccountSelectionV1(id, requestBody); + console.log(result); diff --git a/sdk-output/work_items/docs/Methods/Index.md b/sdk-output/work_items/docs/Methods/Index.md new file mode 100644 index 00000000..fd13a380 --- /dev/null +++ b/sdk-output/work_items/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: work_items-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: work_items-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'work_items', 'methods'] +slug: /tools/sdk/typescript/work_items/methods +tags: ['SDK', 'Software Development Kit', 'work_items', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/work_items/docs/Methods/WorkItemsV1Api.md b/sdk-output/work_items/docs/Methods/WorkItemsV1Api.md new file mode 100644 index 00000000..829ded96 --- /dev/null +++ b/sdk-output/work_items/docs/Methods/WorkItemsV1Api.md @@ -0,0 +1,562 @@ +--- +id: v1-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkItems', 'v1WorkItems'] +slug: /tools/sdk/typescript/work_items/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'v1WorkItems'] +--- + +# WorkItemsV1Api + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**approve-approval-item-v1**](#approve-approval-item-v1) | **POST** `/work-items/v1/{id}/approve/{approvalItemId}` | Approve an approval item +[**approve-approval-items-in-bulk-v1**](#approve-approval-items-in-bulk-v1) | **POST** `/work-items/v1/bulk-approve/{id}` | Bulk approve approval items +[**complete-work-item-v1**](#complete-work-item-v1) | **POST** `/work-items/v1/{id}` | Complete a work item +[**forward-work-item-v1**](#forward-work-item-v1) | **POST** `/work-items/v1/{id}/forward` | Forward a work item +[**get-completed-work-items-v1**](#get-completed-work-items-v1) | **GET** `/work-items/v1/completed` | Completed work items +[**get-count-completed-work-items-v1**](#get-count-completed-work-items-v1) | **GET** `/work-items/v1/completed/count` | Count completed work items +[**get-count-work-items-v1**](#get-count-work-items-v1) | **GET** `/work-items/v1/count` | Count work items +[**get-work-item-v1**](#get-work-item-v1) | **GET** `/work-items/v1/{id}` | Get a work item +[**get-work-items-summary-v1**](#get-work-items-summary-v1) | **GET** `/work-items/v1/summary` | Work items summary +[**list-work-items-v1**](#list-work-items-v1) | **GET** `/work-items/v1` | List work items +[**reject-approval-item-v1**](#reject-approval-item-v1) | **POST** `/work-items/v1/{id}/reject/{approvalItemId}` | Reject an approval item +[**reject-approval-items-in-bulk-v1**](#reject-approval-items-in-bulk-v1) | **POST** `/work-items/v1/bulk-reject/{id}` | Bulk reject approval items +[**submit-account-selection-v1**](#submit-account-selection-v1) | **POST** `/work-items/v1/{id}/submit-account-selection` | Submit account selections + + +## approve-approval-item-v1 +Approve an approval item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-approval-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] +**approvalItemId** | **string** | The ID of the approval item. | [default to undefined] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const approvalItemId: string = 1211bcaa32112bcef6122adb21cef1ac; // The ID of the approval item. +const result = await apiInstance.approveApprovalItemV1(id, approvalItemId); +console.log(result); +``` + +[[Back to top]](#) + +## approve-approval-items-in-bulk-v1 +Bulk approve approval items +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/approve-approval-items-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const result = await apiInstance.approveApprovalItemsInBulkV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## complete-work-item-v1 +Complete a work item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/complete-work-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] +**body** | **string** | Body is the request payload to create form definition request | [optional] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const body: string = body_example; // Body is the request payload to create form definition request (optional) +const result = await apiInstance.completeWorkItemV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## forward-work-item-v1 +Forward a work item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/forward-work-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] +**workitemforwardV1** | **WorkitemforwardV1** | | + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const workitemforwardV1: WorkitemforwardV1 = ; // +const result = await apiInstance.forwardWorkItemV1(id, workitemforwardV1); +console.log(result); +``` + +[[Back to top]](#) + +## get-completed-work-items-v1 +Completed work items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-completed-work-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. | [optional] [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const ownerId: string = 1211bcaa32112bcef6122adb21cef1ac; // The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.getCompletedWorkItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-count-completed-work-items-v1 +Count completed work items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-count-completed-work-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | ID of the work item owner. | [optional] [default to undefined] + +### Return type + +**WorkitemscountV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const ownerId: string = ownerId_example; // ID of the work item owner. (optional) +const result = await apiInstance.getCountCompletedWorkItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-count-work-items-v1 +Count work items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-count-work-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | ID of the work item owner. | [optional] [default to undefined] + +### Return type + +**WorkitemscountV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const ownerId: string = ef38f94347e94562b5bb8424a56397d8; // ID of the work item owner. (optional) +const result = await apiInstance.getCountWorkItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-work-item-v1 +Get a work item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-work-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | ID of the work item. | [default to undefined] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = 2c9180835d191a86015d28455b4a2329; // ID of the work item. +const result = await apiInstance.getWorkItemV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-work-items-summary-v1 +Work items summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-work-items-summary-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ownerId** | **string** | ID of the work item owner. | [optional] [default to undefined] + +### Return type + +**WorkitemssummaryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const ownerId: string = 1211bcaa32112bcef6122adb21cef1ac; // ID of the work item owner. (optional) +const result = await apiInstance.getWorkItemsSummaryV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-work-items-v1 +List work items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-work-items-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**count** | **boolean** | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to false] +**ownerId** | **string** | ID of the work item owner. | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const ownerId: string = 1211bcaa32112bcef6122adb21cef1ac; // ID of the work item owner. (optional) +const result = await apiInstance.listWorkItemsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## reject-approval-item-v1 +Reject an approval item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-approval-item-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] +**approvalItemId** | **string** | The ID of the approval item. | [default to undefined] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const approvalItemId: string = 1211bcaa32112bcef6122adb21cef1ac; // The ID of the approval item. +const result = await apiInstance.rejectApprovalItemV1(id, approvalItemId); +console.log(result); +``` + +[[Back to top]](#) + +## reject-approval-items-in-bulk-v1 +Bulk reject approval items +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/reject-approval-items-in-bulk-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const result = await apiInstance.rejectApprovalItemsInBulkV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## submit-account-selection-v1 +Submit account selections +This API submits account selections. Either an admin, or the owning/current user must make this request. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/submit-account-selection-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The ID of the work item | [default to undefined] +**requestBody** | | Account Selection Data map, keyed on fieldName | + +### Return type + +**WorkitemsV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkItemsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkItemsV1Api(configuration); +const id: string = ef38f94347e94562b5bb8424a56397d8; // The ID of the work item +const requestBody: { [key: string]: any; } = {"fieldName":"fieldValue"}; // Account Selection Data map, keyed on fieldName +const result = await apiInstance.submitAccountSelectionV1(id, requestBody); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/work_items/docs/Models/Approvalitemdetails.md b/sdk-output/work_items/docs/Models/Approvalitemdetails.md new file mode 100644 index 00000000..cb35df6f --- /dev/null +++ b/sdk-output/work_items/docs/Models/Approvalitemdetails.md @@ -0,0 +1,25 @@ +--- +id: v1-approvalitemdetails-v1 +title: ApprovalitemdetailsV1 +pagination_label: ApprovalitemdetailsV1 +sidebar_label: ApprovalitemdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ApprovalitemdetailsV1', 'v1ApprovalitemdetailsV1'] +slug: /tools/sdk/typescript/work_items/models/approvalitemdetails-v1 +tags: ['SDK', 'Software Development Kit', 'ApprovalitemdetailsV1', 'v1ApprovalitemdetailsV1'] +--- + +# ApprovalitemdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The approval item\'s ID | [default to undefined] +**account** | **(optional)** **string** | The account referenced by the approval item | [default to undefined] +**application** | **(optional)** **string** | The name of the application/source | [default to undefined] +**name** | **(optional)** **string** | The attribute\'s name | [default to undefined] +**operation** | **(optional)** **string** | The attribute\'s operation | [default to undefined] +**value** | **(optional)** **string** | The attribute\'s value | [default to undefined] +**state** | **(optional)** **WorkitemstateV1** | | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Errormessagedto.md b/sdk-output/work_items/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..b1abd023 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/work_items/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Errorresponsedto.md b/sdk-output/work_items/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..79bda4e5 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/work_items/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Formdetails.md b/sdk-output/work_items/docs/Models/Formdetails.md new file mode 100644 index 00000000..aa001196 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Formdetails.md @@ -0,0 +1,24 @@ +--- +id: v1-formdetails-v1 +title: FormdetailsV1 +pagination_label: FormdetailsV1 +sidebar_label: FormdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormdetailsV1', 'v1FormdetailsV1'] +slug: /tools/sdk/typescript/work_items/models/formdetails-v1 +tags: ['SDK', 'Software Development Kit', 'FormdetailsV1', 'v1FormdetailsV1'] +--- + +# FormdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the form | [default to undefined] +**name** | **(optional)** **string** | Name of the form | [default to undefined] +**title** | **(optional)** **string** | The form title | [default to undefined] +**subtitle** | **(optional)** **string** | The form subtitle. | [default to undefined] +**targetUser** | **(optional)** **string** | The name of the user that should be shown this form | [default to undefined] +**sections** | **(optional)** **Array<SectiondetailsV1>** | Sections of the form | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Formitemdetails.md b/sdk-output/work_items/docs/Models/Formitemdetails.md new file mode 100644 index 00000000..da97e1c2 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Formitemdetails.md @@ -0,0 +1,19 @@ +--- +id: v1-formitemdetails-v1 +title: FormitemdetailsV1 +pagination_label: FormitemdetailsV1 +sidebar_label: FormitemdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'FormitemdetailsV1', 'v1FormitemdetailsV1'] +slug: /tools/sdk/typescript/work_items/models/formitemdetails-v1 +tags: ['SDK', 'Software Development Kit', 'FormitemdetailsV1', 'v1FormitemdetailsV1'] +--- + +# FormitemdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the FormItem | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Index.md b/sdk-output/work_items/docs/Models/Index.md new file mode 100644 index 00000000..e291433e --- /dev/null +++ b/sdk-output/work_items/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: work_items-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: work_items-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'work_items', 'models'] +slug: /tools/sdk/typescript/work_items/models +tags: ['SDK', 'Software Development Kit', 'work_items', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/work_items/docs/Models/ListWorkItemsV1401Response.md b/sdk-output/work_items/docs/Models/ListWorkItemsV1401Response.md new file mode 100644 index 00000000..493e49f4 --- /dev/null +++ b/sdk-output/work_items/docs/Models/ListWorkItemsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-work-items-v1401-response-v1 +title: ListWorkItemsV1401ResponseV1 +pagination_label: ListWorkItemsV1401ResponseV1 +sidebar_label: ListWorkItemsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkItemsV1401ResponseV1', 'v1ListWorkItemsV1401ResponseV1'] +slug: /tools/sdk/typescript/work_items/models/list-work-items-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkItemsV1401ResponseV1', 'v1ListWorkItemsV1401ResponseV1'] +--- + +# ListWorkItemsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/ListWorkItemsV1429Response.md b/sdk-output/work_items/docs/Models/ListWorkItemsV1429Response.md new file mode 100644 index 00000000..e855537b --- /dev/null +++ b/sdk-output/work_items/docs/Models/ListWorkItemsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-work-items-v1429-response-v1 +title: ListWorkItemsV1429ResponseV1 +pagination_label: ListWorkItemsV1429ResponseV1 +sidebar_label: ListWorkItemsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkItemsV1429ResponseV1', 'v1ListWorkItemsV1429ResponseV1'] +slug: /tools/sdk/typescript/work_items/models/list-work-items-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkItemsV1429ResponseV1', 'v1ListWorkItemsV1429ResponseV1'] +--- + +# ListWorkItemsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Localeorigin.md b/sdk-output/work_items/docs/Models/Localeorigin.md new file mode 100644 index 00000000..dff840a9 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/work_items/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/work_items/docs/Models/README.md b/sdk-output/work_items/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/work_items/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/work_items/docs/Models/Remediationitemdetails.md b/sdk-output/work_items/docs/Models/Remediationitemdetails.md new file mode 100644 index 00000000..5e971d22 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Remediationitemdetails.md @@ -0,0 +1,27 @@ +--- +id: v1-remediationitemdetails-v1 +title: RemediationitemdetailsV1 +pagination_label: RemediationitemdetailsV1 +sidebar_label: RemediationitemdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'RemediationitemdetailsV1', 'v1RemediationitemdetailsV1'] +slug: /tools/sdk/typescript/work_items/models/remediationitemdetails-v1 +tags: ['SDK', 'Software Development Kit', 'RemediationitemdetailsV1', 'v1RemediationitemdetailsV1'] +--- + +# RemediationitemdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the certification | [default to undefined] +**targetId** | **(optional)** **string** | The ID of the certification target | [default to undefined] +**targetName** | **(optional)** **string** | The name of the certification target | [default to undefined] +**targetDisplayName** | **(optional)** **string** | The display name of the certification target | [default to undefined] +**applicationName** | **(optional)** **string** | The name of the application/source | [default to undefined] +**attributeName** | **(optional)** **string** | The name of the attribute being certified | [default to undefined] +**attributeOperation** | **(optional)** **string** | The operation of the certification on the attribute | [default to undefined] +**attributeValue** | **(optional)** **string** | The value of the attribute being certified | [default to undefined] +**nativeIdentity** | **(optional)** **string** | The native identity of the target | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Sectiondetails.md b/sdk-output/work_items/docs/Models/Sectiondetails.md new file mode 100644 index 00000000..f93861d0 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Sectiondetails.md @@ -0,0 +1,21 @@ +--- +id: v1-sectiondetails-v1 +title: SectiondetailsV1 +pagination_label: SectiondetailsV1 +sidebar_label: SectiondetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'SectiondetailsV1', 'v1SectiondetailsV1'] +slug: /tools/sdk/typescript/work_items/models/sectiondetails-v1 +tags: ['SDK', 'Software Development Kit', 'SectiondetailsV1', 'v1SectiondetailsV1'] +--- + +# SectiondetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | Name of the FormItem | [default to undefined] +**label** | **(optional)** **string** | Label of the section | [default to undefined] +**formItems** | **(optional)** **Array<object>** | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Workitemforward.md b/sdk-output/work_items/docs/Models/Workitemforward.md new file mode 100644 index 00000000..b29243fc --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemforward.md @@ -0,0 +1,21 @@ +--- +id: v1-workitemforward-v1 +title: WorkitemforwardV1 +pagination_label: WorkitemforwardV1 +sidebar_label: WorkitemforwardV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemforwardV1', 'v1WorkitemforwardV1'] +slug: /tools/sdk/typescript/work_items/models/workitemforward-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemforwardV1', 'v1WorkitemforwardV1'] +--- + +# WorkitemforwardV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**targetOwnerId** | **string** | The ID of the identity to forward this work item to. | [default to undefined] +**comment** | **string** | Comments to send to the target owner | [default to undefined] +**sendNotifications** | **(optional)** **boolean** | If true, send a notification to the target owner. | [default to true] + diff --git a/sdk-output/work_items/docs/Models/Workitems.md b/sdk-output/work_items/docs/Models/Workitems.md new file mode 100644 index 00000000..bd1ff5c2 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitems.md @@ -0,0 +1,35 @@ +--- +id: v1-workitems-v1 +title: WorkitemsV1 +pagination_label: WorkitemsV1 +sidebar_label: WorkitemsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemsV1', 'v1WorkitemsV1'] +slug: /tools/sdk/typescript/work_items/models/workitems-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemsV1', 'v1WorkitemsV1'] +--- + +# WorkitemsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the work item | [default to undefined] +**requesterId** | **(optional)** **string** | ID of the requester | [default to undefined] +**requesterDisplayName** | **(optional)** **string** | The displayname of the requester | [default to undefined] +**ownerId** | **(optional)** **string** | The ID of the owner | [default to undefined] +**ownerName** | **(optional)** **string** | The name of the owner | [default to undefined] +**created** | **(optional)** **string** | Time when the work item was created | [default to undefined] +**modified** | **(optional)** **string** | Time when the work item was last updated | [default to undefined] +**description** | **(optional)** **string** | The description of the work item | [default to undefined] +**state** | **(optional)** **WorkitemstatemanualworkitemsV1** | | [default to undefined] +**type** | **(optional)** **WorkitemtypemanualworkitemsV1** | | [default to undefined] +**remediationItems** | **(optional)** **Array<RemediationitemdetailsV1>** | A list of remediation items | [default to undefined] +**approvalItems** | **(optional)** **Array<ApprovalitemdetailsV1>** | A list of items that need to be approved | [default to undefined] +**name** | **(optional)** **string** | The work item name | [default to undefined] +**completed** | **(optional)** **string** | The time at which the work item completed | [default to undefined] +**numItems** | **(optional)** **number** | The number of items in the work item | [default to undefined] +**form** | **(optional)** **WorkitemsFormV1** | | [default to undefined] +**errors** | **(optional)** **Array<string>** | An array of errors that ocurred during the work item | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/WorkitemsForm.md b/sdk-output/work_items/docs/Models/WorkitemsForm.md new file mode 100644 index 00000000..6c6dc977 --- /dev/null +++ b/sdk-output/work_items/docs/Models/WorkitemsForm.md @@ -0,0 +1,24 @@ +--- +id: v1-workitems-form-v1 +title: WorkitemsFormV1 +pagination_label: WorkitemsFormV1 +sidebar_label: WorkitemsFormV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemsFormV1', 'v1WorkitemsFormV1'] +slug: /tools/sdk/typescript/work_items/models/workitems-form-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemsFormV1', 'v1WorkitemsFormV1'] +--- + +# WorkitemsFormV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | ID of the form | [default to undefined] +**name** | **(optional)** **string** | Name of the form | [default to undefined] +**title** | **(optional)** **string** | The form title | [default to undefined] +**subtitle** | **(optional)** **string** | The form subtitle. | [default to undefined] +**targetUser** | **(optional)** **string** | The name of the user that should be shown this form | [default to undefined] +**sections** | **(optional)** **Array<SectiondetailsV1>** | Sections of the form | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Workitemscount.md b/sdk-output/work_items/docs/Models/Workitemscount.md new file mode 100644 index 00000000..0401bbdd --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemscount.md @@ -0,0 +1,19 @@ +--- +id: v1-workitemscount-v1 +title: WorkitemscountV1 +pagination_label: WorkitemscountV1 +sidebar_label: WorkitemscountV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemscountV1', 'v1WorkitemscountV1'] +slug: /tools/sdk/typescript/work_items/models/workitemscount-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemscountV1', 'v1WorkitemscountV1'] +--- + +# WorkitemscountV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **(optional)** **number** | The count of work items | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Workitemssummary.md b/sdk-output/work_items/docs/Models/Workitemssummary.md new file mode 100644 index 00000000..f8dad688 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemssummary.md @@ -0,0 +1,21 @@ +--- +id: v1-workitemssummary-v1 +title: WorkitemssummaryV1 +pagination_label: WorkitemssummaryV1 +sidebar_label: WorkitemssummaryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemssummaryV1', 'v1WorkitemssummaryV1'] +slug: /tools/sdk/typescript/work_items/models/workitemssummary-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemssummaryV1', 'v1WorkitemssummaryV1'] +--- + +# WorkitemssummaryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**open** | **(optional)** **number** | The count of open work items | [default to undefined] +**completed** | **(optional)** **number** | The count of completed work items | [default to undefined] +**total** | **(optional)** **number** | The count of total work items | [default to undefined] + diff --git a/sdk-output/work_items/docs/Models/Workitemstate.md b/sdk-output/work_items/docs/Models/Workitemstate.md new file mode 100644 index 00000000..2bef08f6 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemstate.md @@ -0,0 +1,29 @@ +--- +id: v1-workitemstate-v1 +title: WorkitemstateV1 +pagination_label: WorkitemstateV1 +sidebar_label: WorkitemstateV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemstateV1', 'v1WorkitemstateV1'] +slug: /tools/sdk/typescript/work_items/models/workitemstate-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemstateV1', 'v1WorkitemstateV1'] +--- + +# WorkitemstateV1 + +## Enum + + +* `Finished` (value: `'Finished'`) + +* `Rejected` (value: `'Rejected'`) + +* `Returned` (value: `'Returned'`) + +* `Expired` (value: `'Expired'`) + +* `Pending` (value: `'Pending'`) + +* `Canceled` (value: `'Canceled'`) + + diff --git a/sdk-output/work_items/docs/Models/Workitemstatemanualworkitems.md b/sdk-output/work_items/docs/Models/Workitemstatemanualworkitems.md new file mode 100644 index 00000000..8a2abe9a --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemstatemanualworkitems.md @@ -0,0 +1,29 @@ +--- +id: v1-workitemstatemanualworkitems-v1 +title: WorkitemstatemanualworkitemsV1 +pagination_label: WorkitemstatemanualworkitemsV1 +sidebar_label: WorkitemstatemanualworkitemsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemstatemanualworkitemsV1', 'v1WorkitemstatemanualworkitemsV1'] +slug: /tools/sdk/typescript/work_items/models/workitemstatemanualworkitems-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemstatemanualworkitemsV1', 'v1WorkitemstatemanualworkitemsV1'] +--- + +# WorkitemstatemanualworkitemsV1 + +## Enum + + +* `Finished` (value: `'Finished'`) + +* `Rejected` (value: `'Rejected'`) + +* `Returned` (value: `'Returned'`) + +* `Expired` (value: `'Expired'`) + +* `Pending` (value: `'Pending'`) + +* `Canceled` (value: `'Canceled'`) + + diff --git a/sdk-output/work_items/docs/Models/Workitemtypemanualworkitems.md b/sdk-output/work_items/docs/Models/Workitemtypemanualworkitems.md new file mode 100644 index 00000000..e2038373 --- /dev/null +++ b/sdk-output/work_items/docs/Models/Workitemtypemanualworkitems.md @@ -0,0 +1,45 @@ +--- +id: v1-workitemtypemanualworkitems-v1 +title: WorkitemtypemanualworkitemsV1 +pagination_label: WorkitemtypemanualworkitemsV1 +sidebar_label: WorkitemtypemanualworkitemsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkitemtypemanualworkitemsV1', 'v1WorkitemtypemanualworkitemsV1'] +slug: /tools/sdk/typescript/work_items/models/workitemtypemanualworkitems-v1 +tags: ['SDK', 'Software Development Kit', 'WorkitemtypemanualworkitemsV1', 'v1WorkitemtypemanualworkitemsV1'] +--- + +# WorkitemtypemanualworkitemsV1 + +## Enum + + +* `Generic` (value: `'Generic'`) + +* `Certification` (value: `'Certification'`) + +* `Remediation` (value: `'Remediation'`) + +* `Delegation` (value: `'Delegation'`) + +* `Approval` (value: `'Approval'`) + +* `ViolationReview` (value: `'ViolationReview'`) + +* `Form` (value: `'Form'`) + +* `PolicyVioloation` (value: `'PolicyVioloation'`) + +* `Challenge` (value: `'Challenge'`) + +* `ImpactAnalysis` (value: `'ImpactAnalysis'`) + +* `Signoff` (value: `'Signoff'`) + +* `Event` (value: `'Event'`) + +* `ManualAction` (value: `'ManualAction'`) + +* `Test` (value: `'Test'`) + + diff --git a/sdk-output/work_reassignment/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/work_reassignment/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..01e7133a --- /dev/null +++ b/sdk-output/work_reassignment/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,145 @@ +- path: /reassignment-configurations/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#create-reassignment-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const configurationitemrequestV1: ConfigurationitemrequestV1 = ; // ConfigurationitemrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.createReassignmentConfigurationV1(configurationitemrequestV1); + console.log(result); +- path: /reassignment-configurations/v1/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#delete-reassignment-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const identityId: string = '2c91808781a71ddb0181b9090b5c504e'; // string | unique identity id (default to undefined) + const configType: ConfigtypeenumV1 = ; // ConfigtypeenumV1 | (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.deleteReassignmentConfigurationV1(identityId, configType); + console.log(result); +- path: /reassignment-configurations/v1/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#get-evaluate-reassignment-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const identityId: string = '2c91808781a71ddb0181b9090b5c504e'; // string | unique identity id (default to undefined) + const configType: ConfigtypeenumV1 = accessRequests; // ConfigtypeenumV1 | Reassignment work type (default to undefined) + const exclusionFilters: Array<string> = SELF_REVIEW_DELEGATION; // Array | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getEvaluateReassignmentConfigurationV1(identityId, configType); + console.log(result); +- path: /reassignment-configurations/v1/types + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#get-reassignment-config-types-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getReassignmentConfigTypesV1(); + console.log(result); +- path: /reassignment-configurations/v1/{identityId} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#get-reassignment-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const identityId: string = '2c91808781a71ddb0181b9090b5c504f'; // string | unique identity id (default to undefined) + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getReassignmentConfigurationV1(identityId); + console.log(result); +- path: /reassignment-configurations/v1/tenant-config + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#get-tenant-config-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.getTenantConfigConfigurationV1(); + console.log(result); +- path: /reassignment-configurations/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#list-reassignment-configurations-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.listReassignmentConfigurationsV1(); + console.log(result); +- path: /reassignment-configurations/v1/{identityId} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#put-reassignment-config-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const identityId: string = '2c91808781a71ddb0181b9090b5c504e'; // string | unique identity id (default to undefined) + const configurationitemrequestV1: ConfigurationitemrequestV1 = ; // ConfigurationitemrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.putReassignmentConfigV1(identityId, configurationitemrequestV1); + console.log(result); +- path: /reassignment-configurations/v1/tenant-config + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/work_reassignment/methods/work-reassignment#put-tenant-configuration-v1 + source: | + import { WorkReassignmentV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkReassignmentV1Api(configuration); + const tenantconfigurationrequestV1: TenantconfigurationrequestV1 = ; // TenantconfigurationrequestV1 | + const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true') + const result = await apiInstance.putTenantConfigurationV1(tenantconfigurationrequestV1); + console.log(result); diff --git a/sdk-output/work_reassignment/docs/Methods/Index.md b/sdk-output/work_reassignment/docs/Methods/Index.md new file mode 100644 index 00000000..ed233380 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: work_reassignment-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: work_reassignment-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'work_reassignment', 'methods'] +slug: /tools/sdk/typescript/work_reassignment/methods +tags: ['SDK', 'Software Development Kit', 'work_reassignment', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/work_reassignment/docs/Methods/WorkReassignmentV1Api.md b/sdk-output/work_reassignment/docs/Methods/WorkReassignmentV1Api.md new file mode 100644 index 00000000..5afdec7b --- /dev/null +++ b/sdk-output/work_reassignment/docs/Methods/WorkReassignmentV1Api.md @@ -0,0 +1,427 @@ +--- +id: v1-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkReassignment', 'v1WorkReassignment'] +slug: /tools/sdk/typescript/work_reassignment/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'v1WorkReassignment'] +--- + +# WorkReassignmentV1Api + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user's behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create-reassignment-configuration-v1**](#create-reassignment-configuration-v1) | **POST** `/reassignment-configurations/v1` | Create a reassignment configuration +[**delete-reassignment-configuration-v1**](#delete-reassignment-configuration-v1) | **DELETE** `/reassignment-configurations/v1/{identityId}/{configType}` | Delete reassignment configuration +[**get-evaluate-reassignment-configuration-v1**](#get-evaluate-reassignment-configuration-v1) | **GET** `/reassignment-configurations/v1/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**get-reassignment-config-types-v1**](#get-reassignment-config-types-v1) | **GET** `/reassignment-configurations/v1/types` | List reassignment config types +[**get-reassignment-configuration-v1**](#get-reassignment-configuration-v1) | **GET** `/reassignment-configurations/v1/{identityId}` | Get reassignment configuration +[**get-tenant-config-configuration-v1**](#get-tenant-config-configuration-v1) | **GET** `/reassignment-configurations/v1/tenant-config` | Get tenant-wide reassignment configuration settings +[**list-reassignment-configurations-v1**](#list-reassignment-configurations-v1) | **GET** `/reassignment-configurations/v1` | List reassignment configurations +[**put-reassignment-config-v1**](#put-reassignment-config-v1) | **PUT** `/reassignment-configurations/v1/{identityId}` | Update reassignment configuration +[**put-tenant-configuration-v1**](#put-tenant-configuration-v1) | **PUT** `/reassignment-configurations/v1/tenant-config` | Update tenant-wide reassignment configuration settings + + +## create-reassignment-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Create a reassignment configuration +Creates a new Reassignment Configuration for the specified identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-reassignment-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**configurationitemrequestV1** | **ConfigurationitemrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ConfigurationitemresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const configurationitemrequestV1: ConfigurationitemrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.createReassignmentConfigurationV1(configurationitemrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-reassignment-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Delete reassignment configuration +Deletes a single reassignment configuration for the specified identity + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-reassignment-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | unique identity id | [default to undefined] +**configType** | **ConfigtypeenumV1** | | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const identityId: string = 2c91808781a71ddb0181b9090b5c504e; // unique identity id +const configType: ConfigtypeenumV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.deleteReassignmentConfigurationV1(identityId, configType); +console.log(result); +``` + +[[Back to top]](#) + +## get-evaluate-reassignment-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Evaluate reassignment configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-evaluate-reassignment-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | unique identity id | [default to undefined] +**configType** | **ConfigtypeenumV1** | Reassignment work type | [default to undefined] +**exclusionFilters** | **Array<string>** | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments | [optional] [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const identityId: string = 2c91808781a71ddb0181b9090b5c504e; // unique identity id +const configType: ConfigtypeenumV1 = accessRequests; // Reassignment work type +const exclusionFilters: Array<string> = SELF_REVIEW_DELEGATION; // Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getEvaluateReassignmentConfigurationV1(identityId, configType); +console.log(result); +``` + +[[Back to top]](#) + +## get-reassignment-config-types-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List reassignment config types +Gets a collection of types which are available in the Reassignment Configuration UI. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-reassignment-config-types-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getReassignmentConfigTypesV1(); +console.log(result); +``` + +[[Back to top]](#) + +## get-reassignment-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get reassignment configuration +Gets the Reassignment Configuration for an identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-reassignment-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | unique identity id | [default to undefined] +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ConfigurationresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const identityId: string = 2c91808781a71ddb0181b9090b5c504f; // unique identity id +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getReassignmentConfigurationV1(identityId); +console.log(result); +``` + +[[Back to top]](#) + +## get-tenant-config-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Get tenant-wide reassignment configuration settings +Gets the global Reassignment Configuration settings for the requestor's tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-tenant-config-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TenantconfigurationresponseV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.getTenantConfigConfigurationV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-reassignment-configurations-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +List reassignment configurations +Gets all Reassignment configuration for the current org. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-reassignment-configurations-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.listReassignmentConfigurationsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## put-reassignment-config-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update reassignment configuration +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-reassignment-config-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**identityId** | **string** | unique identity id | [default to undefined] +**configurationitemrequestV1** | **ConfigurationitemrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**ConfigurationitemresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const identityId: string = 2c91808781a71ddb0181b9090b5c504e; // unique identity id +const configurationitemrequestV1: ConfigurationitemrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.putReassignmentConfigV1(identityId, configurationitemrequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-tenant-configuration-v1 +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Update tenant-wide reassignment configuration settings +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-tenant-configuration-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**tenantconfigurationrequestV1** | **TenantconfigurationrequestV1** | | +**xSailPointExperimental** | **string** | Use this header to enable this experimental API. | [optional] [default to 'true'] + +### Return type + +**TenantconfigurationresponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkReassignmentV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkReassignmentV1Api(configuration); +const tenantconfigurationrequestV1: TenantconfigurationrequestV1 = ; // +const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional) +const result = await apiInstance.putTenantConfigurationV1(tenantconfigurationrequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/work_reassignment/docs/Models/Auditdetails.md b/sdk-output/work_reassignment/docs/Models/Auditdetails.md new file mode 100644 index 00000000..99885741 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Auditdetails.md @@ -0,0 +1,22 @@ +--- +id: v1-auditdetails-v1 +title: AuditdetailsV1 +pagination_label: AuditdetailsV1 +sidebar_label: AuditdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'AuditdetailsV1', 'v1AuditdetailsV1'] +slug: /tools/sdk/typescript/work_reassignment/models/auditdetails-v1 +tags: ['SDK', 'Software Development Kit', 'AuditdetailsV1', 'v1AuditdetailsV1'] +--- + +# AuditdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created** | **(optional)** **string** | Initial date and time when the record was created | [default to undefined] +**createdBy** | **(optional)** **Identity2V1** | | [default to undefined] +**modified** | **(optional)** **string** | Last modified date and time for the record | [default to undefined] +**modifiedBy** | **(optional)** **Identity2V1** | | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Configtype.md b/sdk-output/work_reassignment/docs/Models/Configtype.md new file mode 100644 index 00000000..afef21db --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configtype.md @@ -0,0 +1,23 @@ +--- +id: v1-configtype-v1 +title: ConfigtypeV1 +pagination_label: ConfigtypeV1 +sidebar_label: ConfigtypeV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigtypeV1', 'v1ConfigtypeV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configtype-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigtypeV1', 'v1ConfigtypeV1'] +--- + +# ConfigtypeV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**priority** | **(optional)** **number** | | [default to undefined] +**internalName** | **(optional)** **ConfigtypeenumcamelV1** | | [default to undefined] +**internalNameCamel** | **(optional)** **ConfigtypeenumV1** | | [default to undefined] +**displayName** | **(optional)** **string** | Human readable display name of the type to be shown on UI | [default to undefined] +**description** | **(optional)** **string** | Description of the type of work to be reassigned, displayed by the UI. | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Configtypeenum.md b/sdk-output/work_reassignment/docs/Models/Configtypeenum.md new file mode 100644 index 00000000..63e1960a --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configtypeenum.md @@ -0,0 +1,25 @@ +--- +id: v1-configtypeenum-v1 +title: ConfigtypeenumV1 +pagination_label: ConfigtypeenumV1 +sidebar_label: ConfigtypeenumV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigtypeenumV1', 'v1ConfigtypeenumV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configtypeenum-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigtypeenumV1', 'v1ConfigtypeenumV1'] +--- + +# ConfigtypeenumV1 + +## Enum + + +* `AccessRequests` (value: `'ACCESS_REQUESTS'`) + +* `Certifications` (value: `'CERTIFICATIONS'`) + +* `ManualTasks` (value: `'MANUAL_TASKS'`) + +* `GenericApprovals` (value: `'GENERIC_APPROVALS'`) + + diff --git a/sdk-output/work_reassignment/docs/Models/Configtypeenumcamel.md b/sdk-output/work_reassignment/docs/Models/Configtypeenumcamel.md new file mode 100644 index 00000000..373dab46 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configtypeenumcamel.md @@ -0,0 +1,23 @@ +--- +id: v1-configtypeenumcamel-v1 +title: ConfigtypeenumcamelV1 +pagination_label: ConfigtypeenumcamelV1 +sidebar_label: ConfigtypeenumcamelV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigtypeenumcamelV1', 'v1ConfigtypeenumcamelV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configtypeenumcamel-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigtypeenumcamelV1', 'v1ConfigtypeenumcamelV1'] +--- + +# ConfigtypeenumcamelV1 + +## Enum + + +* `AccessRequests` (value: `'accessRequests'`) + +* `Certifications` (value: `'certifications'`) + +* `ManualTasks` (value: `'manualTasks'`) + + diff --git a/sdk-output/work_reassignment/docs/Models/Configurationdetailsresponse.md b/sdk-output/work_reassignment/docs/Models/Configurationdetailsresponse.md new file mode 100644 index 00000000..06354b48 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configurationdetailsresponse.md @@ -0,0 +1,23 @@ +--- +id: v1-configurationdetailsresponse-v1 +title: ConfigurationdetailsresponseV1 +pagination_label: ConfigurationdetailsresponseV1 +sidebar_label: ConfigurationdetailsresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigurationdetailsresponseV1', 'v1ConfigurationdetailsresponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configurationdetailsresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigurationdetailsresponseV1', 'v1ConfigurationdetailsresponseV1'] +--- + +# ConfigurationdetailsresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configType** | **(optional)** **ConfigtypeenumV1** | | [default to undefined] +**targetIdentity** | **(optional)** **Identity2V1** | | [default to undefined] +**startDate** | **(optional)** **string** | The date from which to start reassigning work items | [default to undefined] +**endDate** | **(optional)** **string** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [default to undefined] +**auditDetails** | **(optional)** **AuditdetailsV1** | | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Configurationitemrequest.md b/sdk-output/work_reassignment/docs/Models/Configurationitemrequest.md new file mode 100644 index 00000000..b1c38588 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configurationitemrequest.md @@ -0,0 +1,23 @@ +--- +id: v1-configurationitemrequest-v1 +title: ConfigurationitemrequestV1 +pagination_label: ConfigurationitemrequestV1 +sidebar_label: ConfigurationitemrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigurationitemrequestV1', 'v1ConfigurationitemrequestV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configurationitemrequest-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigurationitemrequestV1', 'v1ConfigurationitemrequestV1'] +--- + +# ConfigurationitemrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassignedFromId** | **(optional)** **string** | The identity id to reassign an item from | [default to undefined] +**reassignedToId** | **(optional)** **string** | The identity id to reassign an item to | [default to undefined] +**configType** | **(optional)** **ConfigtypeenumV1** | | [default to undefined] +**startDate** | **(optional)** **string** | The date from which to start reassigning work items | [default to undefined] +**endDate** | **(optional)** **string** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Configurationitemresponse.md b/sdk-output/work_reassignment/docs/Models/Configurationitemresponse.md new file mode 100644 index 00000000..83eb9175 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configurationitemresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-configurationitemresponse-v1 +title: ConfigurationitemresponseV1 +pagination_label: ConfigurationitemresponseV1 +sidebar_label: ConfigurationitemresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigurationitemresponseV1', 'v1ConfigurationitemresponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configurationitemresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigurationitemresponseV1', 'v1ConfigurationitemresponseV1'] +--- + +# ConfigurationitemresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **(optional)** **Identity2V1** | | [default to undefined] +**configDetails** | **(optional)** **Array<ConfigurationdetailsresponseV1>** | Details of how work should be reassigned for an Identity | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Configurationresponse.md b/sdk-output/work_reassignment/docs/Models/Configurationresponse.md new file mode 100644 index 00000000..f4dd98de --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Configurationresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-configurationresponse-v1 +title: ConfigurationresponseV1 +pagination_label: ConfigurationresponseV1 +sidebar_label: ConfigurationresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ConfigurationresponseV1', 'v1ConfigurationresponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/configurationresponse-v1 +tags: ['SDK', 'Software Development Kit', 'ConfigurationresponseV1', 'v1ConfigurationresponseV1'] +--- + +# ConfigurationresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity** | **(optional)** **Identity2V1** | | [default to undefined] +**configDetails** | **(optional)** **Array<ConfigurationdetailsresponseV1>** | Details of how work should be reassigned for an Identity | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Errormessagedto.md b/sdk-output/work_reassignment/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..30c6c040 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/work_reassignment/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Errorresponsedto.md b/sdk-output/work_reassignment/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..744be25e --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/work_reassignment/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Evaluateresponse.md b/sdk-output/work_reassignment/docs/Models/Evaluateresponse.md new file mode 100644 index 00000000..eb71f0f0 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Evaluateresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-evaluateresponse-v1 +title: EvaluateresponseV1 +pagination_label: EvaluateresponseV1 +sidebar_label: EvaluateresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'EvaluateresponseV1', 'v1EvaluateresponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/evaluateresponse-v1 +tags: ['SDK', 'Software Development Kit', 'EvaluateresponseV1', 'v1EvaluateresponseV1'] +--- + +# EvaluateresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassignToId** | **(optional)** **string** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [default to undefined] +**lookupTrail** | **(optional)** **Array<LookupstepV1>** | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1401Response.md b/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1401Response.md new file mode 100644 index 00000000..498ba991 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-reassignment-config-types-v1401-response-v1 +title: GetReassignmentConfigTypesV1401ResponseV1 +pagination_label: GetReassignmentConfigTypesV1401ResponseV1 +sidebar_label: GetReassignmentConfigTypesV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetReassignmentConfigTypesV1401ResponseV1', 'v1GetReassignmentConfigTypesV1401ResponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/get-reassignment-config-types-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetReassignmentConfigTypesV1401ResponseV1', 'v1GetReassignmentConfigTypesV1401ResponseV1'] +--- + +# GetReassignmentConfigTypesV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1429Response.md b/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1429Response.md new file mode 100644 index 00000000..73fbfac4 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/GetReassignmentConfigTypesV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-get-reassignment-config-types-v1429-response-v1 +title: GetReassignmentConfigTypesV1429ResponseV1 +pagination_label: GetReassignmentConfigTypesV1429ResponseV1 +sidebar_label: GetReassignmentConfigTypesV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'GetReassignmentConfigTypesV1429ResponseV1', 'v1GetReassignmentConfigTypesV1429ResponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/get-reassignment-config-types-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'GetReassignmentConfigTypesV1429ResponseV1', 'v1GetReassignmentConfigTypesV1429ResponseV1'] +--- + +# GetReassignmentConfigTypesV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Identity2.md b/sdk-output/work_reassignment/docs/Models/Identity2.md new file mode 100644 index 00000000..ee881584 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Identity2.md @@ -0,0 +1,20 @@ +--- +id: v1-identity2-v1 +title: Identity2V1 +pagination_label: Identity2V1 +sidebar_label: Identity2V1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Identity2V1', 'v1Identity2V1'] +slug: /tools/sdk/typescript/work_reassignment/models/identity2-v1 +tags: ['SDK', 'Software Development Kit', 'Identity2V1', 'v1Identity2V1'] +--- + +# Identity2V1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | The ID of the object | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of the object | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Index.md b/sdk-output/work_reassignment/docs/Models/Index.md new file mode 100644 index 00000000..9350327a --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: work_reassignment-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: work_reassignment-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'work_reassignment', 'models'] +slug: /tools/sdk/typescript/work_reassignment/models +tags: ['SDK', 'Software Development Kit', 'work_reassignment', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/work_reassignment/docs/Models/Localeorigin.md b/sdk-output/work_reassignment/docs/Models/Localeorigin.md new file mode 100644 index 00000000..b81fb3a1 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/work_reassignment/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/work_reassignment/docs/Models/Lookupstep.md b/sdk-output/work_reassignment/docs/Models/Lookupstep.md new file mode 100644 index 00000000..66a24c98 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Lookupstep.md @@ -0,0 +1,21 @@ +--- +id: v1-lookupstep-v1 +title: LookupstepV1 +pagination_label: LookupstepV1 +sidebar_label: LookupstepV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LookupstepV1', 'v1LookupstepV1'] +slug: /tools/sdk/typescript/work_reassignment/models/lookupstep-v1 +tags: ['SDK', 'Software Development Kit', 'LookupstepV1', 'v1LookupstepV1'] +--- + +# LookupstepV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**reassignedToId** | **(optional)** **string** | The ID of the Identity who work is reassigned to | [default to undefined] +**reassignedFromId** | **(optional)** **string** | The ID of the Identity who work is reassigned from | [default to undefined] +**reassignmentType** | **(optional)** **ReassignmenttypeenumV1** | | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/README.md b/sdk-output/work_reassignment/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/work_reassignment/docs/Models/Reassignmenttypeenum.md b/sdk-output/work_reassignment/docs/Models/Reassignmenttypeenum.md new file mode 100644 index 00000000..ff8af5be --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Reassignmenttypeenum.md @@ -0,0 +1,25 @@ +--- +id: v1-reassignmenttypeenum-v1 +title: ReassignmenttypeenumV1 +pagination_label: ReassignmenttypeenumV1 +sidebar_label: ReassignmenttypeenumV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ReassignmenttypeenumV1', 'v1ReassignmenttypeenumV1'] +slug: /tools/sdk/typescript/work_reassignment/models/reassignmenttypeenum-v1 +tags: ['SDK', 'Software Development Kit', 'ReassignmenttypeenumV1', 'v1ReassignmenttypeenumV1'] +--- + +# ReassignmenttypeenumV1 + +## Enum + + +* `ManualReassignment` (value: `'MANUAL_REASSIGNMENT,'`) + +* `AutomaticReassignment` (value: `'AUTOMATIC_REASSIGNMENT,'`) + +* `AutoEscalation` (value: `'AUTO_ESCALATION,'`) + +* `SelfReviewDelegation` (value: `'SELF_REVIEW_DELEGATION'`) + + diff --git a/sdk-output/work_reassignment/docs/Models/Tenantconfigurationdetails.md b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationdetails.md new file mode 100644 index 00000000..5d8dde10 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationdetails.md @@ -0,0 +1,19 @@ +--- +id: v1-tenantconfigurationdetails-v1 +title: TenantconfigurationdetailsV1 +pagination_label: TenantconfigurationdetailsV1 +sidebar_label: TenantconfigurationdetailsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantconfigurationdetailsV1', 'v1TenantconfigurationdetailsV1'] +slug: /tools/sdk/typescript/work_reassignment/models/tenantconfigurationdetails-v1 +tags: ['SDK', 'Software Development Kit', 'TenantconfigurationdetailsV1', 'v1TenantconfigurationdetailsV1'] +--- + +# TenantconfigurationdetailsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**disabled** | **(optional)** **boolean** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [default to false] + diff --git a/sdk-output/work_reassignment/docs/Models/Tenantconfigurationrequest.md b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationrequest.md new file mode 100644 index 00000000..dd5d0eb7 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationrequest.md @@ -0,0 +1,19 @@ +--- +id: v1-tenantconfigurationrequest-v1 +title: TenantconfigurationrequestV1 +pagination_label: TenantconfigurationrequestV1 +sidebar_label: TenantconfigurationrequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantconfigurationrequestV1', 'v1TenantconfigurationrequestV1'] +slug: /tools/sdk/typescript/work_reassignment/models/tenantconfigurationrequest-v1 +tags: ['SDK', 'Software Development Kit', 'TenantconfigurationrequestV1', 'v1TenantconfigurationrequestV1'] +--- + +# TenantconfigurationrequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**configDetails** | **(optional)** **TenantconfigurationdetailsV1** | | [default to undefined] + diff --git a/sdk-output/work_reassignment/docs/Models/Tenantconfigurationresponse.md b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationresponse.md new file mode 100644 index 00000000..86557167 --- /dev/null +++ b/sdk-output/work_reassignment/docs/Models/Tenantconfigurationresponse.md @@ -0,0 +1,20 @@ +--- +id: v1-tenantconfigurationresponse-v1 +title: TenantconfigurationresponseV1 +pagination_label: TenantconfigurationresponseV1 +sidebar_label: TenantconfigurationresponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TenantconfigurationresponseV1', 'v1TenantconfigurationresponseV1'] +slug: /tools/sdk/typescript/work_reassignment/models/tenantconfigurationresponse-v1 +tags: ['SDK', 'Software Development Kit', 'TenantconfigurationresponseV1', 'v1TenantconfigurationresponseV1'] +--- + +# TenantconfigurationresponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**auditDetails** | **(optional)** **AuditdetailsV1** | | [default to undefined] +**configDetails** | **(optional)** **TenantconfigurationdetailsV1** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Examples/typescript_code_examples_overlay.yaml b/sdk-output/workflows/docs/Examples/typescript_code_examples_overlay.yaml new file mode 100644 index 00000000..15e57916 --- /dev/null +++ b/sdk-output/workflows/docs/Examples/typescript_code_examples_overlay.yaml @@ -0,0 +1,296 @@ +- path: /workflow-executions/v1/{id}/cancel + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#cancel-workflow-execution-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | The workflow execution ID (default to undefined) + const result = await apiInstance.cancelWorkflowExecutionV1(id); + console.log(result); +- path: /workflows/v1/execute/external/{id} + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#create-external-execute-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow (default to undefined) + const createExternalExecuteWorkflowV1RequestV1: CreateExternalExecuteWorkflowV1RequestV1 = ; // CreateExternalExecuteWorkflowV1RequestV1 | (optional) + const result = await apiInstance.createExternalExecuteWorkflowV1(id); + console.log(result); +- path: /workflows/v1/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#create-workflow-external-trigger-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow (default to undefined) + const result = await apiInstance.createWorkflowExternalTriggerV1(id); + console.log(result); +- path: /workflows/v1 + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#create-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const createWorkflowV1RequestV1: CreateWorkflowV1RequestV1 = {"name":"Send Email","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"description":"Send an email to the identity who's attributes changed.","definition":{"start":"Send Email Test","steps":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"action"},"success":{"type":"success"}}},"enabled":false,"trigger":{"type":"EVENT","attributes":{"id":"idn:identity-attributes-changed","filter":"$.changes[?(@.attribute == 'manager')]"}}}; // CreateWorkflowV1RequestV1 | + const result = await apiInstance.createWorkflowV1(createWorkflowV1RequestV1); + console.log(result); +- path: /workflows/v1/{id} + method: DELETE + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#delete-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the Workflow (default to undefined) + const result = await apiInstance.deleteWorkflowV1(id); + console.log(result); +- path: /workflow-executions/v1/{id}/history + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#get-workflow-execution-history-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow execution (default to undefined) + const result = await apiInstance.getWorkflowExecutionHistoryV1(id); + console.log(result); +- path: /workflow-executions/v1/{id}/history-v2 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#get-workflow-execution-history-v2 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow execution (default to undefined) + const result = await apiInstance.getWorkflowExecutionHistoryV2(id); + console.log(result); +- path: /workflow-executions/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#get-workflow-execution-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Workflow execution ID. (default to undefined) + const result = await apiInstance.getWorkflowExecutionV1(id); + console.log(result); +- path: /workflows/v1/{id}/executions + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#get-workflow-executions-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Workflow ID. (default to undefined) + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'status eq "Failed"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) (default to undefined) + const result = await apiInstance.getWorkflowExecutionsV1(id); + console.log(result); +- path: /workflows/v1/{id} + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#get-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow (default to undefined) + const result = await apiInstance.getWorkflowV1(id); + console.log(result); +- path: /workflow-library/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#list-complete-workflow-library-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const result = await apiInstance.listCompleteWorkflowLibraryV1(); + console.log(result); +- path: /workflow-library/v1/actions + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#list-workflow-library-actions-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'id eq "sp:create-campaign"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) (default to undefined) + const result = await apiInstance.listWorkflowLibraryActionsV1(); + console.log(result); +- path: /workflow-library/v1/operators + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#list-workflow-library-operators-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const result = await apiInstance.listWorkflowLibraryOperatorsV1(); + console.log(result); +- path: /workflow-library/v1/triggers + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#list-workflow-library-triggers-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const limit: number = 250; // number | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + const offset: number = 0; // number | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + const filters: string = 'id eq "idn:identity-attributes-changed"'; // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **type**: *eq* (optional) (default to undefined) + const result = await apiInstance.listWorkflowLibraryTriggersV1(); + console.log(result); +- path: /workflows/v1 + method: GET + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#list-workflows-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const result = await apiInstance.listWorkflowsV1(); + console.log(result); +- path: /workflows/v1/{id} + method: PATCH + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#patch-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the Workflow (default to undefined) + const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"Send Email"},{"op":"replace","path":"/owner","value":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},{"op":"replace","path":"/description","value":"Send an email to the identity who's attributes changed."},{"op":"replace","path":"/enabled","value":false},{"op":"replace","path":"/definition","value":{"start":"Send Email Test","steps":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"action"},"success":{"type":"success"}}}},{"op":"replace","path":"/trigger","value":{"type":"EVENT","attributes":{"id":"idn:identity-attributes-changed"}}}]; // Array | + const result = await apiInstance.patchWorkflowV1(id, jsonpatchoperationV1); + console.log(result); +- path: /workflows/v1/{id} + method: PUT + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#put-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the Workflow (default to undefined) + const workflowbodyV1: WorkflowbodyV1 = ; // WorkflowbodyV1 | + const result = await apiInstance.putWorkflowV1(id, workflowbodyV1); + console.log(result); +- path: /workflows/v1/execute/external/{id}/test + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#test-external-execute-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow (default to undefined) + const testExternalExecuteWorkflowV1RequestV1: TestExternalExecuteWorkflowV1RequestV1 = ; // TestExternalExecuteWorkflowV1RequestV1 | (optional) + const result = await apiInstance.testExternalExecuteWorkflowV1(id); + console.log(result); +- path: /workflows/v1/{id}/test + method: POST + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/workflows/methods/workflows#test-workflow-v1 + source: | + import { WorkflowsV1Api } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new WorkflowsV1Api(configuration); + const id: string = 'c17bea3a-574d-453c-9e04-4365fbf5af0b'; // string | Id of the workflow (default to undefined) + const testWorkflowV1RequestV1: TestWorkflowV1RequestV1 = {"input":{"identity":{"id":"ee769173319b41d19ccec6cea52f237b","name":"john.doe","type":"IDENTITY"},"changes":[{"attribute":"department","oldValue":"sales","newValue":"marketing"},{"attribute":"manager","oldValue":{"id":"ee769173319b41d19ccec6c235423237b","name":"nice.guy","type":"IDENTITY"},"newValue":{"id":"ee769173319b41d19ccec6c235423236c","name":"mean.guy","type":"IDENTITY"}},{"attribute":"email","oldValue":"john.doe@hotmail.com","newValue":"john.doe@gmail.com"}]}}; // TestWorkflowV1RequestV1 | + const result = await apiInstance.testWorkflowV1(id, testWorkflowV1RequestV1); + console.log(result); diff --git a/sdk-output/workflows/docs/Methods/Index.md b/sdk-output/workflows/docs/Methods/Index.md new file mode 100644 index 00000000..678a2792 --- /dev/null +++ b/sdk-output/workflows/docs/Methods/Index.md @@ -0,0 +1,30 @@ +--- +id: workflows-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: workflows-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', 'workflows', 'methods'] +slug: /tools/sdk/typescript/workflows/methods +tags: ['SDK', 'Software Development Kit', 'workflows', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **V1** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-output/workflows/docs/Methods/WorkflowsV1Api.md b/sdk-output/workflows/docs/Methods/WorkflowsV1Api.md new file mode 100644 index 00000000..42d367a1 --- /dev/null +++ b/sdk-output/workflows/docs/Methods/WorkflowsV1Api.md @@ -0,0 +1,800 @@ +--- +id: v1-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'Workflows', 'v1Workflows'] +slug: /tools/sdk/typescript/workflows/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'v1Workflows'] +--- + +# WorkflowsV1Api + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + +All URIs are relative to *https://sailpoint.api.identitynow.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel-workflow-execution-v1**](#cancel-workflow-execution-v1) | **POST** `/workflow-executions/v1/{id}/cancel` | Cancel workflow execution by id +[**create-external-execute-workflow-v1**](#create-external-execute-workflow-v1) | **POST** `/workflows/v1/execute/external/{id}` | Execute workflow via external trigger +[**create-workflow-external-trigger-v1**](#create-workflow-external-trigger-v1) | **POST** `/workflows/v1/{id}/external/oauth-clients` | Generate external trigger oauth client +[**create-workflow-v1**](#create-workflow-v1) | **POST** `/workflows/v1` | Create workflow +[**delete-workflow-v1**](#delete-workflow-v1) | **DELETE** `/workflows/v1/{id}` | Delete workflow by id +[**get-workflow-execution-history-v1**](#get-workflow-execution-history-v1) | **GET** `/workflow-executions/v1/{id}/history` | Get workflow execution history +[**get-workflow-execution-history-v2**](#get-workflow-execution-history-v2) | **GET** `/workflow-executions/v1/{id}/history-v2` | Get updated workflow execution history +[**get-workflow-execution-v1**](#get-workflow-execution-v1) | **GET** `/workflow-executions/v1/{id}` | Get workflow execution +[**get-workflow-executions-v1**](#get-workflow-executions-v1) | **GET** `/workflows/v1/{id}/executions` | List workflow executions +[**get-workflow-v1**](#get-workflow-v1) | **GET** `/workflows/v1/{id}` | Get workflow by id +[**list-complete-workflow-library-v1**](#list-complete-workflow-library-v1) | **GET** `/workflow-library/v1` | List complete workflow library +[**list-workflow-library-actions-v1**](#list-workflow-library-actions-v1) | **GET** `/workflow-library/v1/actions` | List workflow library actions +[**list-workflow-library-operators-v1**](#list-workflow-library-operators-v1) | **GET** `/workflow-library/v1/operators` | List workflow library operators +[**list-workflow-library-triggers-v1**](#list-workflow-library-triggers-v1) | **GET** `/workflow-library/v1/triggers` | List workflow library triggers +[**list-workflows-v1**](#list-workflows-v1) | **GET** `/workflows/v1` | List workflows +[**patch-workflow-v1**](#patch-workflow-v1) | **PATCH** `/workflows/v1/{id}` | Patch workflow +[**put-workflow-v1**](#put-workflow-v1) | **PUT** `/workflows/v1/{id}` | Update workflow +[**test-external-execute-workflow-v1**](#test-external-execute-workflow-v1) | **POST** `/workflows/v1/execute/external/{id}/test` | Test workflow via external trigger +[**test-workflow-v1**](#test-workflow-v1) | **POST** `/workflows/v1/{id}/test` | Test workflow by id + + +## cancel-workflow-execution-v1 +Cancel workflow execution by id +Use this API to cancel a running workflow execution. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/cancel-workflow-execution-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | The workflow execution ID | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // The workflow execution ID +const result = await apiInstance.cancelWorkflowExecutionV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## create-external-execute-workflow-v1 +Execute workflow via external trigger +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-external-execute-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow | [default to undefined] +**createExternalExecuteWorkflowV1RequestV1** | **CreateExternalExecuteWorkflowV1RequestV1** | | [optional] + +### Return type + +**CreateExternalExecuteWorkflowV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow +const createExternalExecuteWorkflowV1RequestV1: CreateExternalExecuteWorkflowV1RequestV1 = ; // (optional) +const result = await apiInstance.createExternalExecuteWorkflowV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## create-workflow-external-trigger-v1 +Generate external trigger oauth client +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-workflow-external-trigger-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow | [default to undefined] + +### Return type + +**WorkflowoauthclientV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow +const result = await apiInstance.createWorkflowExternalTriggerV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## create-workflow-v1 +Create workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/create-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**createWorkflowV1RequestV1** | **CreateWorkflowV1RequestV1** | | + +### Return type + +**WorkflowV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const createWorkflowV1RequestV1: CreateWorkflowV1RequestV1 = {"name":"Send Email","owner":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"},"description":"Send an email to the identity who's attributes changed.","definition":{"start":"Send Email Test","steps":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"action"},"success":{"type":"success"}}},"enabled":false,"trigger":{"type":"EVENT","attributes":{"id":"idn:identity-attributes-changed","filter":"$.changes[?(@.attribute == 'manager')]"}}}; // +const result = await apiInstance.createWorkflowV1(createWorkflowV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + +## delete-workflow-v1 +Delete workflow by id +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/delete-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the Workflow | [default to undefined] + +### Return type + +(empty response body) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the Workflow +const result = await apiInstance.deleteWorkflowV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-workflow-execution-history-v1 +Get workflow execution history +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workflow-execution-history-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow execution | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow execution +const result = await apiInstance.getWorkflowExecutionHistoryV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-workflow-execution-history-v2 +Get updated workflow execution history +Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workflow-execution-history-v2) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow execution | [default to undefined] + +### Return type + +**WorkflowexecutionhistoryV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow execution +const result = await apiInstance.getWorkflowExecutionHistoryV2(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-workflow-execution-v1 +Get workflow execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workflow-execution-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Workflow execution ID. | [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Workflow execution ID. +const result = await apiInstance.getWorkflowExecutionV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-workflow-executions-v1 +List workflow executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workflow-executions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Workflow ID. | [default to undefined] +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Workflow ID. +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = status eq "Failed"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) +const result = await apiInstance.getWorkflowExecutionsV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## get-workflow-v1 +Get workflow by id +Get a single workflow by id. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/get-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow | [default to undefined] + +### Return type + +**WorkflowV1** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow +const result = await apiInstance.getWorkflowV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## list-complete-workflow-library-v1 +List complete workflow library +This lists all triggers, actions, and operators in the library + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-complete-workflow-library-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const result = await apiInstance.listCompleteWorkflowLibraryV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-workflow-library-actions-v1 +List workflow library actions +This lists the workflow actions available to you. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workflow-library-actions-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "sp:create-campaign"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) +const result = await apiInstance.listWorkflowLibraryActionsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-workflow-library-operators-v1 +List workflow library operators +This lists the workflow operators available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workflow-library-operators-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const result = await apiInstance.listWorkflowLibraryOperatorsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-workflow-library-triggers-v1 +List workflow library triggers +This lists the workflow triggers available to you + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workflow-library-triggers-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**limit** | **number** | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 250] +**offset** | **number** | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. | [optional] [default to 0] +**filters** | **string** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **type**: *eq* | [optional] [default to undefined] + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) +const filters: string = id eq "idn:identity-attributes-changed"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **type**: *eq* (optional) +const result = await apiInstance.listWorkflowLibraryTriggersV1(); +console.log(result); +``` + +[[Back to top]](#) + +## list-workflows-v1 +List workflows +List all workflows in the tenant. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/list-workflows-v1) + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Array** + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const result = await apiInstance.listWorkflowsV1(); +console.log(result); +``` + +[[Back to top]](#) + +## patch-workflow-v1 +Patch workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/patch-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the Workflow | [default to undefined] +**jsonpatchoperationV1** | **Array<JsonpatchoperationV1>** | | + +### Return type + +**WorkflowV1** + +### HTTP request headers + +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the Workflow +const jsonpatchoperationV1: Array<JsonpatchoperationV1> = [{"op":"replace","path":"/name","value":"Send Email"},{"op":"replace","path":"/owner","value":{"type":"IDENTITY","id":"2c91808568c529c60168cca6f90c1313","name":"William Wilson"}},{"op":"replace","path":"/description","value":"Send an email to the identity who's attributes changed."},{"op":"replace","path":"/enabled","value":false},{"op":"replace","path":"/definition","value":{"start":"Send Email Test","steps":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"action"},"success":{"type":"success"}}}},{"op":"replace","path":"/trigger","value":{"type":"EVENT","attributes":{"id":"idn:identity-attributes-changed"}}}]; // +const result = await apiInstance.patchWorkflowV1(id, jsonpatchoperationV1); +console.log(result); +``` + +[[Back to top]](#) + +## put-workflow-v1 +Update workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/put-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the Workflow | [default to undefined] +**workflowbodyV1** | **WorkflowbodyV1** | | + +### Return type + +**WorkflowV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the Workflow +const workflowbodyV1: WorkflowbodyV1 = ; // +const result = await apiInstance.putWorkflowV1(id, workflowbodyV1); +console.log(result); +``` + +[[Back to top]](#) + +## test-external-execute-workflow-v1 +Test workflow via external trigger +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-external-execute-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow | [default to undefined] +**testExternalExecuteWorkflowV1RequestV1** | **TestExternalExecuteWorkflowV1RequestV1** | | [optional] + +### Return type + +**TestExternalExecuteWorkflowV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow +const testExternalExecuteWorkflowV1RequestV1: TestExternalExecuteWorkflowV1RequestV1 = ; // (optional) +const result = await apiInstance.testExternalExecuteWorkflowV1(id); +console.log(result); +``` + +[[Back to top]](#) + +## test-workflow-v1 +Test workflow by id +:::info + +Workflow must be disabled in order to use this endpoint. + +::: + +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/docs/extensibility/event-triggers/available) for an example input for the trigger that initiates this workflow. + +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. + +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + + +[API Spec](https://developer.sailpoint.com/docs/api/v1/test-workflow-v1) + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**id** | **string** | Id of the workflow | [default to undefined] +**testWorkflowV1RequestV1** | **TestWorkflowV1RequestV1** | | + +### Return type + +**TestWorkflowV1200ResponseV1** + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +### Example + +```typescript +import { WorkflowsV1Api } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new WorkflowsV1Api(configuration); +const id: string = c17bea3a-574d-453c-9e04-4365fbf5af0b; // Id of the workflow +const testWorkflowV1RequestV1: TestWorkflowV1RequestV1 = {"input":{"identity":{"id":"ee769173319b41d19ccec6cea52f237b","name":"john.doe","type":"IDENTITY"},"changes":[{"attribute":"department","oldValue":"sales","newValue":"marketing"},{"attribute":"manager","oldValue":{"id":"ee769173319b41d19ccec6c235423237b","name":"nice.guy","type":"IDENTITY"},"newValue":{"id":"ee769173319b41d19ccec6c235423236c","name":"mean.guy","type":"IDENTITY"}},{"attribute":"email","oldValue":"john.doe@hotmail.com","newValue":"john.doe@gmail.com"}]}}; // +const result = await apiInstance.testWorkflowV1(id, testWorkflowV1RequestV1); +console.log(result); +``` + +[[Back to top]](#) + diff --git a/sdk-output/workflows/docs/Models/ArrayInner.md b/sdk-output/workflows/docs/Models/ArrayInner.md new file mode 100644 index 00000000..813a8695 --- /dev/null +++ b/sdk-output/workflows/docs/Models/ArrayInner.md @@ -0,0 +1,18 @@ +--- +id: v1-array-inner-v1 +title: ArrayInnerV1 +pagination_label: ArrayInnerV1 +sidebar_label: ArrayInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ArrayInnerV1', 'v1ArrayInnerV1'] +slug: /tools/sdk/typescript/workflows/models/array-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ArrayInnerV1', 'v1ArrayInnerV1'] +--- + +# ArrayInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1200Response.md b/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1200Response.md new file mode 100644 index 00000000..56075446 --- /dev/null +++ b/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1200Response.md @@ -0,0 +1,20 @@ +--- +id: v1-create-external-execute-workflow-v1200-response-v1 +title: CreateExternalExecuteWorkflowV1200ResponseV1 +pagination_label: CreateExternalExecuteWorkflowV1200ResponseV1 +sidebar_label: CreateExternalExecuteWorkflowV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateExternalExecuteWorkflowV1200ResponseV1', 'v1CreateExternalExecuteWorkflowV1200ResponseV1'] +slug: /tools/sdk/typescript/workflows/models/create-external-execute-workflow-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowV1200ResponseV1', 'v1CreateExternalExecuteWorkflowV1200ResponseV1'] +--- + +# CreateExternalExecuteWorkflowV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflowExecutionId** | **(optional)** **string** | The workflow execution id | [default to undefined] +**message** | **(optional)** **string** | An error message if any errors occurred | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1Request.md b/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1Request.md new file mode 100644 index 00000000..579d0432 --- /dev/null +++ b/sdk-output/workflows/docs/Models/CreateExternalExecuteWorkflowV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-create-external-execute-workflow-v1-request-v1 +title: CreateExternalExecuteWorkflowV1RequestV1 +pagination_label: CreateExternalExecuteWorkflowV1RequestV1 +sidebar_label: CreateExternalExecuteWorkflowV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateExternalExecuteWorkflowV1RequestV1', 'v1CreateExternalExecuteWorkflowV1RequestV1'] +slug: /tools/sdk/typescript/workflows/models/create-external-execute-workflow-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowV1RequestV1', 'v1CreateExternalExecuteWorkflowV1RequestV1'] +--- + +# CreateExternalExecuteWorkflowV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **(optional)** **object** | The input for the workflow | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/CreateWorkflowV1Request.md b/sdk-output/workflows/docs/Models/CreateWorkflowV1Request.md new file mode 100644 index 00000000..26c5d19c --- /dev/null +++ b/sdk-output/workflows/docs/Models/CreateWorkflowV1Request.md @@ -0,0 +1,24 @@ +--- +id: v1-create-workflow-v1-request-v1 +title: CreateWorkflowV1RequestV1 +pagination_label: CreateWorkflowV1RequestV1 +sidebar_label: CreateWorkflowV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'CreateWorkflowV1RequestV1', 'v1CreateWorkflowV1RequestV1'] +slug: /tools/sdk/typescript/workflows/models/create-workflow-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowV1RequestV1', 'v1CreateWorkflowV1RequestV1'] +--- + +# CreateWorkflowV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **string** | The name of the workflow | [default to undefined] +**owner** | **(optional)** **WorkflowbodyOwnerV1** | | [default to undefined] +**description** | **(optional)** **string** | Description of what the workflow accomplishes | [default to undefined] +**definition** | **(optional)** **WorkflowdefinitionV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [default to false] +**trigger** | **(optional)** **WorkflowtriggerV1** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Errormessagedto.md b/sdk-output/workflows/docs/Models/Errormessagedto.md new file mode 100644 index 00000000..7235cad9 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Errormessagedto.md @@ -0,0 +1,21 @@ +--- +id: v1-errormessagedto-v1 +title: ErrormessagedtoV1 +pagination_label: ErrormessagedtoV1 +sidebar_label: ErrormessagedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +slug: /tools/sdk/typescript/workflows/models/errormessagedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrormessagedtoV1', 'v1ErrormessagedtoV1'] +--- + +# ErrormessagedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locale** | **(optional)** **string** | The locale for the message text, a BCP 47 language tag. | [default to undefined] +**localeOrigin** | **(optional)** **LocaleoriginV1** | | [default to undefined] +**text** | **(optional)** **string** | Actual text of the error message in the indicated locale. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Errorresponsedto.md b/sdk-output/workflows/docs/Models/Errorresponsedto.md new file mode 100644 index 00000000..6f057044 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Errorresponsedto.md @@ -0,0 +1,22 @@ +--- +id: v1-errorresponsedto-v1 +title: ErrorresponsedtoV1 +pagination_label: ErrorresponsedtoV1 +sidebar_label: ErrorresponsedtoV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +slug: /tools/sdk/typescript/workflows/models/errorresponsedto-v1 +tags: ['SDK', 'Software Development Kit', 'ErrorresponsedtoV1', 'v1ErrorresponsedtoV1'] +--- + +# ErrorresponsedtoV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**detailCode** | **(optional)** **string** | Fine-grained error code providing more detail of the error. | [default to undefined] +**trackingId** | **(optional)** **string** | Unique tracking id for the error. | [default to undefined] +**messages** | **(optional)** **Array<ErrormessagedtoV1>** | Generic localized reason for error | [default to undefined] +**causes** | **(optional)** **Array<ErrormessagedtoV1>** | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Index.md b/sdk-output/workflows/docs/Models/Index.md new file mode 100644 index 00000000..922c8bb9 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Index.md @@ -0,0 +1,19 @@ +--- +id: workflows-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: workflows-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', 'workflows', 'models'] +slug: /tools/sdk/typescript/workflows/models +tags: ['SDK', 'Software Development Kit', 'workflows', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-output/workflows/docs/Models/Jsonpatchoperation.md b/sdk-output/workflows/docs/Models/Jsonpatchoperation.md new file mode 100644 index 00000000..8084a0cc --- /dev/null +++ b/sdk-output/workflows/docs/Models/Jsonpatchoperation.md @@ -0,0 +1,21 @@ +--- +id: v1-jsonpatchoperation-v1 +title: JsonpatchoperationV1 +pagination_label: JsonpatchoperationV1 +sidebar_label: JsonpatchoperationV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +slug: /tools/sdk/typescript/workflows/models/jsonpatchoperation-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationV1', 'v1JsonpatchoperationV1'] +--- + +# JsonpatchoperationV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**op** | **string** | The operation to be performed | [default to undefined] +**path** | **string** | A string JSON Pointer representing the target path to an element to be affected by the operation | [default to undefined] +**value** | **(optional)** **JsonpatchoperationValueV1** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/JsonpatchoperationValue.md b/sdk-output/workflows/docs/Models/JsonpatchoperationValue.md new file mode 100644 index 00000000..2974de3d --- /dev/null +++ b/sdk-output/workflows/docs/Models/JsonpatchoperationValue.md @@ -0,0 +1,18 @@ +--- +id: v1-jsonpatchoperation-value-v1 +title: JsonpatchoperationValueV1 +pagination_label: JsonpatchoperationValueV1 +sidebar_label: JsonpatchoperationValueV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +slug: /tools/sdk/typescript/workflows/models/jsonpatchoperation-value-v1 +tags: ['SDK', 'Software Development Kit', 'JsonpatchoperationValueV1', 'v1JsonpatchoperationValueV1'] +--- + +# JsonpatchoperationValueV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/workflows/docs/Models/ListCompleteWorkflowLibraryV1200ResponseInner.md b/sdk-output/workflows/docs/Models/ListCompleteWorkflowLibraryV1200ResponseInner.md new file mode 100644 index 00000000..ead542d9 --- /dev/null +++ b/sdk-output/workflows/docs/Models/ListCompleteWorkflowLibraryV1200ResponseInner.md @@ -0,0 +1,31 @@ +--- +id: v1-list-complete-workflow-library-v1200-response-inner-v1 +title: ListCompleteWorkflowLibraryV1200ResponseInnerV1 +pagination_label: ListCompleteWorkflowLibraryV1200ResponseInnerV1 +sidebar_label: ListCompleteWorkflowLibraryV1200ResponseInnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListCompleteWorkflowLibraryV1200ResponseInnerV1', 'v1ListCompleteWorkflowLibraryV1200ResponseInnerV1'] +slug: /tools/sdk/typescript/workflows/models/list-complete-workflow-library-v1200-response-inner-v1 +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibraryV1200ResponseInnerV1', 'v1ListCompleteWorkflowLibraryV1200ResponseInnerV1'] +--- + +# ListCompleteWorkflowLibraryV1200ResponseInnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Operator ID. | [default to undefined] +**name** | **(optional)** **string** | Operator friendly name | [default to undefined] +**type** | **(optional)** **string** | Operator type | [default to undefined] +**description** | **(optional)** **string** | Description of the operator | [default to undefined] +**formFields** | **(optional)** **Array<WorkflowlibraryformfieldsV1>** | One or more inputs that the operator accepts | [default to undefined] +**exampleOutput** | **(optional)** **WorkflowlibraryactionExampleOutputV1** | | [default to undefined] +**deprecated** | **(optional)** **boolean** | | [default to undefined] +**deprecatedBy** | **(optional)** **string** | | [default to undefined] +**versionNumber** | **(optional)** **number** | Version number | [default to undefined] +**isSimulationEnabled** | **(optional)** **boolean** | | [default to undefined] +**isDynamicSchema** | **(optional)** **boolean** | Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [default to undefined] +**outputSchema** | **(optional)** **object** | Example output schema | [default to undefined] +**inputExample** | **(optional)** **object** | Example trigger payload if applicable | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/ListWorkflowsV1401Response.md b/sdk-output/workflows/docs/Models/ListWorkflowsV1401Response.md new file mode 100644 index 00000000..16818db5 --- /dev/null +++ b/sdk-output/workflows/docs/Models/ListWorkflowsV1401Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-workflows-v1401-response-v1 +title: ListWorkflowsV1401ResponseV1 +pagination_label: ListWorkflowsV1401ResponseV1 +sidebar_label: ListWorkflowsV1401ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkflowsV1401ResponseV1', 'v1ListWorkflowsV1401ResponseV1'] +slug: /tools/sdk/typescript/workflows/models/list-workflows-v1401-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkflowsV1401ResponseV1', 'v1ListWorkflowsV1401ResponseV1'] +--- + +# ListWorkflowsV1401ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/ListWorkflowsV1429Response.md b/sdk-output/workflows/docs/Models/ListWorkflowsV1429Response.md new file mode 100644 index 00000000..2b353e00 --- /dev/null +++ b/sdk-output/workflows/docs/Models/ListWorkflowsV1429Response.md @@ -0,0 +1,19 @@ +--- +id: v1-list-workflows-v1429-response-v1 +title: ListWorkflowsV1429ResponseV1 +pagination_label: ListWorkflowsV1429ResponseV1 +sidebar_label: ListWorkflowsV1429ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'ListWorkflowsV1429ResponseV1', 'v1ListWorkflowsV1429ResponseV1'] +slug: /tools/sdk/typescript/workflows/models/list-workflows-v1429-response-v1 +tags: ['SDK', 'Software Development Kit', 'ListWorkflowsV1429ResponseV1', 'v1ListWorkflowsV1429ResponseV1'] +--- + +# ListWorkflowsV1429ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**message** | **(optional)** **any** | A message describing the error | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Localeorigin.md b/sdk-output/workflows/docs/Models/Localeorigin.md new file mode 100644 index 00000000..e9ca049b --- /dev/null +++ b/sdk-output/workflows/docs/Models/Localeorigin.md @@ -0,0 +1,21 @@ +--- +id: v1-localeorigin-v1 +title: LocaleoriginV1 +pagination_label: LocaleoriginV1 +sidebar_label: LocaleoriginV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'LocaleoriginV1', 'v1LocaleoriginV1'] +slug: /tools/sdk/typescript/workflows/models/localeorigin-v1 +tags: ['SDK', 'Software Development Kit', 'LocaleoriginV1', 'v1LocaleoriginV1'] +--- + +# LocaleoriginV1 + +## Enum + + +* `Default` (value: `'DEFAULT'`) + +* `Request` (value: `'REQUEST'`) + + diff --git a/sdk-output/workflows/docs/Models/README.md b/sdk-output/workflows/docs/Models/README.md new file mode 100644 index 00000000..e26f6a53 --- /dev/null +++ b/sdk-output/workflows/docs/Models/README.md @@ -0,0 +1,46 @@ +## sailpoint-api-client@1.0.0 + +This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments: + +Environment +* Node.js +* Webpack +* Browserify + +Language level +* ES5 - you must have a Promises/A+ library installed +* ES6 + +Module system +* CommonJS +* ES6 module system + +It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) + +### Building + +To build and compile the typescript sources to javascript use: +``` +npm install +npm run build +``` + +### Publishing + +First build the package then run `npm publish` + +### Consuming + +navigate to the folder of your consuming project and run one of the following commands. + +_published:_ + +``` +npm install sailpoint-api-client@1.0.0 --save +``` + +_unPublished (not recommended):_ + +``` +npm install PATH_TO_GENERATED_PACKAGE --save +``` diff --git a/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1200Response.md b/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1200Response.md new file mode 100644 index 00000000..54061552 --- /dev/null +++ b/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-test-external-execute-workflow-v1200-response-v1 +title: TestExternalExecuteWorkflowV1200ResponseV1 +pagination_label: TestExternalExecuteWorkflowV1200ResponseV1 +sidebar_label: TestExternalExecuteWorkflowV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestExternalExecuteWorkflowV1200ResponseV1', 'v1TestExternalExecuteWorkflowV1200ResponseV1'] +slug: /tools/sdk/typescript/workflows/models/test-external-execute-workflow-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowV1200ResponseV1', 'v1TestExternalExecuteWorkflowV1200ResponseV1'] +--- + +# TestExternalExecuteWorkflowV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payload** | **(optional)** **object** | The input that was received | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1Request.md b/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1Request.md new file mode 100644 index 00000000..1925c276 --- /dev/null +++ b/sdk-output/workflows/docs/Models/TestExternalExecuteWorkflowV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-test-external-execute-workflow-v1-request-v1 +title: TestExternalExecuteWorkflowV1RequestV1 +pagination_label: TestExternalExecuteWorkflowV1RequestV1 +sidebar_label: TestExternalExecuteWorkflowV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestExternalExecuteWorkflowV1RequestV1', 'v1TestExternalExecuteWorkflowV1RequestV1'] +slug: /tools/sdk/typescript/workflows/models/test-external-execute-workflow-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowV1RequestV1', 'v1TestExternalExecuteWorkflowV1RequestV1'] +--- + +# TestExternalExecuteWorkflowV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **(optional)** **object** | The test input for the workflow | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/TestWorkflowV1200Response.md b/sdk-output/workflows/docs/Models/TestWorkflowV1200Response.md new file mode 100644 index 00000000..a6647c2a --- /dev/null +++ b/sdk-output/workflows/docs/Models/TestWorkflowV1200Response.md @@ -0,0 +1,19 @@ +--- +id: v1-test-workflow-v1200-response-v1 +title: TestWorkflowV1200ResponseV1 +pagination_label: TestWorkflowV1200ResponseV1 +sidebar_label: TestWorkflowV1200ResponseV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestWorkflowV1200ResponseV1', 'v1TestWorkflowV1200ResponseV1'] +slug: /tools/sdk/typescript/workflows/models/test-workflow-v1200-response-v1 +tags: ['SDK', 'Software Development Kit', 'TestWorkflowV1200ResponseV1', 'v1TestWorkflowV1200ResponseV1'] +--- + +# TestWorkflowV1200ResponseV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workflowExecutionId** | **(optional)** **string** | The workflow execution id | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/TestWorkflowV1Request.md b/sdk-output/workflows/docs/Models/TestWorkflowV1Request.md new file mode 100644 index 00000000..4543be98 --- /dev/null +++ b/sdk-output/workflows/docs/Models/TestWorkflowV1Request.md @@ -0,0 +1,19 @@ +--- +id: v1-test-workflow-v1-request-v1 +title: TestWorkflowV1RequestV1 +pagination_label: TestWorkflowV1RequestV1 +sidebar_label: TestWorkflowV1RequestV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'TestWorkflowV1RequestV1', 'v1TestWorkflowV1RequestV1'] +slug: /tools/sdk/typescript/workflows/models/test-workflow-v1-request-v1 +tags: ['SDK', 'Software Development Kit', 'TestWorkflowV1RequestV1', 'v1TestWorkflowV1RequestV1'] +--- + +# TestWorkflowV1RequestV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**input** | **object** | The test input for the workflow. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflow.md b/sdk-output/workflows/docs/Models/Workflow.md new file mode 100644 index 00000000..06e446f6 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflow.md @@ -0,0 +1,31 @@ +--- +id: v1-workflow-v1 +title: WorkflowV1 +pagination_label: WorkflowV1 +sidebar_label: WorkflowV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowV1', 'v1WorkflowV1'] +slug: /tools/sdk/typescript/workflows/models/workflow-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowV1', 'v1WorkflowV1'] +--- + +# WorkflowV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the workflow | [default to undefined] +**owner** | **(optional)** **WorkflowbodyOwnerV1** | | [default to undefined] +**description** | **(optional)** **string** | Description of what the workflow accomplishes | [default to undefined] +**definition** | **(optional)** **WorkflowdefinitionV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [default to false] +**trigger** | **(optional)** **WorkflowtriggerV1** | | [default to undefined] +**id** | **(optional)** **string** | Workflow ID. This is a UUID generated upon creation. | [default to undefined] +**executionCount** | **(optional)** **number** | The number of times this workflow has been executed. | [default to undefined] +**failureCount** | **(optional)** **number** | The number of times this workflow has failed during execution. | [default to undefined] +**created** | **(optional)** **string** | The date and time the workflow was created. | [default to undefined] +**modified** | **(optional)** **string** | The date and time the workflow was modified. | [default to undefined] +**modifiedBy** | **(optional)** **WorkflowmodifiedbyV1** | | [default to undefined] +**creator** | **(optional)** **WorkflowAllOfCreatorV1** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/WorkflowAllOfCreator.md b/sdk-output/workflows/docs/Models/WorkflowAllOfCreator.md new file mode 100644 index 00000000..f96990fe --- /dev/null +++ b/sdk-output/workflows/docs/Models/WorkflowAllOfCreator.md @@ -0,0 +1,21 @@ +--- +id: v1-workflow-all-of-creator-v1 +title: WorkflowAllOfCreatorV1 +pagination_label: WorkflowAllOfCreatorV1 +sidebar_label: WorkflowAllOfCreatorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowAllOfCreatorV1', 'v1WorkflowAllOfCreatorV1'] +slug: /tools/sdk/typescript/workflows/models/workflow-all-of-creator-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreatorV1', 'v1WorkflowAllOfCreatorV1'] +--- + +# WorkflowAllOfCreatorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | Workflow creator\'s DTO type. | [default to undefined] +**id** | **(optional)** **string** | Workflow creator\'s identity ID. | [default to undefined] +**name** | **(optional)** **string** | Workflow creator\'s display name. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowbody.md b/sdk-output/workflows/docs/Models/Workflowbody.md new file mode 100644 index 00000000..70ba069a --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowbody.md @@ -0,0 +1,24 @@ +--- +id: v1-workflowbody-v1 +title: WorkflowbodyV1 +pagination_label: WorkflowbodyV1 +sidebar_label: WorkflowbodyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowbodyV1', 'v1WorkflowbodyV1'] +slug: /tools/sdk/typescript/workflows/models/workflowbody-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowbodyV1', 'v1WorkflowbodyV1'] +--- + +# WorkflowbodyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **(optional)** **string** | The name of the workflow | [default to undefined] +**owner** | **(optional)** **WorkflowbodyOwnerV1** | | [default to undefined] +**description** | **(optional)** **string** | Description of what the workflow accomplishes | [default to undefined] +**definition** | **(optional)** **WorkflowdefinitionV1** | | [default to undefined] +**enabled** | **(optional)** **boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [default to false] +**trigger** | **(optional)** **WorkflowtriggerV1** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/WorkflowbodyOwner.md b/sdk-output/workflows/docs/Models/WorkflowbodyOwner.md new file mode 100644 index 00000000..aab0d14c --- /dev/null +++ b/sdk-output/workflows/docs/Models/WorkflowbodyOwner.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowbody-owner-v1 +title: WorkflowbodyOwnerV1 +pagination_label: WorkflowbodyOwnerV1 +sidebar_label: WorkflowbodyOwnerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowbodyOwnerV1', 'v1WorkflowbodyOwnerV1'] +slug: /tools/sdk/typescript/workflows/models/workflowbody-owner-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowbodyOwnerV1', 'v1WorkflowbodyOwnerV1'] +--- + +# WorkflowbodyOwnerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of object that is referenced | [default to undefined] +**id** | **(optional)** **string** | The unique ID of the object | [default to undefined] +**name** | **(optional)** **string** | The name of the object | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowdefinition.md b/sdk-output/workflows/docs/Models/Workflowdefinition.md new file mode 100644 index 00000000..123c1afc --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowdefinition.md @@ -0,0 +1,20 @@ +--- +id: v1-workflowdefinition-v1 +title: WorkflowdefinitionV1 +pagination_label: WorkflowdefinitionV1 +sidebar_label: WorkflowdefinitionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowdefinitionV1', 'v1WorkflowdefinitionV1'] +slug: /tools/sdk/typescript/workflows/models/workflowdefinition-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowdefinitionV1', 'v1WorkflowdefinitionV1'] +--- + +# WorkflowdefinitionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start** | **(optional)** **string** | The name of the starting step. | [default to undefined] +**steps** | **(optional)** | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowexecution.md b/sdk-output/workflows/docs/Models/Workflowexecution.md new file mode 100644 index 00000000..f2caa8aa --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowexecution.md @@ -0,0 +1,24 @@ +--- +id: v1-workflowexecution-v1 +title: WorkflowexecutionV1 +pagination_label: WorkflowexecutionV1 +sidebar_label: WorkflowexecutionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowexecutionV1', 'v1WorkflowexecutionV1'] +slug: /tools/sdk/typescript/workflows/models/workflowexecution-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowexecutionV1', 'v1WorkflowexecutionV1'] +--- + +# WorkflowexecutionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Workflow execution ID. | [default to undefined] +**workflowId** | **(optional)** **string** | Workflow ID. | [default to undefined] +**requestId** | **(optional)** **string** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [default to undefined] +**startTime** | **(optional)** **string** | Date/time when the workflow started. | [default to undefined] +**closeTime** | **(optional)** **string** | Date/time when the workflow ended. | [default to undefined] +**status** | **(optional)** **string** | Workflow execution status. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowexecutionevent.md b/sdk-output/workflows/docs/Models/Workflowexecutionevent.md new file mode 100644 index 00000000..9fde2cc1 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowexecutionevent.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowexecutionevent-v1 +title: WorkflowexecutioneventV1 +pagination_label: WorkflowexecutioneventV1 +sidebar_label: WorkflowexecutioneventV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowexecutioneventV1', 'v1WorkflowexecutioneventV1'] +slug: /tools/sdk/typescript/workflows/models/workflowexecutionevent-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowexecutioneventV1', 'v1WorkflowexecutioneventV1'] +--- + +# WorkflowexecutioneventV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | The type of event | [default to undefined] +**timestamp** | **(optional)** **string** | The date-time when the event occurred | [default to undefined] +**attributes** | **(optional)** **object** | Additional attributes associated with the event | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowexecutionhistory.md b/sdk-output/workflows/docs/Models/Workflowexecutionhistory.md new file mode 100644 index 00000000..79bcf2ba --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowexecutionhistory.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowexecutionhistory-v1 +title: WorkflowexecutionhistoryV1 +pagination_label: WorkflowexecutionhistoryV1 +sidebar_label: WorkflowexecutionhistoryV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowexecutionhistoryV1', 'v1WorkflowexecutionhistoryV1'] +slug: /tools/sdk/typescript/workflows/models/workflowexecutionhistory-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowexecutionhistoryV1', 'v1WorkflowexecutionhistoryV1'] +--- + +# WorkflowexecutionhistoryV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**definition** | **(optional)** **object** | | [default to undefined] +**history** | **(optional)** **object** | | [default to undefined] +**trigger** | **(optional)** **object** | | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowlibraryaction.md b/sdk-output/workflows/docs/Models/Workflowlibraryaction.md new file mode 100644 index 00000000..74adfefb --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowlibraryaction.md @@ -0,0 +1,30 @@ +--- +id: v1-workflowlibraryaction-v1 +title: WorkflowlibraryactionV1 +pagination_label: WorkflowlibraryactionV1 +sidebar_label: WorkflowlibraryactionV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowlibraryactionV1', 'v1WorkflowlibraryactionV1'] +slug: /tools/sdk/typescript/workflows/models/workflowlibraryaction-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowlibraryactionV1', 'v1WorkflowlibraryactionV1'] +--- + +# WorkflowlibraryactionV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Action ID. This is a static namespaced ID for the action | [default to undefined] +**name** | **(optional)** **string** | Action Name | [default to undefined] +**type** | **(optional)** **string** | Action type | [default to undefined] +**description** | **(optional)** **string** | Action Description | [default to undefined] +**formFields** | **(optional)** **Array<WorkflowlibraryformfieldsV1>** | One or more inputs that the action accepts | [default to undefined] +**exampleOutput** | **(optional)** **WorkflowlibraryactionExampleOutputV1** | | [default to undefined] +**deprecated** | **(optional)** **boolean** | | [default to undefined] +**deprecatedBy** | **(optional)** **string** | | [default to undefined] +**versionNumber** | **(optional)** **number** | Version number | [default to undefined] +**isSimulationEnabled** | **(optional)** **boolean** | | [default to undefined] +**isDynamicSchema** | **(optional)** **boolean** | Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [default to false] +**outputSchema** | **(optional)** **object** | Defines the output schema, if any, that this action produces. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/WorkflowlibraryactionExampleOutput.md b/sdk-output/workflows/docs/Models/WorkflowlibraryactionExampleOutput.md new file mode 100644 index 00000000..e6ff42a5 --- /dev/null +++ b/sdk-output/workflows/docs/Models/WorkflowlibraryactionExampleOutput.md @@ -0,0 +1,18 @@ +--- +id: v1-workflowlibraryaction-example-output-v1 +title: WorkflowlibraryactionExampleOutputV1 +pagination_label: WorkflowlibraryactionExampleOutputV1 +sidebar_label: WorkflowlibraryactionExampleOutputV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowlibraryactionExampleOutputV1', 'v1WorkflowlibraryactionExampleOutputV1'] +slug: /tools/sdk/typescript/workflows/models/workflowlibraryaction-example-output-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowlibraryactionExampleOutputV1', 'v1WorkflowlibraryactionExampleOutputV1'] +--- + +# WorkflowlibraryactionExampleOutputV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + diff --git a/sdk-output/workflows/docs/Models/Workflowlibraryformfields.md b/sdk-output/workflows/docs/Models/Workflowlibraryformfields.md new file mode 100644 index 00000000..4680c3d1 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowlibraryformfields.md @@ -0,0 +1,24 @@ +--- +id: v1-workflowlibraryformfields-v1 +title: WorkflowlibraryformfieldsV1 +pagination_label: WorkflowlibraryformfieldsV1 +sidebar_label: WorkflowlibraryformfieldsV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowlibraryformfieldsV1', 'v1WorkflowlibraryformfieldsV1'] +slug: /tools/sdk/typescript/workflows/models/workflowlibraryformfields-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowlibraryformfieldsV1', 'v1WorkflowlibraryformfieldsV1'] +--- + +# WorkflowlibraryformfieldsV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **(optional)** **string** | Description of the form field | [default to undefined] +**helpText** | **(optional)** **string** | Describes the form field in the UI | [default to undefined] +**label** | **(optional)** **string** | A human readable name for this form field in the UI | [default to undefined] +**name** | **(optional)** **string** | The name of the input attribute | [default to undefined] +**required** | **(optional)** **boolean** | Denotes if this field is a required attribute | [default to false] +**type** | **(optional)** **string** | The type of the form field | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowlibraryoperator.md b/sdk-output/workflows/docs/Models/Workflowlibraryoperator.md new file mode 100644 index 00000000..f670b2b6 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowlibraryoperator.md @@ -0,0 +1,27 @@ +--- +id: v1-workflowlibraryoperator-v1 +title: WorkflowlibraryoperatorV1 +pagination_label: WorkflowlibraryoperatorV1 +sidebar_label: WorkflowlibraryoperatorV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowlibraryoperatorV1', 'v1WorkflowlibraryoperatorV1'] +slug: /tools/sdk/typescript/workflows/models/workflowlibraryoperator-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowlibraryoperatorV1', 'v1WorkflowlibraryoperatorV1'] +--- + +# WorkflowlibraryoperatorV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Operator ID. | [default to undefined] +**name** | **(optional)** **string** | Operator friendly name | [default to undefined] +**type** | **(optional)** **string** | Operator type | [default to undefined] +**description** | **(optional)** **string** | Description of the operator | [default to undefined] +**isDynamicSchema** | **(optional)** **boolean** | Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [default to undefined] +**deprecated** | **(optional)** **boolean** | | [default to undefined] +**deprecatedBy** | **(optional)** **string** | | [default to undefined] +**isSimulationEnabled** | **(optional)** **boolean** | | [default to undefined] +**formFields** | **(optional)** **Array<WorkflowlibraryformfieldsV1>** | One or more inputs that the operator accepts | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowlibrarytrigger.md b/sdk-output/workflows/docs/Models/Workflowlibrarytrigger.md new file mode 100644 index 00000000..a08cd4c9 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowlibrarytrigger.md @@ -0,0 +1,29 @@ +--- +id: v1-workflowlibrarytrigger-v1 +title: WorkflowlibrarytriggerV1 +pagination_label: WorkflowlibrarytriggerV1 +sidebar_label: WorkflowlibrarytriggerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowlibrarytriggerV1', 'v1WorkflowlibrarytriggerV1'] +slug: /tools/sdk/typescript/workflows/models/workflowlibrarytrigger-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowlibrarytriggerV1', 'v1WorkflowlibrarytriggerV1'] +--- + +# WorkflowlibrarytriggerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | Trigger ID. This is a static namespaced ID for the trigger. | [default to undefined] +**type** | **(optional)** **string** | Trigger type | [default to undefined] +**deprecated** | **(optional)** **boolean** | Whether the trigger is deprecated. | [default to false] +**deprecatedBy** | **(optional)** **string** | Date the trigger was deprecated, if applicable. | [default to undefined] +**isSimulationEnabled** | **(optional)** **boolean** | Whether the trigger can be simulated. | [default to false] +**outputSchema** | **(optional)** **object** | Example output schema | [default to undefined] +**name** | **(optional)** **string** | Trigger Name | [default to undefined] +**description** | **(optional)** **string** | Trigger Description | [default to undefined] +**isDynamicSchema** | **(optional)** **boolean** | Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [default to false] +**inputExample** | **(optional)** **object** | Example trigger payload if applicable | [default to undefined] +**formFields** | **(optional)** **Array<WorkflowlibraryformfieldsV1>** | One or more inputs that the trigger accepts | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowmodifiedby.md b/sdk-output/workflows/docs/Models/Workflowmodifiedby.md new file mode 100644 index 00000000..527768c2 --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowmodifiedby.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowmodifiedby-v1 +title: WorkflowmodifiedbyV1 +pagination_label: WorkflowmodifiedbyV1 +sidebar_label: WorkflowmodifiedbyV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowmodifiedbyV1', 'v1WorkflowmodifiedbyV1'] +slug: /tools/sdk/typescript/workflows/models/workflowmodifiedby-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowmodifiedbyV1', 'v1WorkflowmodifiedbyV1'] +--- + +# WorkflowmodifiedbyV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **(optional)** **string** | | [default to undefined] +**id** | **(optional)** **string** | Identity ID | [default to undefined] +**name** | **(optional)** **string** | Human-readable display name of identity. | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowoauthclient.md b/sdk-output/workflows/docs/Models/Workflowoauthclient.md new file mode 100644 index 00000000..61d1af7e --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowoauthclient.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowoauthclient-v1 +title: WorkflowoauthclientV1 +pagination_label: WorkflowoauthclientV1 +sidebar_label: WorkflowoauthclientV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowoauthclientV1', 'v1WorkflowoauthclientV1'] +slug: /tools/sdk/typescript/workflows/models/workflowoauthclient-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowoauthclientV1', 'v1WorkflowoauthclientV1'] +--- + +# WorkflowoauthclientV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **(optional)** **string** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [default to undefined] +**secret** | **(optional)** **string** | OAuthClient secret. | [default to undefined] +**url** | **(optional)** **string** | URL for the external trigger to invoke | [default to undefined] + diff --git a/sdk-output/workflows/docs/Models/Workflowtrigger.md b/sdk-output/workflows/docs/Models/Workflowtrigger.md new file mode 100644 index 00000000..b021a87b --- /dev/null +++ b/sdk-output/workflows/docs/Models/Workflowtrigger.md @@ -0,0 +1,21 @@ +--- +id: v1-workflowtrigger-v1 +title: WorkflowtriggerV1 +pagination_label: WorkflowtriggerV1 +sidebar_label: WorkflowtriggerV1 +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', 'WorkflowtriggerV1', 'v1WorkflowtriggerV1'] +slug: /tools/sdk/typescript/workflows/models/workflowtrigger-v1 +tags: ['SDK', 'Software Development Kit', 'WorkflowtriggerV1', 'v1WorkflowtriggerV1'] +--- + +# WorkflowtriggerV1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | The trigger type | [default to undefined] +**displayName** | **(optional)** **string** | The trigger display name | [default to undefined] +**attributes** | **object** | Workflow Trigger Attributes. | [default to undefined] + diff --git a/sdk-resources/resources/api_doc.mustache b/sdk-resources/resources/api_doc.mustache new file mode 100644 index 00000000..e8ce5a26 --- /dev/null +++ b/sdk-resources/resources/api_doc.mustache @@ -0,0 +1,72 @@ +--- +id: {{#lambda.kebabcase}}{{#lambda.titlecase}}{{apiVersion}}-{{baseName}}{{/lambda.titlecase}}{{/lambda.kebabcase}} +title: {{#lambda.titlecase}}{{baseName}}{{/lambda.titlecase}} +pagination_label: {{baseName}} +sidebar_label: {{baseName}} +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', '{{baseName}}', '{{apiVersion}}{{baseName}}'] +slug: /tools/sdk/typescript/{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}/methods/{{#lambda.kebabcase}}{{#lambda.titlecase}}{{baseName}}{{/lambda.titlecase}}{{/lambda.kebabcase}} +tags: ['SDK', 'Software Development Kit', '{{baseName}}', '{{apiVersion}}{{baseName}}'] +--- + +# {{classname}} + {{#operations}}{{#operation}}{{#-first}}{{#tags}}{{description}} {{/tags}}{{/-first}}{{/operation}}{{/operations}} +All URIs are relative to *{{basePath}}* + +Method | HTTP request | Description +------------- | ------------- | ------------- +{{#operations}}{{#operation}}[**{{#lambda.kebabcase}}{{operationId}}{{/lambda.kebabcase}}**](#{{#lambda.kebabcase}}{{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}{{/lambda.kebabcase}}) | **{{httpMethod}}** `{{{path}}}` | {{summary}} +{{/operation}}{{/operations}} + +{{#operations}} +{{#operation}} +## {{#lambda.kebabcase}}{{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}{{/lambda.kebabcase}} +{{#isDeprecated}}:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +{{/isDeprecated}} +{{#headerParams}}:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +{{/headerParams}} +{{{summary}}} +{{#notes}}{{{unescapedNotes}}}{{/notes}} +{{{description}}} +[API Spec](https://developer.sailpoint.com/docs/api/{{apiVersion}}/{{#lambda.kebabcase}}{{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}{{/lambda.kebabcase}}) + +### Parameters + +{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} +Name | Type | Description | Notes +------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}} +**{{paramName}}** | {{#isContainer}}{{#isArray}}**Array<{{#items}}{{dataType}}{{/items}}>**{{/isArray}}{{/isContainer}}{{^isContainer}}**{{dataType}}**{{/isContainer}} | {{description}} | {{^required}}[optional]{{/required}}{{#defaultValue}} [default to {{.}}]{{/defaultValue}}{{/allParams}} + +### Return type + +{{#returnType}}**{{{returnType}}}**{{/returnType}}{{^returnType}}(empty response body){{/returnType}} + +### HTTP request headers + +- **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} +- **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} + +### Example + +```typescript +import { {{classname}} } from 'sailpoint-api-client'; +import { Configuration } from 'sailpoint-api-client'; +import { createConfiguration } from 'sailpoint-api-client'; + +const configuration = createConfiguration(); +const apiInstance = new {{classname}}(configuration); +{{#allParams}} +{{^isBodyParam}}const {{paramName}}: {{#isString}}string{{/isString}}{{^isString}}{{dataType}}{{/isString}} = {{{example}}}; // {{description}}{{^required}} (optional){{/required}}{{/isBodyParam}}{{#isBodyParam}}const {{paramName}}: {{dataType}} = {{#requestBodyExamples}}{{{example}}}{{/requestBodyExamples}}{{^requestBodyExamples}}{}{{/requestBodyExamples}}; // {{description}}{{^required}} (optional){{/required}}{{/isBodyParam}} +{{/allParams}} +const result = await apiInstance.{{nickname}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}); +console.log(result); +``` + +[[Back to top]](#) + +{{/operation}} +{{/operations}} diff --git a/sdk-resources/resources/developerSite_code_examples.mustache b/sdk-resources/resources/developerSite_code_examples.mustache new file mode 100644 index 00000000..0a111582 --- /dev/null +++ b/sdk-resources/resources/developerSite_code_examples.mustache @@ -0,0 +1,21 @@ +{{#operations}} +{{#operation}} +- path: {{path}} + method: {{httpMethod}} + xCodeSample: + - lang: TypeScript + label: SDK_tools/sdk/typescript/{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}/methods/{{#lambda.kebabcase}}{{#lambda.titlecase}}{{baseName}}{{/lambda.titlecase}}{{/lambda.kebabcase}}#{{#lambda.kebabcase}}{{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}{{/lambda.kebabcase}} + source: | + import { {{classname}} } from 'sailpoint-api-client'; + import { Configuration } from 'sailpoint-api-client'; + import { createConfiguration } from 'sailpoint-api-client'; + + const configuration = createConfiguration(); + const apiInstance = new {{classname}}(configuration); + {{#allParams}} + {{^isBodyParam}}const {{paramName}}: {{#isString}}string{{/isString}}{{^isString}}{{dataType}}{{/isString}} = {{#isString}}'{{/isString}}{{{example}}}{{#isString}}'{{/isString}}; // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/isBodyParam}}{{#isBodyParam}}const {{paramName}}: {{dataType}} = {{#requestBodyExamples}}{{{example}}}{{/requestBodyExamples}}{{^requestBodyExamples}}{}{{/requestBodyExamples}}; // {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{/isBodyParam}} + {{/allParams}} + const result = await apiInstance.{{nickname}}({{#requiredParams}}{{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}); + console.log(result); + {{/operation}} +{{/operations}} diff --git a/sdk-resources/resources/docs_methods_index.mustache b/sdk-resources/resources/docs_methods_index.mustache new file mode 100644 index 00000000..22aad531 --- /dev/null +++ b/sdk-resources/resources/docs_methods_index.mustache @@ -0,0 +1,30 @@ +--- +id: {{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}-methods +title: Methods +pagination_label: Methods +sidebar_label: Methods +sidebar_position: 3 +sidebar_key: {{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}-typescript-methods +sidebar_class_name: methods +keywords: ['typescript', 'TypeScript', 'sdk', '{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}', 'methods'] +slug: /tools/sdk/typescript/{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}/methods +tags: ['SDK', 'Software Development Kit', '{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}', 'methods'] +--- + +Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. +## Key Features +- Purpose & Overview: Explains the purpose of the method and its role in the API. +- Parameters: Describe the required input parameters, including their data types. +- Response Format: Details the expected return format or structure. +- Error Scenarios: Outline potential errors or issues that may arise during method execution. +- Example: Provides a sample of how the API uses the method. + +## Available Methods +This is a list of the core methods available in the TypeScript SDK for **{{#lambda.titlecase}}{{apiVersion}}{{/lambda.titlecase}}** endpoints: + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` diff --git a/sdk-resources/resources/docs_models_index.mustache b/sdk-resources/resources/docs_models_index.mustache new file mode 100644 index 00000000..6d03ba04 --- /dev/null +++ b/sdk-resources/resources/docs_models_index.mustache @@ -0,0 +1,19 @@ +--- +id: {{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}-models +title: Models +pagination_label: Models +sidebar_label: Models +sidebar_position: 4 +sidebar_key: {{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}-typescript-models +sidebar_class_name: models +keywords: ['typescript', 'TypeScript', 'sdk', '{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}', 'models'] +slug: /tools/sdk/typescript/{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}/models +tags: ['SDK', 'Software Development Kit', '{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}', 'models'] +--- + +The TypeScript SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. + +## Key Features +- Attributes: Describe each attribute, including its name, data type, and whether it's required. +- Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. +- Example: Provides a sample of how the API uses the model. diff --git a/sdk-resources/resources/model_doc.mustache b/sdk-resources/resources/model_doc.mustache new file mode 100644 index 00000000..652e66fb --- /dev/null +++ b/sdk-resources/resources/model_doc.mustache @@ -0,0 +1,29 @@ +--- +id: {{#lambda.kebabcase}}{{#lambda.titlecase}}{{apiVersion}}-{{classname}}{{/lambda.titlecase}}{{/lambda.kebabcase}} +title: {{#lambda.titlecase}}{{classname}}{{/lambda.titlecase}} +pagination_label: {{classname}} +sidebar_label: {{classname}} +sidebar_class_name: typescriptsdk +keywords: ['typescript', 'TypeScript', 'sdk', '{{classname}}', '{{apiVersion}}{{classname}}'] +slug: /tools/sdk/typescript/{{#lambda.lowercase}}{{packageName}}{{/lambda.lowercase}}/models/{{#lambda.kebabcase}}{{#lambda.titlecase}}{{classname}}{{/lambda.titlecase}}{{/lambda.kebabcase}} +tags: ['SDK', 'Software Development Kit', '{{classname}}', '{{apiVersion}}{{classname}}'] +--- + +{{#models}}{{#model}}# {{classname}} + +{{^isEnum}} +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +{{#vars}}**{{name}}** | {{^required}}**(optional)** {{/required}}{{#isContainer}}{{#isArray}}**Array<{{#items}}{{dataType}}{{/items}}>**{{/isArray}}{{/isContainer}}{{^isContainer}}**{{dataType}}**{{/isContainer}} | {{{description}}} | {{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}} +{{/vars}} +{{/isEnum}} +{{#isEnum}} +## Enum + +{{#allowableValues}}{{#enumVars}} +* `{{name}}` (value: `{{{value}}}`) +{{/enumVars}}{{/allowableValues}} +{{/isEnum}} +{{/model}}{{/models}}